Covid Service 1.0.0

Server

/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

Auth

Query String

user_code	string
trip_id	string

GET /news

xxxxxxxxxx
 
curl --get \ --url '/api/v1//news' \ --data user_code={user_code} \ --data trip_id={trip_id}
Copy

Responses

200

User news

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

Response

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

get user score

Auth

Query String

user_code	string
trip_id	string

GET /scores

xxxxxxxxxx
 
curl --get \ --url '/api/v1//scores' \ --data user_code={user_code} \ --data trip_id={trip_id}
Copy

Responses

200

User score available

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

425

User score not available yet

Response

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

get list of locations

Auth

Query String

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

GET /locations

xxxxxxxxxx
 
curl --get \ --url '/api/v1//locations' \ --data location_type={location_type} \ --data s={s}
Copy

Responses

200

List of locations

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

Response

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

add user

Auth

Request Body

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

POST /signup

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

Responses

204

User Signed up

No response body

400

Bad Request

Response

xxxxxxxxxx
 
No response
Copy

add user

Auth

Request Body

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

POST /validate

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

Responses

200

User Signed up

object	object
active	boolean
response	object
user_code	string

403

Bad Request

Response

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

support user optout

Auth

Request Body

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

POST /optout

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

Responses

204

User opted out

No response body

Response

xxxxxxxxxx
 
No response
Copy

get user trips

Auth

Query String

user_code	string
trip_id	string

GET /trips

xxxxxxxxxx
 
curl --get \ --url '/api/v1//trips' \ --data user_code={user_code} \ --data trip_id={trip_id}
Copy

Responses

200

user trips

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

Response

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

Auth

Request Body

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

POST /trips

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

Trips added to profile

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

Response

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