Covid Service1.0.0

Servers

Choose a server to use:

/api/v1/

https://covid-qa.adara.com/api/v1/

https://covid-prod.adara.com/api/v1/

https://virtserver.swaggerhub.com/adara/covid-service/1.0.0

SwaggerHub API Auto Mocking

get news articles

GET /news

Auth

Query String

user_code	string		required
trip_id	string		optional

Example Request

​x
 
curl --request GET \ --url /api/v1//news?user_code={user_code}&trip_id={trip_id}
Copy

Responses

200

object	object
active	boolean	optional
response	array[object]	optional
title	string	optional
link	string	optional
published	string	optional
description	string	optional
source	string	optional

Example Response

200 User news

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "title": "{string}",   "link": "{string}",   "published": "{string}",   "description": "{string}",   "source": "{string}"  } ]}
Copy

get user score

GET /scores

Auth

Query String

user_code	string		required
trip_id	string		required

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1//scores?user_code={user_code}&trip_id={trip_id}
Copy

Responses

200 425

object	object
active	boolean	optional
response	object	optional
raw_score	number	optional
score	number	optional
display_score	string	optional
description	string	optional
percentile	number	optional

Example Response

200 User score available

425 User score not available yet

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "raw_score": "{number}",  "score": "{number}",  "display_score": "{string}",  "description": "{string}",  "percentile": "{number}" }}
Copy

get list of locations

GET /locations

Auth

Query String

location_type	string	Enum: `airport`,`city`	required
s	string		required

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1//locations?location_type={location_type}&s={s}
Copy

Responses

200

object	object
active	boolean	optional
response	array[object]	optional
id	string	optional
name	string	optional
state	string	optional
city	string	optional
county	string	optional
country	string	optional

Example Response

200 List of locations

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "id": "{string}",   "name": "{string}",   "state": "{string}",   "city": "{string}",   "county": "{string}",   "country": "{string}"  } ]}
Copy

add user

POST /signup

Auth

Request Body

object	object		required
email	string	pattern: `^([\D-]+(\w))+((\.(\w)+)?)+@(\D)+(\w)((\.(\D)+(\w)*)+)?(\.)[a-z]{2,}$`	required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1//signup \ --data '{  "email": "{string}"}'
Copy

Responses

204 400

No response body

Example Response

204 User Signed up

400 Bad Request

xxxxxxxxxx
 
No response
Copy

add user

POST /validate

Auth

Request Body

object	object		required
email	string	pattern: `^([\D-]+(\w))+((\.(\w)+)?)+@(\D)+(\w)((\.(\D)+(\w)*)+)?(\.)[a-z]{2,}$`	required
passcode	string		required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1//validate \ --data '{  "email": "{string}",  "passcode": "{string}"}'
Copy

Responses

200 403

object	object
active	boolean	optional
response	object	optional
user_code	string	optional

Example Response

200 User Signed up

403 Bad Request

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "user_code": "{string}" }}
Copy

support user optout

POST /optout

Auth

Request Body

object	object
email	string	pattern: `^([\D-]+(\w))+((\.(\w)+)?)+@(\D)+(\w)((\.(\D)+(\w)*)+)?(\.)[a-z]{2,}$`	optional

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1//optout \ --data '{  "email": "{string}"}'
Copy

Responses

204

No response body

Example Response

204 User opted out

xxxxxxxxxx
 
No response
Copy

get user trips

GET /trips

Auth

Query String

user_code	string		required
trip_id	string		optional

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1//trips?user_code={user_code}&trip_id={trip_id}
Copy

Responses

200

object	object
active	boolean		optional
response	array[object]		optional
start	string	pattern: `^\d\d\d\d-\d\d-\d\d$`	required
end	string	pattern: `^\d\d\d\d-\d\d-\d\d$`	required
rideshare	boolean		required
purpose	string		required
airports	array[object]		required
city	string		optional
county	string		optional
state	string		optional
country	string		optional
code	string		required
name	string		optional
prospective	boolean		optional
home	object		optional
city	string		required
county	string		optional
state	string		optional
country	string		required
id	string		required
cities	array[object]		required
city	string		required
county	string		optional
state	string		optional
country	string		required
id	string		required

Example Response

200 user trips

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "start": "{string}",   "end": "{string}",   "rideshare": "{boolean}",   "purpose": "{string}",   "airports": [    {     "city": "{string}",     "county": "{string}",     "state": "{string}",     "country": "{string}",     "code": "{string}",     "name": "{string}"    }   ],   "prospective": "{boolean}",   "home": {    "city": "{string}",    "county": "{string}",    "state": "{string}",    "country": "{string}",    "id": "{string}"   },   "cities": [    {     "city": "{string}",     "county": "{string}",     "state": "{string}",     "country": "{string}",     "id": "{string}"    }   ]  } ]}
Copy

send trip list and get user scores

POST /trips

Auth

Request Body

object	object		required
user_code	string		required
trips	array[object]		required
start	string	pattern: `^\d\d\d\d-\d\d-\d\d$`	required
end	string	pattern: `^\d\d\d\d-\d\d-\d\d$`	required
rideshare	boolean		required
purpose	string		required
airports	array[object]		required
city	string		optional
county	string		optional
state	string		optional
country	string		optional
code	string		required
name	string		optional
prospective	boolean		optional
home	object		optional
city	string		required
county	string		optional
state	string		optional
country	string		required
id	string		required
cities	array[object]		required
city	string		required
county	string		optional
state	string		optional
country	string		required
id	string		required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1//trips \ --data '{  "user_code": "{string}",  "trips": [    {      "start": "{string}",      "end": "{string}",      "rideshare": "{boolean}",      "purpose": "{string}",      "airports": [        {          "city": "{string}",          "county": "{string}",          "state": "{string}",          "country": "{string}",          "code": "{string}",          "name": "{string}"        }      ],      "prospective": "{boolean}",      "home": {        "city": "{string}",        "county": "{string}",        "state": "{string}",        "country": "{string}",        "id": "{string}"      },      "cities": [        {          "city": "{string}",          "county": "{string}",          "state": "{string}",          "country": "{string}",          "id": "{string}"        }      ]    }  ]}'
Copy

Responses

200

object	object
active	boolean		optional
response	array		optional
start	string	pattern: `^\d\d\d\d-\d\d-\d\d$`	required
end	string	pattern: `^\d\d\d\d-\d\d-\d\d$`	required
rideshare	boolean		required
purpose	string		required
airports	array[object]		required
city	string		optional
county	string		optional
state	string		optional
country	string		optional
code	string		required
name	string		optional
prospective	boolean		optional
home	object		optional
city	string		required
county	string		optional
state	string		optional
country	string		required
id	string		required
cities	array[object]		required
city	string		required
county	string		optional
state	string		optional
country	string		required
id	string		required
id	string		required

Example Response

200 Trips added to profile

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "start": "{string}",   "end": "{string}",   "rideshare": "{boolean}",   "purpose": "{string}",   "airports": [    {     "city": "{string}",     "county": "{string}",     "state": "{string}",     "country": "{string}",     "code": "{string}",     "name": "{string}"    }   ],   "prospective": "{boolean}",   "home": {    "city": "{string}",    "county": "{string}",    "state": "{string}",    "country": "{string}",    "id": "{string}"   },   "cities": [    {     "city": "{string}",     "county": "{string}",     "state": "{string}",     "country": "{string}",     "id": "{string}"    }   ],   "id": "{string}"  } ]}
Copy