Skip to main content
Documentation Powered by ReDoc

Sitata API# (2)

Welcome to the Sitata API docs. Please refer to our guides for detailed instructions on how to use the API, including instructions for authentication.

Authentication

token

Security Scheme Type API Key
Header parameter name: Authorization

Advisories

Advisories are events that are affecting a country or travellers over a long period of time (e.g. months).

Advisory Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
headline String The headline of the advisory
body String The body of the advisory in markdown format
status Integer The status of the advisory (see below)
country_ids [String] A list of Country ids that the advisory is associated with
countries [Country] A list of Countrys that the advisory is assocaited with
country_region_ids [String] A list of CountryRegion ids that the advisory is associated with
country_regions [CountryRegion] A list of CountryRegions that the advisory is assocaited with
country_division_ids [String] A list of CountryDivision ids that the advisory is associated with
country_divisions [CountryDivision] A list of CountryDivisions that the advisory is assocaited with

Advisory status

Value Description
0 Open
1 Closed

Get Advisories For Country

Returns open advisories for a given country.

Request Parameters

Name Type Description
countrt_id_or_code String The two character country code or id of the country to request advisories for. e.g. "CA" for Canada.
path Parameters
country_id_or_code
required
string
Example: BR
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get Advisories For Trip

Returns open advisories for the trip based on the trip's destination list.

Request Parameters

Name Type Description
trip_id String The id of the trip to request advisories for
path Parameters
trip_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Airlines

This endpoint contains data about Airlines.

Airline Attributes

Name Type Description
id String The id of the airline
created_at String The time the record was created
updated_at String The time the record was updated
name String The name of the airline
iata String IATA identifier
icao String ICAO identifier
health_mask_req Integer Specifies if a mask is required for health reasons
health_temp_check Integer Specifies if a temperature check is required for health reasons
health_measures String A textual description of health precautionary measures taken by the Airline in markdown format
health_url String Reference to dedicated health page on Airline's domain

Health Values

Value Description
-1 Unknown
0 No
1 Yes

Get Airlines

Returns a paginated list of airlines. Query parameters are combined with a logical AND condition.

query Parameters
like
string
Example: like=can

Fuzzy match on name, iata, or icao fields

iata
string
Example: iata=AC

Exact match on iata code

icao
string
Example: icao=AC

Exact match on icao code

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Airports

This endpoint contains data about Airports.

Airport Attributes

Name Type Description
id String The id of the airport
created_at String The time the record was created
updated_at String The time the record was updated
name String The name of the airport
iata String IATA identifier
icao String ICAO identifier
faa String FAA identifier
health_mask_req Integer Specifies if a mask is required for health reasons
health_temp_check Integer Specifies if a temperature check is required for health reasons
health_distancing Integer Specifies if social distancing measures are in place
health_measures String A textual description of health precautionary measures taken by the Airport in markdown format
health_url String Reference to dedicated health page on Airport's domain

Health Values

Value Description
-1 Unknown
0 No
1 Yes

Get Airports

Returns a paginated list of airports. Query parameters are combined with a logical AND condition.

query Parameters
like
string
Example: like=LE

Fuzzy match on name, iata, faa, or icao fields

iata
string

Exact match on iata code

icao
string

Exact match on icao code

faa
string

Exact match on faa code

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Alerts

Alerts are events that are affecting a country or travellers.

Alert Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
headline String The headline of the alert
body String The body of the alert in markdown format
body_advice String Advice for the traveller in markdown format
status Integer The status of the alert (see below)
origin_alert_id String The UUID of the original alert that this alert is related to
full_country_ids [String] A list of country ids if the alert is for the entire country
category Integer The category of the alert (see below)
risk_level Integer The risk level of the alert (see below)
status Integer The status level of the alert (see below)
update_reason String A reason for why the alert was updated
start Datetime The start time of the duration that the alert is applicable for
finish Datetime The finish time of the duration that the alert is applicable for
safety_category_ids [String] A list of safety category ids that the alert is associated to
disease_id String The id of the Disease that the alert is associated to
sources [AlertSource] A list of AlertSources that the alert has (see below)
locations [Location] A list of Locations that the alert has (see below)
airlines [Airline] A list of Airlines that the alert has (see below)
airports [Airport] A list of Airports that the alert has (see below)
country_ids [String] A list of Country ids that the alert is associated with
countries [Country] A list of Countrys that the alert is assocaited with
country_region_ids [String] A list of CountryRegion ids that the alert is associated with
country_regions [CountryRegion] A list of CountryRegions that the alert is assocaited with
country_division_ids [String] A list of CountryDivision ids that the alert is associated with
country_divisions [CountryDivision] A list of CountryDivisions that the alert is assocaited with

Alert Categories

Value Description
0 Health
1 Safety

Alert Risk Levels

Value Description
0 Low
1 Medium
2 High

Alert Status

Value Description
0 Review
1 Historical
2 Published

AlertSource

Keeps a reference to where information about the alert came from.

AlertSource Attributes

Name Type Description
id String The id of the AlertSource
url String The url of the source

Location

Keeps a reference to exact locations that the Alert is associated to.

Location Attributes

Name Type Description
id String The id of the AlertSource
lat Double The latitude of the alert source
lng Double The longitude of the alert source

Airline

Airlines that the alert is associated with.

Airline Attributes

Name Type Description
id String The id of the Airline
name String Name of the Airline
iata String IATA code for the Airline
icao String ICAO code for the Airline

Airport

Airports that the alert is associated with

Airport Attributes

Name Type Description
id String The id of the Airport
name String The name of the Airport
iata String IATA code for the Airport
icao String ICAO code for the Airport
faa string FAA code for the Airport
lat Double Latitude of the Airport
lng Double Longitude of the Airport

Get Alerts For Country

Returns alerts for the past month for a given country.

Request Parameters

Name Type Description
countrt_id_or_code String The two character country code or id of the country to request alerts for. e.g. "CA" for Canada.
path Parameters
country_id_or_code
required
string
Example: BR

Country code or identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept-Language
string
Example: en

Responses

Response samples

Content type
application/json
[]

Get Alerts For Trip

Returns a list of alerts for a trip based on the trip's destination list starting 30 days prior to the trip's start date. If the trip has a finish date, this endpoint will only return alerts up until the finish date.

Request Parameters

Name Type Description
trip_id String The id of the trip to request alerts for
path Parameters
trip_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Get Alerts

Returns alerts created in the past 30 days. If your organization has our "global intelligence" module activated, you will be able to retrieve historical alerts with additional filtering capabilities.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Get Alert

Returns an alert.

path Parameters
alert_id
required
string
Example: a70da84c-ae2b-4580-8695-6fa079f74fc3

The id of the alert

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept-Language
string
Example: ru

Responses

Response samples

Content type
application/json
{
  • "airlines": [ ],
  • "airports": [ ],
  • "body": "The cyclones that affected north Queensland created additional breeding places for mosquitos that harbor the Dengue virus. As a result, officials have recorded a doubling of cases of Dengue fever with a total of 15 identified cases in East Innisfail. Eight cases have been hospitalized. Officials are warning that the infection might spread.\n\nTravellers to this area should be aware of the risk of exposure to Dengue fever. Please refer to the GHNN Diseases Health Library for more information on exposure to and prevention of Dengue fever.\n",
  • "body_advice": null,
  • "category": 0,
  • "countries": [],
  • "country_division_ids": [ ],
  • "country_divisions": [ ],
  • "country_ids": [
    ],
  • "country_region_ids": [ ],
  • "country_regions": [ ],
  • "created_at": "2011-02-11T09:05:24Z",
  • "disease_id": "7c89e02f-7df5-4e12-bd51-25980750511e",
  • "finish": null,
  • "full_country_ids": [ ],
  • "headline": "Dengue fever spreads in north Queensland",
  • "id": "a70da84c-ae2b-4580-8695-6fa079f74fc3",
  • "locations": [
    ],
  • "origin_alert_id": null,
  • "risk_level": 1,
  • "safety_category_ids": [ ],
  • "sources": [],
  • "start": null,
  • "status": 2,
  • "update_reason": null,
  • "updated_at": "2011-02-11T09:05:24Z"
}

For Flights

Query for alerts that might affect flights or airports. The following rules apply:

  1. If the alert is for an airline in a particular country, it will have associated airline(s) and all airports within that country.
  2. If the alert is for an airline globally, it will only have associated airline(s).
  3. If the alert is for an airline at an airport, it will have associated airline for that airport.
  4. If the alert if for all airlines in a country, it will have associated airport(s) for that country, but no associated airlines.
  5. If the alert is for all airlines at a given airport(s), it will have associated airport(s) but no associated airlines.

Sitata has found that using ICAO codes is the most dependable, followed by IATA codes for querying by airports. However, using ICAO codes to query by airline is recommended.

Parameters

Name Type Description
flights [Flight] An array of flight objects

Flight Object Attributes

Name Type Description
flight_code String The code for the flight segment
departure_airport_code String ICAO or IATA code for the departure airport
arrival_airport_code String ICAO or IATA code for the arrival airport
carrier_code String ICAO or IATA code for the carrier (airline)
scheduled_gate_arrival Integer Scheduled gate arrival time in unix seconds
scheduled_gate_departure Integer Scheduled gate departure time in seconds

At the present time, only one or more of departure_airport_code, arrival_airport_code, or carrier_code is required.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "flights": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Alert Filters

Alert filters allow a user to stop notifications for Alerts and Advisories based on risk level and category.

Alert Filter Attributes

Name Type Description
id String The id of the AlertFilter
created_at String The time the record was created
updated_at String The time the record was updated
risk_levels [Integer] A list of risk levels that apply for the filter.
safety_category_id String The ID of the Safety Category that applies for the filter.

Get Alert Filters For A User

Returns alert filters for a user. Alert filters block distribution of Alerts and Advisories a user.

path Parameters
user_id
required
string
Example: {{user_id}}
header Parameters
Authorization
string
Example: {{user_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Alert Filter For A User

Create an Alert Filter for a user.

path Parameters
user_id
required
string
Example: {{user_id}}
header Parameters
Authorization
string
Example: {{user_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "alert_filter": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "2016-06-21T12:39:24Z",
  • "updated_at": "2016-06-21T12:39:24Z",
  • "id": "6747af61-f379-466c-869e-367e060babbe",
  • "risk_levels": [
    ],
  • "safety_category_id": "4832af61-a379-466c-869e-372e060bafef"
}

Update Alert Filter for a User

Update an Alert Filter for a user.

path Parameters
user_id
required
string
Example: {{user_id}}
id
required
string
Example: {{alert_filter_id}}
header Parameters
Authorization
string
Example: {{user_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "alert_filter": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "2016-06-21T12:39:24Z",
  • "updated_at": "2016-06-21T12:39:24Z",
  • "id": "6747af61-f379-466c-869e-367e060babbe",
  • "risk_levels": [
    ],
  • "safety_category_id": "4832af61-a379-466c-869e-372e060bafef"
}

Delete Alert Filter For a User

Delete an Alert Filter for a user.

path Parameters
user_id
required
string
Example: {{user_id}}
id
required
string
Example: {{alert_filter_id}}
header Parameters
Authorization
string
Example: {{user_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

Appointments

Appointments are created between a traveller and a responder (doctor). The doctor first proposes a time, appointment type, and cost by creating an AvailabilityBid. Upon acceptance of a bid by a traveller, an appointment is created. Appointments have their own conversation created so the doctor and traveller can have a private chat or video conversation.

An appointment is a slot in time with the intent that an Issue will be resolved, on the condition that an AvailabilityBid is accepted.

Appointment Attributes

Name Type Description
id String UUID of the appointment
created_at Datetime The datetime the appointment was created
updated_at Datetime The time the appointment was last updated
address_str String The address string of the proposed appointment
availability_bid AvailabilityBid The bid that the appointment belongs to
cancelled_by_id String UUID of the user that cancelled the bid
closed_at Datetime The time the appointment was closed
cost Integer The cost of the appointment in cents
issue Issue The issue that the appointment was created for
lat Double The latitude of the appointment
lng Double The longitude of the appointment
patient User The user that created the issue leading to this appointment
responder User The user (doctor) that created the bid that led to this appointment
start_time Datetime The time that the appointment is supposed to start
timezone String The IANA timezone identifier for the appointment start_time
status Integer The status of the appointment (see below)
type Integer The type of appointment (see below)

Appointment Status

Value Description
0 Open
1 Closed
2 Cancelled
3 Finished

Appointment Types

Value Description
0 Clinic
1 Housecall
2 Telemedicine

Get Appointments For Issue

Returns appointments for an issue.

Request Parameters

Name Type Description
issue_id String The id of the issue to request appointments for
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Get Appointments

Returns Appointments for user

Request Parameters

Name Type Description
all String When false, only returns appointments which are not cancelled nor finished. When true, returns all appointments regardless of status.
query Parameters
all
boolean
Example: all=false

When false, only returns appointments which are not cancelled nor finished. When true or omitted, returns all appointments regardless of status.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Appointment

Get an Appointment

Request Parameters

Name Type Description
appointment_id String The id of the appointment
path Parameters
id
required
string
Example: dfd34433-e722-4286-8c13-c434fa6e0dee

Appointment identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "address_str": "41 Luke Street, London, UK",
  • "availability_bid": {
    },
  • "cancelled_by_id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "closed_at": "2019-04-18T19:01:36Z",
  • "cost": 5000,
  • "created_at": "2019-02-27T15:40:06Z",
  • "fee": 1000,
  • "id": "a7fafb2a-13e1-457e-bba5-34b68298a02c",
  • "issue": {
    },
  • "lat": 51.5238897,
  • "lng": -0.0839055000000144,
  • "patient": {},
  • "pin_code": 544902,
  • "responder": {
    },
  • "start_time": "2019-07-24T20:20:46Z",
  • "status": 2,
  • "timezone": "America/Toronto",
  • "type": 0,
  • "updated_at": "2019-07-24T20:20:46Z",
  • "videos": [ ]
}

Close Appointment

Closes an Appointment

Request Parameters

Name Type Description
appointment_id String The id of the appointment
pin_code Integer The appointment's pin code
path Parameters
appointment_id
required
string
query Parameters
pin_code
integer
Example: pin_code=544902
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{
  • "address_str": "41 Luke Street, London, UK",
  • "availability_bid": {
    },
  • "cancelled_by_id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "closed_at": "2019-11-04T18:51:19Z",
  • "cost": 5000,
  • "created_at": "2019-02-27T15:40:06Z",
  • "fee": 1000,
  • "id": "a7fafb2a-13e1-457e-bba5-34b68298a02c",
  • "issue": {
    },
  • "lat": 51.5238897,
  • "lng": -0.0839055000000144,
  • "patient": {},
  • "pin_code": 544902,
  • "responder": {
    },
  • "start_time": "2019-07-24T20:20:46Z",
  • "status": 1,
  • "timezone": "America/Toronto",
  • "type": 0,
  • "updated_at": "2019-11-04T18:51:19Z",
  • "videos": [ ]
}

Cancel Appointment

Cancels an Appointment

Request Parameters

Name Type Description
appointment_id String The id of the appointment
path Parameters
appointment_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Availability Bids

Availability bids are created by responders (doctors) when a user has requested a Medical Self Help type of issue. Responders can create a bid to propose a time, appointment type (housecall, clinic visit, or telemedicine), and costs. The user is then free to accept one or multiple bids from the doctors.

When the traveller accepts a bid, they must state which type of appointment they would like to have (if the bid was for multiple types) and at that point in time, we pre-charge the user's credit card for payment. If the payment pre-charge is successful, we create an Appointment for the user and the doctor.

Availability Bid Attributes

Name Type Description
id String UUID of the issue
created_at Datetime The datetime the issue was created
updated_at Datetime The time the issue was last updated
accepted_at Datetime The time the bid was accepted by the traveller
cancelled_on Datetime The time the bid was cancelled by the traveller or responder
time Datetime The time of the proposed bid/appointment
timezone String The IANA timezone identifier - helps to display local time in emails and other mediums
issue_id String The UUID of the issue that the bid corresponds to
responder [User] The responder that has proposed the bid
appointment_types [Integer] A list of appointment types. Refer to appointment.
address_str String The address string of the proposed appointment
lat Double The latitude of the proposed bid/appointment
lng Double The longitude of the proposed bid/appointment
clinic_appt_cost Integer The amount of a clinic appointment in cents
housecall_cost Integer The amount of a housecall appointment in cents
telemed_consult_cost Integer The amount of telemedicine appointment in cents
appointments [Appointment] Appointments that were created as a result of this bid

Get Availability Bids For Issue

Returns availability bids for a particular issue.

Request Parameters

Name Type Description
issue_id String UUID of the issue to list bids for
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Create Availability Bid For Issue

Create availability bid for an issue

Request Parameters

Name Type Description
issue_id String The id of the issue to create an availability bid for

Availability Bid Object Attributes

Name Type Description
time Datetime The proposed time for which the appointment will take place
address_str String The proposed address for where the appointment may take place
appointment_types Array An array of Integers specifying which types of appointments the practitioner is available to perform. (Available types can be found on the Appointment Model)
timezone String The timezone of the availability bids origin
clinic_appt_cost Integer Proposed cost to perform a clinic appointment
housecall_cost Integer Proposed cost to perform a housecall
telemed_consult_cost Integer Proposed cost to perform a telemedicine consultation
location Object Precise location detailing where the appointment may take place
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "availability_bid": {
    }
}

Response samples

Content type
application/json
{
  • "updated_at": "2018-09-23T02:58:56.513295Z",
  • "timezone": "America/Toronto",
  • "time": "2018-09-23T20:41:11.429609Z",
  • "telemed_consult_cost": 0,
  • "responder": {},
  • "lng": 38.89,
  • "lat": 28.38,
  • "issue_id": "0d3921fc-baa4-4c98-aac1-6f4d04998b11",
  • "id": "6ed6ac08-3130-4631-b6b5-7b8c9830c106",
  • "housecall_cost": 0,
  • "created_at": "2018-09-23T02:58:56.513256Z",
  • "clinic_appt_cost": 5000,
  • "appointment_types": [
    ],
  • "appointment": { },
  • "address_str": "abc123",
  • "accepted_at": null
}

Accept

Accepts an availability bid for the current user. When a bid is created, the responder might have proposed several appointment types with different costs. Therefore, the appointment_type must be specified when accepting the bid.

Request Parameters

Name Type Description
bid_id String UUID of the bid to be accepted

Body Parameters

Name Type Description
appointment_type Integer The AppointmentType that the user is requesting from the bid that they're accepting.
path Parameters
bid_id
required
string
Example: 733c81af-ecff-4586-94c0-f76a4a418ee8
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "appointment_type": 0
}

Response samples

Content type
application/json
{
  • "updated_at": "2018-09-23T03:45:29.375721Z",
  • "timezone": "America/Toronto",
  • "time": "2018-09-23T20:41:11.429609Z",
  • "telemed_consult_cost": 4400,
  • "responder": {},
  • "lng": -80.49785939999998,
  • "lat": 43.4511316,
  • "issue_id": "0d3921fc-baa4-4c98-aac1-6f4d04998b11",
  • "id": "617d0a77-7b86-4d1e-9269-783bacd89355",
  • "housecall_cost": 15000,
  • "created_at": "2018-09-23T03:29:52.756599Z",
  • "clinic_appt_cost": 10000,
  • "appointment_types": [
    ],
  • "appointment": {
    },
  • "address_str": "121 Charles Street West, Kitchener, ON, Canada",
  • "accepted_at": "2018-09-23T03:45:29.375393Z"
}

Cancel Availability Bid

Cancels an Availability Bid given its id.

Request Parameters

Name Type Description
availability_bid_id String The id of the availability bid to cancel
path Parameters
availability_bid_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Request samples

Content type
application/json
""

Beneficiary

A beneficiary is someone other that the User associated with a Subscription who may benefit from certain coverages and services of the Products within the Subscription, but otherwise does not have a User account at Sitata. When creating Subscriptions, only create Users for those who wish to log into Sitata and receive communications from Sitata. Therefore, most insurance-related purchases only create a single Subscription with a single user and all other people are listed as Beneficiaries.

Beneficiary Attributes

Name Type Description
id String The id of the user
created_at String The time the record was created
updated_at String The time the record was updated
email String The email of the beneficiary
first_name String The first name of the beneficiary
last_name String The last name of the beneficiary
phone_number String The phone number of the beneficiary
birthday String The birthday of the beneficiary. Use ISO 8601 format. i.e. YYYY-MM-DD
relation Integer The relation of the beneficiary to the User purchasing a Subscription. See below.

Beneficiary Relation Types

Value Description
0 Spouse
1 Child

CheckIns

A checkin allows a user to disclose their position. When it is created for a specific CheckInRequest (Safety Request), then it allows the user to tell their organization either they are safe or that they require assistance.

Check In Attributes

Name Type Description
id String The id of the checkin
created_at String The time the record was created
updated_at String The time the record was updated
checkin_at Datetime The time the checkin occurred on the mobile device
lat Double The latitude when the checkin was created
lng Double The longitude when the checkin was created
type Integer The type of checkin (see below)
accuracy Integer The accuracy of the checkin (see below)
country_code String The two character country code of where the checkin was created. e.g. CA for Canada
anonymized Boolean True if the checkin location has been anonymized by skewing the lat/lng
ip_address String The ip address of where the checkin occurred
user_id String The id of the user that the checkin belongs to
status Integer The status of the checkin (see below)
device_token String The push notification token of the device that is creating the checkin. Required!

Types

Value Description
0 Mobile
1 SMS
2 Web
3 Email

Accuracies

Value Description
0 fine (less than 100m accuracy)
1 coarse (more than or equal to 100m accuracy)
2 geocoded (lat/lng determined from ip address)
3 country_wide
99 unknown

Status

These values are used primarily when the user has manually checked in. If the checkin is automatic, the value should be set to Unreported.

Value Description
0 Unreported
1 Safe
2 Help

Create CheckIn

Create a checkin for a user.

Body Parameters

The request must be wrapped in a key named check_in.

Name Type Description
latitude Double The latitude of the checkin
longitude Double The longitude of the checkin
accuracy Integer The accuracy of the checkin
type Integer The type of checkin
status Integer The status for the checkin
country_code String The two character country code for the checkin. e.g. CA for Canada
device_token String Push notification token for the mobile device
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "check_in": {
    }
}

Response samples

Content type
application/json
{
  • "user_id": "daba4d40-c2e1-42d2-b1c5-22337f5dd4c7",
  • "updated_at": "2019-01-20T02:32:23.064134Z",
  • "type": 0,
  • "status": 0,
  • "lng": -46.6346,
  • "lat": -23.53364,
  • "ip_address": "130.211.47.165",
  • "id": "13d8db8c-3ff0-46e3-93f8-bcd921102953",
  • "device_token": null,
  • "created_at": "2019-01-20T02:32:23.064116Z",
  • "country_code": null,
  • "checkin_at": "2019-01-20T02:32:23.060115Z",
  • "anonymized": false,
  • "accuracy": 0
}

Create CheckIn For Check In Request

Create a checkin for a user under a specific check in request.

Request Parameters

Name Type Description
check_in_request_id String The id of the CheckInRequest that this CheckIn should belong to.

Body Parameters

The request must be wrapped in a key named check_in.

Name Type Description
latitude Double The latitude of the checkin
longitude Double The longitude of the checkin
accuracy Integer The accuracy of the checkin
type Integer The type of checkin
status Integer The status for the checkin
country_code String The two character country code for the checkin. e.g. CA for Canada
path Parameters
check_in_request_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "check_in": {
    }
}

Response samples

Content type
application/json
{
  • "user_id": "9b8ea7df-b4a6-4af6-a4f1-484c123992c9",
  • "updated_at": "2018-08-23T15:06:33.190446Z",
  • "type": 0,
  • "status": 2,
  • "lng": "-46.6346",
  • "lat": "-23.53364",
  • "ip_address": null,
  • "id": "17c78e42-655c-43d0-a0d6-273b3c6f198f",
  • "created_at": "2018-08-23T15:06:33.190441Z",
  • "country_code": "CA",
  • "checkin_at": "2018-08-23T15:06:33.187922Z",
  • "anonymized": false,
  • "accuracy": 0
}

Check In Requests

Check in requests allow traveller managers and organizations to create a check in request for their travellers, for which travellers can respond with a check in and their status

Check In Request Attributes

Name Type Description
id String The id of the CheckInRequest
created_at String The time the record was created
updated_at String The time the record was updated
user_id String The id of the user that created this CheckInRequest

Get Check In Requests

Responds with a list of check in requests for the current user. By default, will return check in requests which have not been answered by the user.

Parameters

Name Type Description
all Integer When set to 1, will return all check in requests, answered and unanswered
query Parameters
all
integer
Example: all=1
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Conversations

A conversation allows for users to have a chat. Conversations can have multiple participants (users) and have many messages. Conversations can also be assocaited with a video room.

Conversation Attributes

Name Type Description
id String UUID of the issue
name String The name of the conversation (DEPRECATED? - not used)
messages [Message] A list of messages in the conversation
participants [User] A list of users who have access to the conversation and can make messages within it

Get Conversations

Get conversations

Request Parameters

Name Type Description
discrete Boolean When true, will return conversations that do not have an issue_id or appointment_id
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Create Conversation

Creates a Conversation.

Conversation Object Attributes

Name Type Description
name String The name of the conversation
type Integer The type of conversation
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "conversation": {
    }
}

Response samples

Content type
application/json
{}

Get Conversation For Issue

Returns the conversation for a particular issue. When an issue is created, a conversation is created for the issue. This participants of this conversation usually include the traveller and any responders that are handling the issue.

Request Parameters

Name Type Description
issue_id String UUID of the issue to request conversation
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Get Conversation For Appointment

Returns conversation for an appointment.

Request Parameters

Name Type Description
appointment_id String The id of the appointment
path Parameters
appointment_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Get Conversation

Returns a singular conversation.

Request Parameters

Name Type Description
convo_id String UUID of the conversation
path Parameters
convo_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{}

Create Video For Conversation

Create a video channel for a conversation. Returns the video object structure and access token. This endpoint can be used to request a new access token.

Request Parameters

Name Type Description
convo_id String UUID of the conversation to request a video token for
path Parameters
convo_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
""

Response samples

Content type
application/json
{
  • "video_codecs": [
    ],
  • "unique_name": "9279279e-955c-4618-a839-6e64d073997a",
  • "status": "in-progress",
  • "access_token": "eyJhbGciOiJIUzI1NiIsImN0eSI6InR3aWxpby1mcGE7dj0xIiwidHlwIjoiSldUIn0.eyJleHAiOjE1Mzc3MzAwNzksImdyYW50cyI6eyJpZGVudGl0eSI6ImUxMzc2ZGM3LWYyZDMtNGI1Yi05YTU0LTMxN2JiOTBhYWRhZiIsInZpZGVvIjp7InJvb20iOiI5Mjc5Mjc5ZS05NTVjLTQ2MTgtYTgzOS02ZTY0ZDA3Mzk5N2EifX0sImlzcyI6IlNLNzA3YWZlMzJjODkwNTc3NDNlMzg1ZGJmNDdmZWY3MTMiLCJqdGkiOiJTSzcwN2FmZTMyYzg5MDU3NzQzZTM4NWRiZjQ3ZmVmNzEzLTE1Mzc3MjI4NzkiLCJzdWIiOiJBQzA0NTYzNGUyY2Q2YzAyMDRkODhlOGFkOTc2Mjc2OTdiIn0.6oRt2_rN7qcYQuIsgKuqw092NB-cpQ-keDFrkbiAP5w"
}

Join Conversation

Joins a conversation

Request Parameters

Name Type Description
conversation_id String The id of the conversation
path Parameters
conversation_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "appointment_id": "7adc8426-30cc-4128-a15f-2aeda8069bf4",
  • "created_at": "2019-02-27T15:37:21Z",
  • "id": "5f3d23c0-b235-4d39-88fb-9991b00875f0",
  • "issue_id": null,
  • "messages": [
    ],
  • "name": null,
  • "participants": [],
  • "updated_at": "2019-11-04T20:06:28Z"
}

Coupons

An coupon allows discounts to be applied to subscriptions and other charges.

Coupon Attributes

Name Type Description
id String UUID of the issue
created_at Datetime The datetime the issue was created
updated_at Datetime The time the issue was last updated
type Integer The type of coupon
description String Short description which shows on invoices
percent_off Decimal Percentage discount
redeem_before DateTime The time that the coupon must be redeemed before
max_redemptions Integer The total number of redemptions allowed for this coupon
times_redeemed Integer The number of redemptions used for this coupon
duration Integer The duration type (see below)

Coupon Types

Value Description
0 For promotions and discounts regarding subscriptions.

Duration Types

Value Description
0 Forever. Coupon is applied for current and all future payments.
1 Once. Coupon is applied for only one payment.

Get Coupon

Request details for a coupon.

Request Parameters

Name Type Description
coupon_id String The id of the coupon
path Parameters
coupon_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "updated_at": "2019-06-25T13:15:42.691186Z",
  • "type": 0,
  • "times_redeemed": 0,
  • "redeem_before": null,
  • "product_identifier": "sitata-yearly",
  • "percent_off": 25,
  • "max_redemptions": null,
  • "id": "6998d304-1cc1-4489-9e5d-c8fc4359bddb",
  • "human_id": "25off",
  • "duration": 0,
  • "description": "25% off",
  • "created_at": "2019-06-24T17:18:22.724810Z"
}

Countries

Keeps track of health and safety information for a Country

Country Attributes

Name Type Description
id String The id of the checkin
created_at String The time the record was created
updated_at String The time the record was updated
capital String The name of the capital
language String The languages spoken
currency_name String The name of the currency
currency_code String The currency code
division_name String What major administration regions are called. e.g. Province or State
region_name String What minor adminstration regions are called. e.g. Municipality
topojson_url String Url to the country's topojson file.
geojson_url String Url to the country's geojson file.
facts String Facts about the country in markdown format
sec_areas String Areas to avoid in markdown format
sec_ext_viol String Extreme violence in markdown format
sec_personal String Personal security in markdown format
sec_pol_unr String Political unrest in markdown format
name String Name of the country
country_code String Two character country code
country_code_3 String Three character country code
sec_emer_num String Note about emergency numbers
center_lat Double Latitude of center point of country
center_lng Double Longitude of center point of country
ne_bound_lat Double Latitude of north east bounds of country
ne_bound_lng Double Longitude of north east bounds of country
sw_bound_lat Double Latitude of south west bounds of country
sw_bound_lng Double Longitude of south west bounds of country
flag Map Map of urls to images of the country's flag
banner String Url of the country's banner image
travel_status Integer Travel status for the country (see below)
emerg_numbers [ContactDetail] List of emergency numbers (contact details) for the country (see below)

Travel Status

Value Description
0 Use normal safety precautions
1 Exercise high caution
2 Avoid travel

Contact Detail

A model to keep track of contact details for other models.

Contact Detail Attributes

Name Type Description
id String Id for the contact detail
typ Integer Type of contact detail (see below)
val String Value of contact detail
note String A short description of the contact detail where applicable
order Integer Specifies what in order to display a list of contact details

Contact Detail Types

Value Description
0 Office phone
1 Fax
2 Home phone
3 Phone number
4 URL
5 Email address
6 Mailing address
90 Police emergency number
91 Fire emergency number
92 Ambulance emergency number
93 Tourist emergency number
98 Other emergency number
99 Other

Get Countries

Returns a list of countries. You may specify the page only when requesting a full list of countries(short param is false, or omitted entirely).

Request Parameters

Name Type Description
short Boolean When true, will return all countries with fewer properties. Default is false and will return all properties.
page Integer The page of countries to request.
query Parameters
page
integer
Example: page=1

The page number

short
boolean
Example: short=true

When true, will return a list of countries with a smaller set of properties. This is useful for caching a list.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept-Language
string
Example: all

Responses

Response samples

Content type
application/json
Example
Get Countries
Get Countries
Get Countries Short List
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Country

Returns a country based on id or iso country code.

Request Parameters

Name Type Description
countrt_id_or_code String The two character country code or id of the country to request alerts for. e.g. "CA" for Canada.
path Parameters
country_id_or_code
required
string
Example: TW

Sitata country identifier or 2 character country code

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept-Language
string
Example: ru

Responses

Response samples

Content type
application/json
{
  • "updated_at": "2018-07-20T19:56:07.009418Z",
  • "travel_status": 0,
  • "topojson_url": "https://www.googleapis.com/download/storage/v1/b/sitata-geography-staging/o/countries%2FBR-eb9d5ceff491452cb8cfe56123b62e89.topo.json?generation=1517612068544608&alt=media",
  • "sw_bound_lng": -73.982817,
  • "sw_bound_lat": -34.0891,
  • "sec_pol_unr": "Protests and demonstrations occur frequently in Brazil, and in some cases, have turned violent. To minimize safety risk, avoid all public gatherings and demonstrations due to unpredictability of these situations.",
  • "sec_personal": "Crime rates in Brazil are high. Violent crime, including the use of firearms, can occur anywhere, particularly in cities, such as Rio de Janeiro, Recife, Salvador, and São Paolo. Tourists can be targeted, and robberies can be violent. If robbed, hand over all your valuables and do not attempt to resist. Be particularly vigilant in areas outside the south side of Rio de Janeiro, as well as in areas around the Rodoviaria (bus station). Crime levels in shantytowns (favelas) are extremely high.\r\n\r\nPetty crime, such as pickpocketing, is common in Brazil, particularly in crowded, public areas. Ensure your personal belongings, valuables, and travel documents are kept secure at all times. To minimize risk, avoid showing signs of affluence, such as expensive jewelry and clothing. Avoid walking alone after dark, especially in poorly lit and isolated areas. Be cautious with recent acquaintances offering help, friendship, or hospitality.\r\n\r\nKidnappings where victims are forced to withdraw money from automated banking machines (ABMs) occur throughout the country. Some ATMs have an anti-theft system that marks notes with pink ink if the machine has been tampered with. If you receive cash marked with pink ink, immediately take your receipt and cash into the bank for an exchange. \r\n\r\nThere have been reports of people being robbed when using unregistered taxis or on public buses. Use registered taxis that display a photographic license.\r\n\r\nSexual assault against foreigners can occur. Female travellers should be cautious and never accept rides or food and drink from strangers or casual acquaintances.\r\n\r\nTour companies and city police cannot guarantee your safety if you enter a favela.\r\n\r\nDrink spiking has been reported. Do not accept drinks or food from strangers and never leave your drinks out of your sight.\r\n\r\nTheft is common on beaches. Always avoid isolated areas on or around beaches. Do not carry valuables or important documents, such as passports, to a beach.\r\n\r\nCarjackings do occur. Remain vigilant in your car with windows up and doors locked. Be especially careful at traffic lights, particularly at night. Have your keys in hand and ready when you are approaching your car. Keep valuables out of sight since theft from cars is common.\r\n\r\nBrazilian authorities require all individuals to carry identification with them at all times, particularly passport and visa documentation for travellers. If possible, travellers should lock their personal documents in a secure hotel safe and carry photocopies of their identification with them.\r\n",
  • "sec_ext_viol": "",
  • "sec_emer_num": "",
  • "sec_areas": "Drug trafficking occurs along border areas, such as the states of Amazonas, Acre, Mato Grosso, and Rondônia, making these areas dangerous to tourists.\r\n\r\n",
  • "region_name": "municipality",
  • "ne_bound_lng": -28.650543,
  • "ne_bound_lat": 5.2717863,
  • "name": "Brazil",
  • "language": "Portuguese",
  • "id": "f278992a-4866-4f8a-9f97-42871e4b1a55",
  • "geojson_url": null,
  • "flag": {},
  • "facts": "The Federative Republic of Brazil is Latin America's largest country and the world's fifth largest country, located on the east coast of South America. It is bordered by the Atlantic Ocean on the east, stretching from Venezuela in the north to Uruguay in the south, and west as far as Peru and Bolivia. The population is about 191,000,000 people.\r\n\r\nThe government is a federal republic with a federal district and 26 states. The head of state and head of government is a president.\r\n\r\nMost Brazilians are now middle class, and the strong and developing economy is said to be the largest in South America. Brazil is geographically diverse with beaches, tropical islands, forests, wetlands, mountains, savannahs, and jungles. As a tourist destination, Brazil is known for the Carnaval in Rio de Janeiro, Ipanema Beach, colonial towns, and many other beaches and water sports.\r\n\r\n",
  • "emerg_numbers": [
    ],
  • "division_name": "province",
  • "currency_name": "Real",
  • "currency_code": "BRL",
  • "created_at": "2018-02-01T21:01:13.130640Z",
  • "country_code_3": "BRA",
  • "country_code": "BR",
  • "center_lng": -51.92528,
  • "center_lat": -14.235004,
  • "capital": "Brasilia",
  • "banner": {
    }
}

Get Country Travel Status

Returns a limited set of country information including the id and travel status. Will return a list of country divisions that have a travel status not equal to the country status. Will return a list of country regions that have a travel status not equal to their country division status.

Request Parameters

Name Type Description
countrt_id_or_code String The two character country code or id of the country to request alerts for. e.g. "CA" for Canada.
path Parameters
country_id_or_code
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Covid19

Get Country Covid19 Summary

This is a special endpoint Sitata created for our partners addressing the covid19 response. The response will include three attributes: country, summary, and vaccien. Please refer to Country for a description of the fields contained (few fields included). The summary attribute contains the latest statistic data. Its fields are described below. The vaccine field contains information about the country's current COVID-19 vaccination effort. The details are explained below.

Response Details

Name Type Description
country Map Country details
summary Map A summary of covid19 details

Country Details

Name Type Description
id String Country identifier
country_code String ISO Alpha 2 character country code
population Integer The country's population
topojson_url String Url to topojson border file for the country

Summary

Name Type Description
sitata_risk Integer A scale from 0 to 100 determining the covid risk within the country
irregular Boolean If true, the country has been flagged for irregular reporting
case_count Integer The cumulative number of cases reported
death_count Integer The cumulative number of deaths reported
recovered_count Integer The cumulative number of recoveries reported
active_count Integer Cases less deaths and recoveries
case_density Float The number of cases reported per 100,000 of population
death_density Float The number of deaths reported per 100,000 of population
recovered_density Float The number of recoveries reported per 100,000 of population
active_density Float The number of active cases reported per 100,000 of population
case_acceleration Float The accelartion of change in cases across the past 7 days. If positive, cases are accelerating.
change_cases_1_day Integer The change in the number of cases since the previous day.
change_cases_3_day Integer The change in the number of cases since the previous three days.
change_cases_7_day Integer The change in the number of cases since the previous seven days.
change_cases_14_day Integer The change in the number of cases since the previous 14 days.
change_cases_30_day Integer The change in the number of cases since the previous 30 days.
change_cases_60_day Integer The change in the number of cases since the previous 60 days.
change_cases_90_day Integer The change in the number of cases since the previous 90 days.

Vaccine

Name Type Description
daily_vaccinations Integer New doses administered per day (7-day smoothed).
people_fully_vaccinated Integer The total number of people who received all doses prescribed by the vaccination protocol.
people_vaccinated Integer The total number of people who received at least one vaccine dose.
total_boosters Integer The total number of COVID-19 vaccination booster doses administered which are beyond the number prescribed by the vaccination protocol.
total_vaccinations Integer The total number of COVID-19 vaccination doses administered. For vaccines that require multiple doses, each individual dose is counted.

To calculate the percentage of number of people that have received their first dose:

first dose percentage = (people_vaccinated - people_fully_vaccinated) / population * 100

fully vaccinated percentage = people_fully_vaccinated / population * 100

The numbers will not produce exact results comapared to other sources due to variability in vaccine administration reporting and population records.

path Parameters
country_id_or_code
required
string
Example: SK

Country code or identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Get Country Division Covid19 Summary

This is a special endpoint Sitata created for our partners addressing the covid19 response. The response will include two attributes: country and summary. Please refer to Country for a description of the fields contained (few fields included). The summary attribute contains the latest statistic data. Its fields are described below.

Response Details

Name Type Description
country Map Country details
summary Map A summary of covid19 details

Country Details

Name Type Description
id String Country identifier
country_code String ISO Alpha 2 character country code
population Integer The country's population
topojson_url String Url to topojson border file for the country

Summary

Name Type Description
sitata_risk Integer A scale from 0 to 100 determining the covid risk within the country
irregular Boolean If true, the country has been flagged for irregular reporting
case_count Integer The cumulative number of cases reported
death_count Integer The cumulative number of deaths reported
recovered_count Integer The cumulative number of recoveries reported
active_count Integer Cases less deaths and recoveries
case_density Float The number of cases reported per 100,000 of population
death_density Float The number of deaths reported per 100,000 of population
recovered_density Float The number of recoveries reported per 100,000 of population
active_density Float The number of active cases reported per 100,000 of population
path Parameters
country_division_id_or_code
required
string
Example: US-TX

Country Division code or identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Get Covid19 Global Stats

Returns a list of global stats. Useful for display on a map.

Responses

Response samples

Content type
application/json
[]

Devices

A mobile device belongs to a user and allows the backend to communicate with the user.

Device Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
uuid String The uuid of the device or installation of an app on a device. Is unique.
token String The push notification token assigned to the application installed on the device
locale String The two character language code of the device. e.g. "en"
manufacturer String The manufacturer of the device. e.g. "Apple"
model String The model name of the device. e.g. "iPhone"
platform String The platform of the device. Must be "ios" or "android"
osname String The operating system name of the device. e.g. "iOS"
ostype String DEPRECATED? Not generally used.
osversion String The operating system version. e.g. 12.1
processor_count Integer The number of processors on the device
runtime String DEPRECATED? Not generall used.
username String DEPRECATED? Not generally used.
user_id String The id of the user that the device belongs to

Create Device For User

Create device info for a user. Device must have token as a parameter.

Request Parameters

Name Type Description
user_id String The UUID of the user.

Body Parameters

Name Type Description
token String The push notification token for the device. Required.
platform String Must be either "ios" or "android"
uuid String The uuid of the device or installation of an app on a device. Is unique.
locale String The two character language code of the device. e.g. "en"
manufacturer String The manufacturer of the device. e.g. "Apple"
model String The model name of the device. e.g. "iPhone"
osname String The operating system name of the device. e.g. "iOS"
osversion String The operating system version. e.g. 12.1
processor_count Integer The number of processors on the device
path Parameters
user_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "device": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": null,
  • "username": null,
  • "user_id": "e1376dc7-f2d3-4b5b-9a54-317bb90aadaf",
  • "updated_at": "2018-09-03T03:23:21.013527Z",
  • "token": "abc123",
  • "runtime": null,
  • "processor_count": 2,
  • "platform": "ios",
  • "osversion": "11",
  • "ostype": null,
  • "osname": "Apple ios",
  • "model": "iPhone",
  • "manufacturer": "Apple",
  • "locale": "en-GB",
  • "id": "573711ba-7436-40cb-8c83-94f1fea7f783",
  • "created_at": "2018-09-03T03:23:21.013495Z"
}

Diseases

A Disease keeps track of information about diseases important to know about when travelling to certain countries. Each disease contains a "datum" which allows certain organizations to customize the content presented to their travellers.

Disease Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
common_name String The common name of the disease
scientific_name String The scientific name of the disease
occurs_where String Describes where the disease occurs in markdown format
datum DiseaseDatum The datum for the disease.

Disease Datum

Disease Datum Attributes

Name Type Description
id String The id of the notification
company_id String The company id that the datum belongs to
description String The description of the disease in markdwon format
transmission String Describes how the disease is transmitted in markdwon format
susceptibility String Describes who can catch the disease in markdown format
symptoms String Describes symptoms of the disease in markdown format
prevention String How to prevent the disease in markdown format
treatment String How to treat the disease in markdown format
medications Map The id and name of medications for the disease
vaccinations Map The id and name of vaccinations for the disease

Get Diseases

Returns a list of diseases.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Disease Outbreaks

Get Disease Outbreak For Country

Returns a disease outbreak for the given identifier and statistical data for a specific country.

path Parameters
country_id_or_code
required
string
Example: AF
id
required
string
Example: 9575a71b-4fe4-4dda-aeca-b6804ed175cc
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Get Disease Outbreak

Returns a disease outbreak for the given identifier and statistical data for a specific country.

path Parameters
id
required
string
Example: 9575a71b-4fe4-4dda-aeca-b6804ed175cc
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Entry Requirements

Entry Requirements are hard requirements that affect a person's ability to travel into or within a country or region. At this time, Sitata does not provide VISA entry information. If affected_countries is empty, it should be interpreted as a global rule. i.e. all countries are affected.

Entry Requirement Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
effective_as_of String The time the record was last known to be still in place.
type Integer The type of requirement (see below).
value Integer The value of the requirement (see below).
extras Object/Map A key/value mapping of extra information (see below).
comment String Extra details of the requirement in markdown format
references [String] A list of URLs from which the restriction was information was collected
vaccination Vaccination The vaccination the requirement is associated to
vaccination_id String Identifier for the vaccination
origin_country Country The country that is imposing the restriction
origin_country_id String The country identifier
affected_countries [Country] A list of countries that are affected by the restriction
affected_country_ids [String] A list of country ids that are affected by the restriction
affected_country_division_ids [String] A list of country division ids (states) that are affected by the restriction
affected_country_divisions [CountryDivision] A list of country divisions (states) that are affected by the restriction

Types

Value Description
0 Can a resident enter the country?
1 Can a foreigner enter the country?
2 Is transit allowed through the country?
3 Is a test required on arrival (disease outbreak)?
4 Is a test certificate allowed (disease outbreak)?
5 Is quarantine required on arrival (disease outbreak)?
6 Is a vaccination required?
7 Insurance required?
8 Test certificate required?
9 Entry form required? (health or other)
10 Vaccine Details

Values

Value Description
0 No
1 Yes
2 Yes with exceptions
3 No with exceptions

Extras

Certain category types may contain extra meta-data to further describe the entry requirement.

Key Type Description
quarantine_days Integer For category type 5, describes the number of days of quarantine required.
entry_hours Integer For category type 8, describes the number of hours before arrival in which a passenger must have a negative health test.
vacc_list [Integer] A list of integers corresponding to known vaccinations that are accepted for entry.

Vaccination List

Value Description
0 Oxford-AstraZeneca (Vaxzevria)
1 Moderna (Spikevax)
2 BioNTech-Pfizer (Comirnaty)
3 Sputnik V
4 Sinopharm
5 Sinovac
6 Covaxin
7 Covishield-AstraZeneca
8 Johnson & Johnson's Jansen
9 EU Digital COVID Certificate

Get Entry Requirements For Country

Returns all Entry Requirements for a Country. If state-level data is available, the result set will include it. State-level data can be identified by entries that have a value for origin_country_division and origin_country_division_id.

path Parameters
country_id
required
string
Example: JP

Country code or country identifier

header Parameters
Accept
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Get Entry Requirements

Returns all Entry Requirements. Will return a paginated list. Parameters are combined with a logical AND. If state-level data is available, the result set will include it. State-level data can be identified by entries that have a value for origin_country_division and origin_country_division_id.

query Parameters
affected_country_id
string
Example: affected_country_id=US

The country that is affected by the requirement. Use country code or country identifier.

origin_country_id
string
Example: origin_country_id=AW

The country that has created the requirement. Use country code or country identifier.

types
string
Example: types=0,2

The type of entry requirement as a comma-separated list

nationality
string
Example: nationality=CA

The country that is affected by the requirement. If provided, entry requirements will be filtered for those that apply to that specific nationality. Most notably: entry by foreigner and entry by resident.

destination
string
Example: destination=IN

The country that created the requirement. Analagous to origin_country_id. Value expected is country code or country identifier. Should be used in conjunction with "departure."

departure
string
Example: departure=CA

The country that is affected by the requirement. Analagous to affected_country_id. Value expected is country code or country identifier. Should be used in conjunction with "destination."

destination_country_division
string
Example: destination_country_division=IN-AP

When specified, will only return state-level requirements for the region specified. Expects values specified by ISO_3166-2.

departure_airport
string
Example: departure_airport=TSE

Will returns the travel restrictions in place at the region of departure. Expects the iata or icao code for the airport at the point of departure. Should be used in conjunction with "destination_airport."

destination_airport
string
Example: destination_airport=SOF

Will return the travel restrictions in place at the destination region. Expects the iata or icao code for the arrival airport. Should be used in conjunction with "departure_airport."

destination_lat
number
Example: destination_lat=15.9129

Destination latitude. Should be used in conjunction with other destination and departure coordinate parameters.

destination_lng
number
Example: destination_lng=79.7400

Destination longitude. Should be used in conjunction with other destination and departure coordinate parameters.

departure_lat
number
Example: departure_lat=43.6532

Departure latitude. Should be used in conjunction with other destination and departure coordinate parameters.

departure_lng
number
Example: departure_lng=79.3832

Destination longitude. Should be used in conjunction with other destination and departure coordinate parameters.

vaccinated
boolean
Example: vaccinated=true

Boolean. If true, return rules assuming the traveller is fully vaccinated. Otherwise, return rules assuming the traveller is not fully vaccinated or vaccination status is unknown.

header Parameters
Accept
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Health Comments

A collection of Disease, Vaccination and Medication for Country requests.

Get Country Diseases

Returns a list of diseases for a given country id or iso code.

Request Parameters

Name Type Description
countrt_id_or_code String The two character country code or id of the country to request alerts for. e.g. "CA" for Canada.
path Parameters
country_id_or_code
required
string
Example: IN

Sitata country identifier or country code

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Trip Diseases

Returns a list of diseases for a given trip id. Each disease is coupled with a comment about why it is important for each country. If the comment's common attribute is true, then it is a fairly commen disease that all travellers should be aware of.

Parameters

Name Type Description
trip_id String The id of the trip
path Parameters
trip_id
required
string

Trip identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Country Medications

Returns a list of medications for a given country id or iso code.

Request Parameters

Name Type Description
countrt_id_or_code String The two character country code or id of the country to request alerts for. e.g. "CA" for Canada.
path Parameters
country_id_or_code
required
string

Sitata country identifier or two character country code

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Trip Medications

Returns a list of medications for a given trip id. Each medication is coupled with a comment about why it is recommended for each country. If the comment's common attribute is true, then it is a fairly commen medication that is recommended for most travellers.

Parameters

Name Type Description
trip_id String The id of the trip
path Parameters
trip_id
required
string

Trip identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Country Vaccinations

Returns a list of vaccinations for a given country id or iso code.

Request Parameters

Name Type Description
countrt_id_or_code String The two character country code or id of the country to request alerts for. e.g. "CA" for Canada.
path Parameters
country_id_or_code
required
string

Country identifier or two character country code

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Trip Vaccinations

Returns a list of vaccinations for a given trip id. Each vaccination is coupled with a comment about why it is recommended for each country. If the comment's common attribute is true, then it is a fairly commen vaccination that is recommended for most travellers.

Parameters

Name Type Description
trip_id String The id of the trip
path Parameters
trip_id
required
string

Trip identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Hospitals

Hospitals keep track of known hospitals that are capabile of helping travellers. Some hospitals are known to be emergency capabile. Other hospitals have been accredited by a third party to be of high quality.

Hospital Attributes

Name Type Description
id String The id of the checkin
created_at String The time the record was created
updated_at String The time the record was updated
name String Hospital name
description String Description of hospital
address_str String Address of hospital
lat Double Latitude of hospital
lng Double Longitude of hospital
emergency Boolean True if hospital is known to be emergency capable
starred Boolean DEPRECATED
google_place_id String Google placeId of hospital
google_place_url String Url of google place for hospital
country_id String id of country that hospital belongs to
accr_jci Boolean True if hospital has been accredited by Joint Commission International
contact_details [ContactDetail] A list of ContactDetails. Refer to Countries section.

Get Hospitals For Country

Returns a country based on id or iso country code. This resposne is paginated.

Request Parameters

Name Type Description
countrt_id_or_code String The two character country code or id of the country to request alerts for. e.g. "CA" for Canada.
page Integer The page of hospitals to request.
path Parameters
country_id_or_code
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Hospitals Within Bounds

Returns a list of hospitals based on a given bounds. Expects parameters to include nelat, nelng, swlat, swlng.

Parameters

Name Type Description
nelat Double North East Latitude
nelng Double North East Longitude
swlat Double South West Latitude
swlng Double South West Longitude
query Parameters
nelat
number
Example: nelat=19.665029738820067

North-east latitude

nelng
number
Example: nelng=76.68287307325386

North-east longitude

swlat
number
Example: swlat=17.100567977344248

South-west latitude

swlng
number
Example: swlng=67.12476760450386

South-west longitude

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Invoices

An invoice is associated to one or more Subscriptions and records the purchase of a Subscription or any other Product sales occurring within the platform.

Invoice Attributes

Name Type Description
id String The id of the user
created_at String The time the record was created
updated_at String The time the record was updated
sitata_invoice_id String A human readable identifier for the invoice.
period_start String The starting datetime of the Subscription associated with the invoice.
period_end String The ending datetime of the Subscription associated with the invoice.
subtotal Integer The subtotal of the invoice in the smallest currency denomination. e.g. pence for GBP
total Integer The total of the invoice in the smallest currency denomination. e.g. pence for GBP. Includes taxes.
taxes Integer The total taxes for the invoice in the smallest currency denomination. e.g. pence for GBP
currency String The currency code used for purchase.
items [InvoiceItem] A list of invoice items. i.e. items purchased for the Subscription.
subscriptions [Subscription] A list of Subscriptions associated with the invoice purchase.
coupons String A coupon code used during purchase.

Invoice Item Attributes

Name Type Description
id String The id of the user
created_at String The time the record was created
updated_at String The time the record was updated
amount integer The amount charged for the item in the smallest denomination of currency. e.g. pence for GBP
currency String The currency code used for the item
description String A description of the item

Issues

An issue is created when a traveller (User) is requesting help. Responders (User with a special role) can assist the traveller depending on the issue's type. When an issue is created, a Conversation is also created beteween the traveller and any responders that have helped the traveller.

Issue Attributes

Name Type Description
id String UUID of the issue
created_at Datetime The datetime the issue was created
updated_at Datetime The time the issue was last updated
type Integer The issue type (see below)
status Integer The status of the issue (see below)
description String A description of the issue
companies [Company] A list of companies that own the issue
lat Double Latitude of where the issue was created
lng Double Longitude of where the issue was created
country_code String Two character country code of where the issue was created
affected User The user that is currently having the issue
current_handler User The responder that is currently handing the issue
creator User The user that created the issue (could be same as "affected" or not)
notes [Note] A list of notes that provides a stream of comments to be shared amongst responders.

Issue Types

Value Description
0 Medical request
1 Self help medical request (sent to doctors, dentists, etc)
10 Lost passport
11 Legal issue
20 Lost luggage
21 Flight interruption
99 Other

Issue Status

Value Description
0 Collecting details
1 User is waiting for help
2 Handling. A responder has started to work on this issue.
3 Closed. Closed by responder or traveller.
4 Cancelled. Cancelled by responder or traveller.
5 Finished. Issue is no longer available to users.

Get Issues

Requests all issues for the current user. This request is paginated. By default, only the first page of issues that have a status of 'open' are returned.

Request Parameters

Name Type Description
all Boolean When set to true, will return issues with any status. When falsey, will return all Issues that are not closed.
page Integer The page of issues to request
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Create Issue

Create Issue.

Body Parameters

Parameters should be sent to the server wrapped in a key named issue.

Name Type Description
type Integer Type of issue to create
description String Description of issue
lat Double Latitude of where issue is.
lng Double Longitude of where issue is.
country_code String ISO 3166-1 alpha-2/alpha-3
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "issue": {
    }
}

Response samples

Content type
application/json
{}

Get Issue

Get Issue by its id.

Request Parameters

Name Type Description
issue_id String The id of the Issue
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "updated_at": "2018-09-07T16:24:47.349255Z",
  • "type": 0,
  • "status": 3,
  • "location": {
    },
  • "id": "768f5a25-b30e-41df-aea8-2a60532acade",
  • "description": null,
  • "creator": {
    },
  • "created_at": "2018-09-07T16:19:35.064210Z",
  • "companies": [ ],
  • "availability_bids": [ ],
  • "affected": { }
}

Update Issue

Updates an issue.

Request Parameters

Name Type Description
issue_id String The id of the Issue

Parameters

Name Type Description
status Integer Issue status
description String Description of Issue
type Integer Issue type
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "issue": {
    }
}

Response samples

Content type
application/json
{
  • "updated_at": "2018-09-07T20:03:04.855125Z",
  • "type": 0,
  • "status": 1,
  • "location": {
    },
  • "id": "5e74278d-43b4-4d66-bea3-bbe627de7229",
  • "description": "My issue has now changed",
  • "creator": {
    },
  • "created_at": "2018-09-07T16:10:59.580743Z",
  • "companies": [
    ],
  • "availability_bids": [ ],
  • "affected": {
    }
}

Cancel Issue

Cancels an Issue changing its status

Request Parameters

Name Type Description
issue_id String UUID of the Issue to cancel
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{}

Claim Issue

Allows an assistance provider to claim an issue, exclusively allowing them to resolve the issue.

Request Parameters

Name Type Description
issue_id String UUID of the Issue to claim
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "affected": {},
  • "companies": [
    ],
  • "country_code": null,
  • "created_at": "2019-03-25T19:33:41Z",
  • "creator": {
    },
  • "current_handler": {
    },
  • "description": null,
  • "dispatched": false,
  • "id": "af5af3a0-4288-45d4-a6b6-1f5b2a898c22",
  • "lat": null,
  • "lng": null,
  • "notes": [ ],
  • "number_appointments": 0,
  • "number_bids": 0,
  • "status": 2,
  • "type": 0,
  • "updated_at": "2019-11-05T16:40:42Z"
}

Close Issue

Closses an Issue and returns that Issue object with updated change to :status

Request Parameters

Name Type Description
issue_id String UUID of the Issue to close
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{
  • "affected": {},
  • "companies": [
    ],
  • "country_code": null,
  • "created_at": "2019-03-25T19:33:41Z",
  • "creator": {
    },
  • "current_handler": {
    },
  • "description": null,
  • "dispatched": false,
  • "id": "af5af3a0-4288-45d4-a6b6-1f5b2a898c22",
  • "lat": null,
  • "lng": null,
  • "notes": [ ],
  • "number_appointments": 0,
  • "number_bids": 0,
  • "status": 3,
  • "type": 0,
  • "updated_at": "2019-11-05T16:42:32Z"
}

Medications

A Medication keeps track of information about medications recommended when travelling to certain countries. Each medication contains a "datum" which allows certain organizations to customize the content presented to their travellers.

Medication Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
name String The name of the medication
datum MedicationDatum The datum for the medication.

Medication Datum

Medication Datum Attributes

Name Type Description
id String The id of the notification
company_id String The company id that the datum belongs to
description String The description of the medication in markdwon format
routine Boolean If true, the medication is a routine one
schedule String Describes the schedule when taking the medication in markdown format
side_effects String Describes any side-effects in markdown format

Get Medications

Request the full list of medications.

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Messages

Messages belong to a conversation and are used for chat purposes.

Message Attributes

Name Type Description
id String The id of the message
created_at String The time the record was created
updated_at String The time the record was updated
type Integer The type of the message
status Integer A value indicating the status of the message
body String The body of the message
user_id String The id of the user the notification belongs to
client_id String A UUID that the client supplies when attempting to create the message
asset MessageAsset An object specifying additional data for assets such as images

Message Types

Value Description
0 Text
1 Bot
2 Deleted
3 Server Announcement
4 Asset
5 SMS

Message Asset

This is a model that captures extra metadata about a particular message. Its data is always sent embedded along with the message. This is used when messages need more information. e.g. Messages that are of Asset type.

Message Asset Attributes

Name Type Description
id String The id of the message asset
created_at String The time the record was created
updated_at String The time the record was updated
type Integer The type of the message asset
url String Used when user is sending a url. DEPRECATED
title String A title of the message asset
description String A description of the message asset
lat Double A latitude value
lng Double A longitude value
video Map A map of urls that point to the video asset uploaded
photo Map A map of urls that point to the photo asset uploaded

Message Asset Types

Value Description
0 Image
1 Video
2 Audio
3 Text
4 URL

Create Copy

Create a message belonging to the specified conversation. This endpoint is usually used to create messages that contain an extra asset such as a video or photo. Genreally, websockets are used instead to create text based messages.

Request Parameters

Name Type Description
conversation_id String The id of the conversation that the message belongs to

When uploading a message asset, the server expects it to be embedded within the asset field of the message. For example, an image or video should be converted into base64 and sent within the photo or video field of the asset field on the message parameters.

Message Object Attributes

Name Type Description
type Integer Message type
status Integer Message status
body Integer Message body
client_id String Message client id
path Parameters
conversation_id
required
string
Example: f88da2e4-7041-407c-8b48-3a6d4e1c15f7
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "asset": null,
  • "body": "Hello, world!",
  • "client_id": "8214300a-1442-481c-9a38-a5e890a3dc2e",
  • "created_at": "2019-11-05T16:59:36Z",
  • "id": "9bf92156-646c-46d1-ba7f-9d5c28563e19",
  • "status": 1,
  • "type": 0,
  • "updated_at": "2019-11-05T16:59:36Z",
  • "user_id": "f118f42a-3b9e-479d-94c3-9ee18fa36e4a"
}

Notes

Notes allow Users to record and store text that relates to an issue or appointment.

Note Attributes

Name Type Description
body String The text description of this note.
pinned Boolean When true, prioritizes this note over others.
owner_id String The id of the creator.
issue_id String The id of the issue this note relates to.
appointment_id String The id of the appointment this note relates to.

Get Notes for Appointment

Returns all Notes for a given Appointment id

Request Parameters

Name Type Description
appointment_id String The id of the Appointment to request notes for.
path Parameters
appointment_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Notes for Issue

Returns all Notes for a given Issue id.

Request Parameters

Name Type Description
issue_id String The id of the Issue to request notes for.
path Parameters
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Note for Issue

Creates a Note for given Issue id.

Note Object Parameters

Name Type Description
body String Note body.
pinned Boolean When true, predominantly display these notes over those where pinned is false.
issue_id String the id of the Issue.
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "note": {
    },
  • "issue_id": "ffb18d3d-63b0-4e5b-8b05-2cd6820467e7"
}

Response samples

Content type
application/json
{
  • "appointment": null,
  • "body": "This is my note regarding this issue",
  • "created_at": "2019-11-05T17:20:29Z",
  • "id": "1c998552-f1a1-49da-a5a0-c1fa1d279b1c",
  • "issue": {
    },
  • "owner": {
    },
  • "pinned": false,
  • "updated_at": "2019-11-05T17:20:29Z"
}

Update Note for Issue

Switches the notes pinned state.

Request Parameters

Name Type Description
note_id String The id of the Note.

Request Body Parameters

Name Type Description
issue_id String The id of the Issue.
path Parameters
note_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "issue_id": "ffb18d3d-63b0-4e5b-8b05-2cd6820467e7"
}

Response samples

Content type
application/json
{
  • "appointment": null,
  • "body": "This is my note regarding this issue",
  • "created_at": "2019-11-05T17:20:29Z",
  • "id": "1c998552-f1a1-49da-a5a0-c1fa1d279b1c",
  • "issue": null,
  • "owner": {
    },
  • "pinned": true,
  • "updated_at": "2019-11-05T17:37:54Z"
}

Notifications

Notifications for users of the Sitata platform.

Notification Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
read_at String The time the record was read
title String The title of the notification
body String The body of the notification
data Map A map of extra data (e.g. ids of other resources)
type Integer Represents the notification type
user_id String The id of the user the notification belongs to
company_id String The id of the company the notification belongs to

Notification Types

Value Description Extra Data
0 New Issue for a responder issue_id
1 New AvailabilityBid set by a responder issue_id, bid_id
2 Cancelled AvailabilityBid issue_id, bid_id
3 New Appointment issue_id, appointment_id
4 Cancelled Appointment issue_id, appointment_id
5 Missed Conversation Message conversation_id
6 Notify Absent Conversation Responder conversation_id
9 Notify User Inactive Issue
10 Notify User Finished Issue
20 New Trip trip_id
21 Updated Trip trip_id
22 Deleted Trip trip_id
23 Merged Trips trip_id
24 Itinerary Parsed success (bool)
25 Delayed Itinerary Parsing
30 New Trip By Company For Traveller trip_id
50 Safety Request check_in_request_id
51 Return To Home Country
52 Landed New Country
53 CheckIn Needs Help user_id of traveller
54 CheckInRequest Followup check_in_request_id
100 Flight Cancelled trip_id, air_segment_id
101 Flight Delayed trip_id, air_segment_id
102 Airport Delayed trip_id, airport_code
103 Arrival Gate Change air_segment_id
104 Departure Gate Change air_segment_id
105 Departure Terminal Change air_segment_id
106 Arrival Terminal Change air_segment_id
107 Baggage Claim Change air_segment_id
110 Trip Alert trip_alert_id, trip_id, alert_id, check_in_id
111 Trip Advisory trip_id, advisory_id
115 Company TripAlert Summary
120 Travel Restriction travel_restriction_id
121 Entry Requirement entry_requirement_id
300 TravelMonitor Accommodation
301 TravelMonitor Airport Landed
302 TravelMonitor Flight Delayed
303 TravelMonitor Flight Cancelled
304 TravelMonitor Check In Request
305 TravelMonitor Trip Alert
306 TravelMonitor Itinerary Change
500 New traveller for company
501 Confirmed traveller for company
502 Invited new user for company Not saved on server
503 Invited existing user for company Not saved on server
504 Updated user
505 Updated user settings
506 Deleted user
900 Charge created for traveller for appointment
901 Charge created for traveller for coverage
902 Charge created for traveller for single purchase
903 Upcoming Subscription Renewal subscription_id
904 Invoice Paid subscription_id, invoice_id
910 Deposit made for responder (either into connected account or sitata balance)
911 Manual payout made for responder

Get Notifications

Returns Notifications for the user.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Mark Notification As Read

Sets the 'read_at' time for a user's notification.

Parameters

Name Type Description
notification_id String The id of the Notification
path Parameters
notification_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{
  • "body": null,
  • "company_id": null,
  • "created_at": "2018-11-13T19:11:19Z",
  • "data": {
    },
  • "id": "abf16864-2464-4e27-a91b-cccbc8127428",
  • "read_at": "2019-11-05T18:31:03Z",
  • "title": null,
  • "type": 1,
  • "updated_at": "2019-11-05T18:31:03Z",
  • "user_id": "f118f42a-3b9e-479d-94c3-9ee18fa36e4a"
}

Delete Notification

Removes a notification for the user.

Parameters

Name Type Description
notification_id String The id of the Notification
path Parameters
notification_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[ ]

Organization

A collection scoped to perform actions by a Company The intention for requests under this section are for server to server communication between your organization and Sitata. For example, creating users within your own organization on the Sitata platform. As such, you should use your company authentication token when accessing endpoints within this section.

Organization > Alert Filters

Alert filters allow a company to stop notifications for Alerts and Advisories based on risk level and category across the entire company and for all users at that company.

Alert Filter Attributes

Name Type Description
id String The id of the AlertFilter
created_at String The time the record was created
updated_at String The time the record was updated
risk_levels [Integer] A list of risk levels that apply for the filter.
safety_category_id String The ID of the Safety Category that applies for the filter.

Get Alert Filters For Your Organization

Returns alert filters for your organization. Alert filters block distribution of Alerts and Advisories to users within your organization.

path Parameters
company_id
required
string
Example: {{corp_company_id}}
header Parameters
Authorization
string
Example: {{corp_company_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Alert Filter

Create an Alert Filter for an organization.

path Parameters
company_id
required
string
Example: {{corp_company_id}}
header Parameters
Authorization
string
Example: {{corp_company_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "alert_filter": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "2016-06-21T12:39:24Z",
  • "updated_at": "2016-06-21T12:39:24Z",
  • "id": "6747af61-f379-466c-869e-367e060babbe",
  • "risk_levels": [
    ],
  • "safety_category_id": "4832af61-a379-466c-869e-372e060bafef"
}

Update Alert Filter

Update an Alert Filter.

path Parameters
company_id
required
string
Example: {{corp_company_id}}
id
required
string
Example: {{alert_filter_id}}
header Parameters
Authorization
string
Example: {{corp_company_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "alert_filter": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "2016-06-21T12:39:24Z",
  • "updated_at": "2016-06-21T12:39:24Z",
  • "id": "6747af61-f379-466c-869e-367e060babbe",
  • "risk_levels": [
    ],
  • "safety_category_id": "4832af61-a379-466c-869e-372e060bafef"
}

Delete Alert Filter

Delete an Alert Filter.

path Parameters
company_id
required
string
Example: {{corp_company_id}}
id
required
string
Example: {{alert_filter_id}}
header Parameters
Authorization
string
Example: {{corp_company_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

Organization > Check In Requests

Check in requests allow traveller managers and organizations to create a check in request for their travellers, for which travellers can respond with a check in and their status

Check In Request Attributes

Name Type Description
id String The id of the CheckInRequest
created_at String The time the record was created
updated_at String The time the record was updated
user_id String The id of the user that created this CheckInRequest

Get Check In Requests

Returns Check In Requests for a given company.

By default, will return check in requests which are still open.

Parameters

Name Type Description
all Boolean When truthy, will return all Check In Requests, open and closed. Else, when false, will only return open.
path Parameters
company_id
required
string
Example: {{corp_company_id}}
header Parameters
Authorization
string
Example: {{corp_company_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Create Check In Request

Creates a CheckInRequest for a list of travellers given their ids.

Request Parameters

Name Type Description
id Array An array of user ids.
path Parameters
company_id
required
string
Example: {{corp_company_id}}
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: {{corp_company_auth}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "check_in_request": {
    }
}

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "updated_at": "2018-08-23T15:34:41.188589Z",
  • "status": 0,
  • "requester": {
    },
  • "id": "e1569693-fd36-493d-8237-d6d297ba655c",
  • "created_at": "2018-08-23T15:34:41.188582Z",
  • "company_id": "91955970-34eb-4a1b-97e6-53e9084abbfa",
  • "check_ins": [ ],
  • "alert_id": null
}

Close Check In Request

Closes a Check In Request.

Request Parameters

Name Type Description
company_id String The id of the Company.
check_in_request_id String The id of the Check In Request.
path Parameters
company_id
required
string
check_in_request_id
required
string
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "updated_at": "2018-08-23T15:45:43.825408Z",
  • "status": 1,
  • "requester": {
    },
  • "id": "297ab659-4939-4745-88af-190488baa6dc",
  • "created_at": "2018-08-23T15:43:13.497897Z",
  • "company_id": "91955970-34eb-4a1b-97e6-53e9084abbfa",
  • "check_ins": [ ],
  • "alert_id": null
}

Organization > Companies

An company can control a group of employees and travellers on the Sitata platform.

Company Attributes

Name Type Description
id String UUID of the issue
created_at Datetime The datetime the issue was created
updated_at Datetime The time the issue was last updated
name String The name of the company
homepage String The url of the company
assistance_contacts [ContactDetail] A list of contact details representing this company's preferred assistance hotline numbers

Get Company

Return details about a company. If the user is an employee of the company, additional fields will be returned.

Request Parameters

Name Type Description
company_id String The id of the Company.
all_locales Boolean When true, will return all locale values for attribtues.
path Parameters
company_id
required
string
query Parameters
all_locales
boolean
Example: all_locales=true
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "assistance_contacts": [ ],
  • "auto_subscribe": false,
  • "created_at": "2013-03-02T16:39:26Z",
  • "domains": [
    ],
  • "homepage": null,
  • "id": "91955970-34eb-4a1b-97e6-53e9084abbfa",
  • "name": "Sitata Inc.",
  • "packages": [
    ],
  • "settings": {
    },
  • "sitata_assistance": false,
  • "updated_at": "2019-09-17T17:27:28Z"
}

Update Company

Update Company.

Request Parameters

Name Type Description
company_id String The id of the Company.

Company Object Attributes

Name Type Description
auto_subscribe Boolean When true, subscriptions will automatically be created for new users that join the company.
settings Object An object encapsulating details regarding company settings. (See 'Settings' table below for further details.
assistance_contacts Array An Array of Objects encapsulating details regarding assistance contacts. See 'Contact' table below for futher details.

Settings Object Attributes

Name Type Description
enable_travel_monitors Boolean When true, travel watchers will be creating for all users for company. When false, will remove all travel watchers for this company.
on_accommodation Integer Frequency of notifications when this action is triggered.
on_airport_landed Integer Frequency of notifications when this action is triggered.
on_flight_delayed Integer Frequency of notifications when this action is triggered.
on_flight_cancelled Integer Frequency of notifications when this action is triggered.
on_check_in_request Integer Frequency of notifications when this action is triggered.
sr_disease_trigger Boolean Automatic safety request when travellers affected by the disease safety category(disease outbreak).
st_trigger_categories Array Automatic safety request when travellers affected by specified safety category. An Array of Sting ids from Safety Category.
cir_follow_up_min Integer Safety request time to follow up in minutes.
traveller_leaving_travel_status Integer Receive notification when traveller leaves a country region with specified minumum risk level, or higher.
traveller_entering_travel_status Integer Receive notification when a traveller enters a country region with specified minimum risk level, or higher.

Contact Object Attributes

Name Type Description
val String The value given to contact this entity. This can be a phone number, address, email address, etc
typ Integer Type of contact.
note Object An Object mapping different locales to a given description for this entity.
delete Boolean When true, deletes this contact.
path Parameters
company_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "company": {
    }
}

Response samples

Content type
application/json
{
  • "assistance_contacts": [
    ],
  • "auto_subscribe": true,
  • "created_at": "2019-11-06T15:50:06Z",
  • "domains": null,
  • "homepage": null,
  • "id": "86c049fd-8e7c-436c-9107-4a8c481e90ef",
  • "name": null,
  • "packages": [ ],
  • "settings": {
    },
  • "sitata_assistance": true,
  • "updated_at": "2019-11-06T16:57:47Z"
}

Organization > Conversations

A conversation allows for users to have a chat. Conversations can have multiple participants (users) and have many messages. Conversations can also be assocaited with a video room.

Conversation Attributes

Name Type Description
id String UUID of the issue
name String The name of the conversation (DEPRECATED? - not used)
messages [Message] A list of messages in the conversation
participants [User] A list of users who have access to the conversation and can make messages within it

Get Conversations

Returns conversations for the organization.

Request Parameters

Name Type Description
company_id String The id of the Company.
discrete Boolean When true, will return conversations that do not belong to an appointment or issue.
page Integer The page of Conversations to request.
path Parameters
company_id
required
string
Example: {{corp_company_id}}
query Parameters
page
integer
Example: page=1
header Parameters
Authorization
string
Example: {{corp_company_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create Conversations

Typically used when creating SMS conversations. It is required to create one conversation per sms recipient.

Request Parameters

Name Type Description
company_id String The id of the Company.

Body Parameters

Name Type Description
conversations Array An Array of Conversation Objects.

Conversation Object Attributes

Name Type Description
type Integer Type of Conversation.
name String Name of Conversation.
participant_ids Array An Array of User ids to include in Conversation.
messages Array An Array of Message Objects. See Message table below for further details.

Message Object Attributes

Name Type Description
type Integer Type of Message.
status Integer Status of Message.
body String Text body of Message.
client_id String id given for message.
path Parameters
company_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "conversations": [
    ]
}

Response samples

Content type
application/json
[]

Get Outgoing Token

Request an outgoing communication token for the current user and company specified.

Request Parameters

Name Type Description
company_id String The id of the Company.
path Parameters
company_id
required
string
Example: {{corp_company_id}}
header Parameters
Authorization
string
Example: {{corp_company_auth}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NzMwNTUxNTksImlzcyI6IkFDMDQ1NjM0ZTJjZDZjMDIwNGQ4OGU4YWQ5NzYyNzY5N2IiLCJzY29wZSI6InNjb3BlOmNsaWVudDpvdXRnb2luZz9hcHBTaWQ9QVBlYTE4NzNhNGNkMzU0YjE1YjZlNDBkYTg5M2ZlMzhlMyJ9.3XeDH19ddSdzC9aW9CzZiEpisqNUT_X28aRKXccSvnc"
}

Organization > Issues

An issue is created when a traveller (User) is requesting help. Responders (User with a special role) can assist the traveller depending on the issue's type. When an issue is created, a Conversation is also created beteween the traveller and any responders that have helped the traveller.

Issue Attributes

Name Type Description
id String UUID of the issue
created_at Datetime The datetime the issue was created
updated_at Datetime The time the issue was last updated
type Integer The issue type (see below)
status Integer The status of the issue (see below)
description String A description of the issue
companies [Company] A list of companies that own the issue
lat Double Latitude of where the issue was created
lng Double Longitude of where the issue was created
country_code String Two character country code of where the issue was created
affected User The user that is currently having the issue
current_handler User The responder that is currently handing the issue
creator User The user that created the issue (could be same as "affected" or not)
notes [Note] A list of notes that provides a stream of comments to be shared amongst responders.

Issue Types

Value Description
0 Medical request
1 Self help medical request (sent to doctors, dentists, etc)
10 Lost passport
11 Legal issue
20 Lost luggage
21 Flight interruption
99 Other

Issue Status

Value Description
0 Collecting details
1 User is waiting for help
2 Handling. A responder has started to work on this issue.
3 Closed. Closed by responder or traveller.
4 Cancelled. Cancelled by responder or traveller.
5 Finished. Issue is no longer available to users.

Get Issues

Returns all issues for given Company by its id. Response is paginated.

Request Parameters

Name Type Description
company_id String The id of the Company.
page Integer The page of issues to request.
path Parameters
company_id
required
string
query Parameters
page
integer
Example: page=1
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Create Issue

A manager for Company can create an Issue on behalf of their travellers.

Request Parameters

Name Type Description
company_id String The id of Company.

Body Parameters

Parameters should be sent to the server wrapped in a key named Issue.

Name Type Description
affected_id String The id of the User for which the Issue will be created for.
creator_id String The id of the User responsible for the creation of Issue. The may be omitted when a user authentication token is used to make this request.
type Integer Type of Issue to create
description String Description of Issue
lat Double Latitude of where Issue is.
lng Double Longitude of where Issue is.
country_code String ISO 3166-1 alpha-2/alpha-3
path Parameters
company_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "issue": {
    }
}

Response samples

Content type
application/json
{}

Get Issue

Gets Company Issue given their ids.

Request Parameters

Name Type Description
company_id String The id of the Company.
issue_id String The id of the Issue.
path Parameters
company_id
required
string
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Update Issue

A manager for Company can update an Issue on behalf of their travellers.

Request Parameters

Name Type Description
company_id String The id of Company.
issue_id String The id of Issue to update.

Body Parameters

Parameters should be sent to the server wrapped in a key named issue.

Name Type Description
description String Description of Issue.
status Integer Status of Issue.
type Integer Type of Issue.
path Parameters
company_id
required
string
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "issue": {
    }
}

Response samples

Content type
application/json
{}

Close Issue

Closses an Issue.

Request Parameters

Name Type Description
company_id String The id of Company.
issue_id String The id of the Issue to close.
path Parameters
company_id
required
string
issue_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{}

Organization > Trips

A trip keeps information about a user's past, active, and future trips. A trip has destinations and can manage a user's itinerary/bookings through TripSegments.

Trip Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
deleted_at String The time the record was deleted
name String The name of the trip
start Datetime The time that the trip starts
finish Datetime The time that the trip finishes
read Boolean True if the user has read the trip details
muted Boolean True if the user no longer wants to receive notifications about the trip
trip_type Integer The type of trip (see below)
activities [Integer] A list of integers representing the activities for the trip (see below)
company_name String Name of company that the trip belongs to
employee_name String Name of the employee that the trip belongs to
final Boolean DEPRECATED
settings TripSetting Trip settings for the trip (see below)
destinations [Destination] A list of destinations for the trip (see below)
travellers [User] A list of users that own the trip

Trip Types

Value Description
0 Holiday
1 Business
2 Other

Trip Activities

Value Description
0 Beach & Sun
1 Scuba Diving
2 Snorkeling
3 Hiking
4 Camping
5 Kayaking
6 Canoeing
7 Shopping
8 Site Seeing
9 Museums
10 Food
11 Eco Tourism
12 Bicycling
13 Backpacking
14 Golf
15 Rock Climbing
16 Skiing
17 Snowboarding
18 Photography
19 Safari
20 Around The World
21 Medical Tourism
22 Humanitarian Work
23 Gambling
24 Jungle Trekking
25 Cruise
26 Road Trip
27 Amusement Park
28 Concert

Trip Settings

A map of trip settings. Not yet defined.

Destinations

A trip can have one or more destinations.

Destination Attributes

Name Type Description
id String The id of the notification
entry_date Datetime The datetime that the user will enter the Destiantion
exit_date Datetime The datetime that the user will leave the Destiantion
country_id String The UUID of the country that this Destination belongs to
friendly_name String The name of the destination. e.g. Paris
lat Double The latitude of the Destination
lng Double The longitude of the Destination
type Integer The type of Destination (see below)

Destination Types

Value Description
0 Country
1 City
2 Region (e.g. State or Province or Municipality)

Trip Segments

A trip can also have 5 different types of trip segments or bookings: air, hotel, car, rail, and activity. Trip Segments allow a user to keep track of their itinerary for their trip. In the case of an AirSegment, they allow Sitata to monitor flights and airports for cancellations and delays. Segments are created by parsing emails.

Air Segment

Keeps track of plane tickets.

Air Segment Attributes

Name Type Description
id String The id of the air segment
created_at String The time the record was created
updated_at String The time the record was updated
airline String The name of the airline. e.g. Alaska Airlines
class_of_service String The type of service. e.g. Business
confirmation_no String The confirmation number. Usually the PNR. e.g. ABJ3D98
currency String The currencey code. e.g. USD
arrival_datetime Datetime The naive datetime of arrival. e.g. 2015-06-14T19:39:00
arrival_time_zone_id String The IATA timezone identifier for arrival
arrival_datetime_utc Datetime The UTC datetime of arrival
estimated_arrival Datetime The naive datetime for arrival when a flight has been delayed
estimated_arrival_utc Datetime The UTC datetime of arrival when a flight has been delayed
arrival_gate String The airport gate during arrival
arrival_terminal String The airport terminal during arrival
departure_datetime Datetime The naive datetime of departure. e.g. 2015-06-18T19:39:00
departure_time_zone_id String The IATA timezone identifier for departure
departure_datetime_utc Datetime The UTC datetime of departure. e.g. 2015-06-18T19:39:00
estimated_departure Datetime The naive datetime for departure when a flight has been delayed
estimated_departure_utc Datetime The UTC datetime of departure when a flight has been delayed
departure_gate String The airport gate during departure
departure_terminal String The airport terminal during departure
destination String The airport code of the destination. Usually IATA. e.g. PDX
destination_name String The airport name. e.g. Portland International
destination_admin_code String The region code of the destination airport. e.g. TX for Texas
destination_city_name String The city name of the destination airport. e.g. Portland
destination_country String The two character country code of the destination. e.g. CA for Canada
destination_lat Double The latitude of the destination airport
destination_lng Double The longitude of the deatinaion airport
origin String The airport code of the original. Usually IATA. e.g. PDX
origin_name String The airport name of the origin. e.g. Portland International
origin_admin_code String The region code of the origin airport. e.g. TX for Texas
origin_city_name String The city name of the origin airport. e.g. Portland
origin_country String The two character country code of the origin. e.g. CA for Canada
origin_lat Double The latitude of the origin airport
origin_lng Double The longitude of the origin airport
fare_basis_code String e.g. G
flight_number String Flight number e.g. 655
iata_code String IATA code of the airline. e.g. AS
normalized_airline String Airline code. e.g. ASA
number_of_pax Integer Number of passengers
price Decimal Parsed from dollars. e.g. $380.30
seat_assignment String e.g. 22D
source String Name of source. e.g. Trip Advisor
status Integer Status of the flight (see below)
ticket_number String e.g. 123456
tickets [String] A list of ticket numbers
seats [String] A list of seat numbers

Rail Segment

Keeps track of rail tickets.

Rail Segment Attributes

Name Type Description
id String The id of the rail segment
created_at String The time the record was created
updated_at String The time the record was updated
rail_line String The name of the railway. e.g. Amtrak
confirmation_no String The confirmation number. Usually the PNR. e.g. ABJ3D98
currency String The currencey code. e.g. USD
arrival_datetime Datetime The naive datetime of arrival. e.g. 2015-06-14T19:39:00
arrival_time_zone_id String The IATA timezone identifier for arrival
arrival_datetime_utc Datetime The UTC datetime of arrival
departure_datetime Datetime The naive datetime of departure. e.g. 2015-06-18T19:39:00
departure_time_zone_id String The IATA timezone identifier for departure
departure_datetime_utc Datetime The UTC datetime of departure. e.g. 2015-06-18T19:39:00
destination String The railway code of the destination. Usually IATA. e.g. PDX
destination_name String The destination rail station name.
destination_admin_code String The region code of the destination station. e.g. TX for Texas
destination_city_name String The city name of the destination station. e.g. Portland
destination_country String The two character country code of the destination. e.g. CA for Canada
destination_lat Double The latitude of the destination station
destination_lng Double The longitude of the deatinaion station
origin String The railway code of the original. Usually IATA. e.g. PDX
origin_name String The station name of the origin. e.g. Portland International
origin_admin_code String The region code of the origin station. e.g. TX for Texas
origin_city_name String The city name of the origin station. e.g. Portland
origin_country String The two character country code of the origin. e.g. CA for Canada
origin_lat Double The latitude of the origin station
origin_lng Double The longitude of the origin station
train_number String Train number e.g. 655
number_of_pax Integer Number of passengers
price Decimal Parsed from dollars. e.g. $380.30
seat_assignment String e.g. 22D
source String Name of source. e.g. Trip Advisor
status Integer Status of the train segment (see below)
ticket_number String e.g. 123456
tickets [String] A list of ticket numbers
seats [String] A list of seat numbers

Car Segment

Keeps track of car rentals.

Car Segment Attributes

Name Type Description
id String The id of the rail segment
created_at String The time the record was created
updated_at String The time the record was updated
car_company String Name of car company. e.g. Hertz
car_description String Description of car
car_type String Type of car. e.g. Intermediate 2
confirmation_no String Confirmation number
currency String The currencey code. e.g. USD
dropoff_address1 String Address line 1 of dropoff location
dropoff_address2 String Address line 2 of dropoff location
dropoff_admin_code String Region code of dropoff location
dropoff_city_name String City name of dropoff location
dropoff_country String Two character country code of dropoff location. e.g. CA for Canada
dropoff_lat Double Latitude of dropoff location
dropoff_lng Double Longitude of dropoff location
dropoff_postal_code String Postal code of dropoff location
dropoff_datetime Datetime Dropoff datetime. e.g. 2015-07-10T12:00:00
dropoff_time_zone_id String Timezone of dropoff location
dropoff_datetime_utc Datetime Dropoff UTC datetime
hours_of_operation String Hours of operation
normalized_car_company String Car company name. e.g. Hertz
pickup_address1 String Address line 1 of pickup location
pickup_address2 String Address line 2 of pickup location
pickup_admin_code String Region code of pickup location
pickup_city_name String City name of pickup location
pickup_country String Two character country code of pickup location. e.g. CA for Canada
pickup_datetime Datetime Pickup datetime. e.g. 2015-07-10T12:00:00
pickup_time_zone_id String Timezone of pickup location
pickup_datetime_utc Datetime Pickup UTC datetime
pickup_lat Double Latitude of pickup location
pickup_lng Double Longitude of pickup location
pickup_postal_code String Postal code of pickup location
price Decimal Parsed from dollars. e.g. $380.30
source String Name of source. e.g. Trip Advisor
status Integer Status of the car booking (see below)

Hotel Segment

Keeps track of hotel stays.

Hotel Segment Attributes

Name Type Description
id String The id of the rail segment
created_at String The time the record was created
updated_at String The time the record was updated
address1 String Address line 1 of hotel location
address2 String Address line 2 of hotel location
admin_code String Region code for the hotel location. e.g. TX for Texas
cancellation_policy String Cancellation policy
checkin_date Datetime Check-in datetime. e.g. 2015-03-06 15:00:00
checkout_date Datetime Check-out datetime. e.g. 2015-03-07 12:00:00
checkin_date_utc Datetime UTC datetime for check-in
checkout_date_utc Datetime UTC datetime for check-out
time_zone_id String Timezone identifier of the hotel location
city_name String City name of hotel location
confirmation_no String Confirmation number
country String Two character country code of pickup location. e.g. CA for Canada
currency String The currencey code. e.g. USD
hotel_name String The name of the hotel
lat Double Latitude of hotel location
lng Double Longitude of hotel location
number_of_rooms Integer Number of roooms
postal_code String Postal code of hotel location
rate_description String Rate description
room_description String Room description
room_type String Type of room
price Decimal Parsed from dollars. e.g. $380.30
source String Name of source. e.g. Trip Advisor
status Integer Status of the hotel booking (see below)

Activity Segment

Keeps track of activities such as concerts and other types of event tickets.

Activity Segment Attributes

Name Type Description
id String The id of the rail segment
created_at String The time the record was created
updated_at String The time the record was updated
activity_type String Activity type. e.g. General
activity_name String Activity name. e.g. Van Halen Concert
start_name String Name of start location. e.g. Park City Ampitheater
start_admin_code String Region code of start location. e.g. TX for Texas
start_address1 String Address line 1 of start location
start_address2 String Address line 2 of start location
start_city_name String City name of start location
start_country String Two character country code of start. e.g. CA for Canada
start_lat Double Latitude of start location
start_lng Double Longitude of start location
start_postal_code String Postal code of start location
end_name String Name of end location. e.g. Park City Ampitheater
end_admin_code String Region code of end location. e.g. TX for Texas
end_address1 String Address line 1 of end location
end_address2 String Address line 2 of end location
end_city_name String City name of end location
end_country String Two character country code of end. e.g. CA for Canada
end_lat Double Latitude of end location
end_lng Double Longitude of end location
end_postal_code String Postal code of end location
start_datetime Datetime Start time. e.g. 2015-03-06 15:00:00
end_datetime Datetime End time. e.g. 2015-03-07 03:00:00
start_datetime_utc Datetime Start UTC time
end_datetime_utc Datetime End UTC time
time_zone_id String Timezone identifier for the activity
confirmation_no String Confirmation number
currency String The currencey code. e.g. USD
price Decimal Parsed from dollars. e.g. $380.30
source String Name of source. e.g. Trip Advisor
status Integer Status of the hotel booking (see below)

Cruise Segment

Keeps track of cruise legs.

Cruise Segment Attributes

Name Type Description
id String The id of the cruise segment
created_at String The time the record was created
updated_at String The time the record was updated
cruise_line String The name of the cruise line. e.g. Norwegian Cruise
ship_name String The name of the ship. e.g. NORWEGIAN ESCAPE
confirmation_no String The confirmation number. Usually the PNR. e.g. ABJ3D98
currency String The currencey code. e.g. USD
arrival_datetime Datetime The naive datetime of arrival. e.g. 2015-06-14T19:39:00
arrival_time_zone_id String The IATA timezone identifier for arrival
arrival_datetime_utc Datetime The UTC datetime of arrival
departure_datetime Datetime The naive datetime of departure. e.g. 2015-06-18T19:39:00
departure_time_zone_id String The IATA timezone identifier for departure
departure_datetime_utc Datetime The UTC datetime of departure. e.g. 2015-06-18T19:39:00
destination String The airport code of the destination. Usually IATA. e.g. PDX
destination_name String The airport name. e.g. Portland International
destination_admin_code String The region code of the destination airport. e.g. TX for Texas
destination_city_name String The city name of the destination airport. e.g. Portland
destination_country String The two character country code of the destination. e.g. CA for Canada
destination_lat Double The latitude of the destination airport
destination_lng Double The longitude of the deatinaion airport
origin String The airport code of the original. Usually IATA. e.g. PDX
origin_name String The airport name of the origin. e.g. Portland International
origin_admin_code String The region code of the origin airport. e.g. TX for Texas
origin_city_name String The city name of the origin airport. e.g. Portland
origin_country String The two character country code of the origin. e.g. CA for Canada
origin_lat Double The latitude of the origin airport
origin_lng Double The longitude of the origin airport
number_of_pax Integer Number of passengers
price Decimal Parsed from dollars. e.g. $380.30
tickets [String] A list of ticket numbers
seats [String] A list of seat numbers
source String Name of source. e.g. Trip Advisor
status Integer Status of the flight (see below)

Trip Segment Status

Value Description
-1 unknown
0 active
1 past
2 deleted
3 delayed

Get Trips

Get Trips for Company given its id. Response is paginated.

Request Parameters

Name Type Description
company_id String The id of the Company to request Trips for.
page Integer The page of Trips to request.
path Parameters
company_id
required
string
query Parameters
page
integer
Example: page=1
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {},
  • {
    },
  • {}
]

Create Trip

Allows a manager of a Company to create Trip for their Users.

Request Parameters

Name Type Description
company_id String The id of the Company.

Trip Object Attributes

Expects destinations, air_segments, car_segments, hotel_segments and rail_segments to be wrapped in a key with their name.

Name Type Description
name String The name for Trip.
trip_type Integer The type for Trip.
activities Array An Array of Integers specifying addition Trip details.
start Datetime The start datetime for Trip.
finish Datetime The end datetime for Trip.
destinations [Destination] An Array of Destinations. See Destination table below for further details.
activity_segments [ActivitySegment] A list of ActivitySegment objects.
air_segments [AirSegment] A list of AirSegment objects.
car_segments [CarSegment] A list of CarSegment objects.
hotel_segments [HotelSegment] A list of HotelSegment objects.
rail_segments [RailSegment] A list of RailSegment objects.

Destination Object Attributes

Name Type Description
type Integer Destination type. See Destination Types table below.
friendly_name Name of destination. Usually expecting city name.
country_id String The id of Country.
delete Boolean When true, deletes Destination.
location Object Geo location of this Destination.
entry_date Datetime Datetime representing when traveller arrives at this destination.
exit_date Datetime Datetime representing when traveller leaves at this destination.

Destination Types

Value Description
0 Country
1 City
2 Region
path Parameters
company_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "trip": {
    }
}

Response samples

Content type
application/json
[]

Update Trip

Update a trip. Partial edits for relationships are not accepted. Therefore, it is best to submit the full trip's attributes all at once.

Request Parameters

Name Type Description
company_id String The id of the company.
trip_id String The id of the trip.

Body Parameters

The request body should be wrapped in a parameter key named trip.

Name Type Description
name String The name of the trip
trip_type Integer The type of trip
start Datetime The date that the trip starts
finish Datetime The date that the trip finishes
activities [Integer] An integer based list of activity identifiers
destinations [Destination] A list of Destination objects
air_segments [AirSegment] A list of AirSegment objects
rail_segments [RailSegment] A list of RailSegment objects
car_segments [CarSegment] A list of CarSegment objects
hotel_segments [HotelSegment] A list of HotelSegment objects
activity_segments [ActivitySegment] A list of ActivitySegment objects
path Parameters
company_id
required
string
trip_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "trip": {
    }
}

Response samples

Content type
application/json
{
  • "activities": [
    ],
  • "company_name": null,
  • "created_at": "2020-04-30T20:14:56.706758Z",
  • "deleted_at": null,
  • "destinations": [
    ],
  • "employee_name": null,
  • "final": true,
  • "finish": "2019-02-02T04:40:00.000000Z",
  • "id": "8fd6d5de-8805-414b-a5ac-a890699a9d39",
  • "muted": false,
  • "name": "New York Trip",
  • "read": false,
  • "settings": null,
  • "start": "2019-02-01T11:55:00.000000Z",
  • "travellers": [ ],
  • "trip_type": 2,
  • "updated_at": "2020-04-30T20:17:44.448157Z"
}

Delete Trip

Delete Trip.

Request Parameters

Name Type Description
company_id String The id of Company.
trip_id String The id of Trip.
path Parameters
company_id
required
string
trip_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{ }

Get Trip

Get Trip.

Request Parameters

Name Type Description
company_id String The id of the Company.
trip_id String The id of the Trip.
path Parameters
organization_id
required
string
Example: 91955970-34eb-4a1b-97e6-53e9084abbfa

Organization identifier

trip_id
required
string
Example: f07a2591-7850-46a3-9980-9881f52e0076

Trip identifier

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{}

Organization > TripAlerts

DEPRECATED This keeps track of which alerts were sent to a user and if that user has read the alert or not. It has since been replaced by Notification

Get Trip Alerts

Gets Trip Alerts published to Company travellers.

Request Parameters

Name Type Description
alert_id String The id of the Alert.
company_id String The id of the Company.
path Parameters
company_id
required
string
alert_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Organization > Subscriptions

A Subscription contains one or more Products with or without insurance benefits that include additional services. Users that have a Subscription can log into the Sitata platform, including its mobile application.

Subscription Attributes

Name Type Description
id String The id of the user
created_at String The time the record was created
updated_at String The time the record was updated
start String The start datetime of the subscription
finish String The finish datetime of the subscription
start_date String The start date of the subscription (no time component)
finish_date String The finish date of the subscription (no time component)
currency_code String The currency code that the subscription was purchased in
country_code String The country code that was specified as the purchase origin
region_code String The region code that was specified as the purchase origin
language String The language code that was specified during purchase
metadata String Map A convenient key/value store for any data you would like to associate with the purchase. All values will be converted to strings.
human_id String A human readable identifier for the Subscription. It's also known as the "plan number", or "policy number."
company_id String The company identifier associated with the subscription.
user_id String The id of the user who purchased the subscription
user User The full User associated with the subscription
name String The name of the user associated with the subscription
email String The email of the user associated with the subscription
products [Product] A list of products associated with the subscription
coupon String A coupon code that was used to purchase the subscription
invoices [Invoice] A list of invoices associated with the subscription
beneficiaries [Beneficiary] A list of beneficiaries associated with the subscription. Beneficiaries are used when the person is covered by the products and benefits, but does not have access to Sitata's mobile application or other digital platforms. If the person needs access to the mobile application or other digital aspects of Sitata, they must have a User account, which can be specified as a user during purchase. i.e. multiple users can be specified using multiple subscriptions at the tim of purchase (for no additional cost)
has_sitata_assistance Boolean True if the Subscription gives the User access to Sitata's assistance services, including our 24/7/365 emergency "easy chat" service.
has_flight_tracking Boolean True if the Subscription gives the User access to Sitata's flight tracking services.
has_alerts Boolean True if the Subscription gives the User access to Sitata's Travel Alert service.
has_consults Boolean True if the Subscription gives the User access to Sitata's telemedicine and teleconsult services.
product_quote ProductQuote The product quote associated with the Subscription
trip_cost integer The cost of the trip associated with the Subscription.
policy_urls [String] DEPRECATED. A list of policy wording urls for the Subscription.
product_documents [ProductDocument] Replaces policy_urls. A list of ProductDocuments that list important terms and conditions and other documentation associated with the products within the Subscription.
product_sale_group_id [String] The ProductSaleGroup identifier associated with the Subscriptions

Get Subscriptions

Returns Subscriptions associated with the organization. The response is paginated.

path Parameters
company_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Subscriptions

Create one or more subscriptions for one or more end users. A subscription can contain one or more Products.

path Parameters
company_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39

company identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
currency_code
string

Required. Three character currency code for the purchase.

country_code
string

Required. Two character country code of purchase origin.

subscriptions
array

Required. The list of subscrptions that should be created when executing the purchase. A subscription should be created for each user that wants to access the Sitata mobile application. In most cases, only a single subscription with the purchaser listed as the 'User' is necessary and all other members of the Subscription can be listed as beneficiaries under the subscription.

start
integer

The unix time for the subscription start. This parameter can be omitted if specifying Trip details. See below.

finish
integer

The unix time for the subscription finish. This parameter can be omitted if specifying Trip details. See below.

trip
object

Optional. The Trip details which typically includes the list of destinations, start time, finish time, itinerary items, and total cost.

product_ids
array

Optional. A list of product identifiers to request for. You may use the human readable identifiers.

Responses

Request samples

Content type
application/json
{
  • "currency_code": "GBP",
  • "country_code": "HK",
  • "metadata": {
    },
  • "subscriptions": [
    ],
  • "trip": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Subscription

Gets a subscription associated with the organization

path Parameters
company_id
required
string
Example: {{company_id}}
id
required
string
Example: ce07157f-e707-4fef-befa-81ac3598ba1f
header Parameters
Authorization
string
Example: TKN {{company_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": "ce07157f-e707-4fef-befa-81ac3598ba1f",
  • "last_renewal_attempt": null,
  • "invoices": [ ],
  • "user": {},
  • "product_quote": null,
  • "updated_at": "2023-03-21T01:41:16.770402Z",
  • "created_at": "2023-03-21T01:41:16.389806Z",
  • "policy_urls": [],
  • "human_id": "459730",
  • "language": "en",
  • "finish": "2023-11-30T04:59:59.000000Z",
  • "beneficiaries": [
    ],
  • "has_sitata_assistance": false,
  • "has_consults": false,
  • "user_id": "1c27fcab-857c-4b51-8fe8-c652796a87fe",
  • "finish_date": "2023-11-30",
  • "charge_id": "d0f301dc-d1da-482e-86e6-3f90c6f21e51",
  • "country_code": "US",
  • "region_code": null,
  • "start_date": "2023-11-21",
  • "company_id": "06825895-bfcb-4c8f-bb4a-723944a46a23",
  • "has_flight_tracking": false,
  • "has_alerts": false,
  • "email": "email01@gmail-test9238.com",
  • "metadata": null,
  • "coupon": null,
  • "start": "2023-11-21T05:00:00.000000Z",
  • "refund_charge": null,
  • "third_party_policy_num": null,
  • "currency_code": "USD",
  • "product_sale_group_id": "00bfc547-79ac-471a-8cbb-7fa027fa58e3",
  • "product_documents": [
    ],
  • "name": "Jimmy Bean",
  • "products": [
    ],
  • "trip_cost": 100000
}

Close Subscription

Close a Subscription. Will process a refund if the associated products are within the refund window.

path Parameters
subscription_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39

subscription identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": "306e97ac-c568-45c3-8ace-340af251e23b",
  • "last_renewal_attempt": null,
  • "invoices": [
    ],
  • "user": {
    },
  • "product_quote": null,
  • "updated_at": "2023-02-25T13:48:19.742704Z",
  • "created_at": "2023-02-25T13:48:18.479136Z",
  • "policy_urls": [ ],
  • "human_id": "C92111",
  • "language": "en",
  • "finish": "2023-06-19T06:18:32.000000Z",
  • "beneficiaries": [
    ],
  • "has_sitata_assistance": false,
  • "has_consults": false,
  • "user_id": "f4c9dbd8-e610-408f-8dae-6b7ea87dec7d",
  • "finish_date": "2023-06-19",
  • "country_code": null,
  • "region_code": null,
  • "start_date": "2023-06-12",
  • "company_id": null,
  • "has_flight_tracking": false,
  • "has_alerts": false,
  • "email": "email01@gmail.com",
  • "metadata": null,
  • "coupon": null,
  • "start": "2023-06-12T06:18:32.000000Z",
  • "third_party_policy_num": "TC-DIR1009808",
  • "currency_code": "GBP",
  • "product_sale_group_id": "a2791ad9-83eb-48d4-af4f-c15c4fe61baa",
  • "product_documents": [ ],
  • "name": "Jimmy Bean",
  • "products": [
    ],
  • "trip_cost": 100000
}

Organization > Users

Keeps track of users that can access the Sitata platform.

User Attributes

Name Type Description
id String The id of the user
created_at String The time the record was created
updated_at String The time the record was updated
display_name String Name used to display to other users. Used mostly by responders.
first_name String First name
last_name String Last name
age Integer DEPRECATED
birthday Date Birthday of user
email String Email address of user
home_country String Two character code of country for the user. e.g. CA for Canada
phone_number String Phone number of user
language String Two character language code for the user. e.g. "es" for Spanish
timezone String DEPRECATED
timezone_identifier String Timezone identifier for the user
profile_pic Map Map of urls to the user's profile picture
username String Username chosen by the user for public display
points Integer Point total accumulated by user by participating in the platform

Private Attributes

These attributes are only shown for the user requesting them.

Name Type Description
authentication_token String Authentication token used to access Sitata
settings [UserSettings] Settings for the user. See below.
mailing_lists Map A map of activated mailing lists for the user
check_ins [CheckIn] A list of CheckIns belonging to the user
loc LastKnownLocation The last known location of the user. See Below.
roles [Role] A list of roles that the user has on the Sitata Platform. See below.
subscriptions [Subscription] A list of subscriptions that the user has.

Responder Attributes

These attributes are only shown for users that have a responder (doctor, dentist, etc) role.

Name Type Description
bio String Biography of the responder
languages_spoken [String] A list of two character codes of languages spoken by the responder. e.g. ["en", "fr", "es"]
doctor_settings DoctorSettings A map of settings for the responder. See Below.

User Settings

User settings describe settings for most users (travellers).

User Settings Attributes

Name Type Description
send_trip_alert_email Boolean True if user wants to receive emails about trip alerts
send_all_good_email Boolean True if user wants to receive emails when no alerts found
send_trip_alert_push Boolean True if user wants to receive a push notification for trip alerts
send_all_good_push Boolean True if user wants to receive a push notification when no alerts found
check_in_with_location Boolean True if user wants to check in with their location
follow_after_comment_report Boolean True if user wants to follow community reports after leaving a comment
community_reward_email Boolean True if user wants to receive emails about rewards
community_reward_push Boolean True if user wants to receive a push notification about rewards
community_proximity_email Boolean True if user wants to receive emails when another nearby user reports
community_proximity_push Boolean True if user wants to receive a push notification when another nearby user reports

Doctor Settings

Doctor settings describe settings for responders.

Doctor Settings Attributes

Name Type Description
id String The id of the user
created_at String The time the record was created
updated_at String The time the record was updated
clinic_appt_cost Integer Cost of a clinic appointment in cents.
housecall_cost Integer Cost of a housecall appointment in cents.
telemed_consult_cost Integer Cost of a telemedicine appointment in cents.
istm_number String ISTM identifier for travel medicine doctors
clinic_address Address The clinic address string with lat/lng

Last Known Location

The user's last know location.

Last Known Location Attributes

Name Type Description
lat Double Latitude of the user's last known location
lng Double Longitude of the user's last known location
at Datetime Time of user's last known location
country_code String The two character country code of the user's last known location
acc Integer The accuracy of the user's last known location. Refer to CheckIn.
trip_id String The trip id associated with this user's last known location

Roles

A user can have one or more roles on the Sitata platform.

Name Type Description
id String id of the role
created_at String The time the record was created
updated_at String The time the record was updated
type Integer The role type (see below)
company Company A short form of the company including the id and name attributes.

Role Types

Value Description
0 Traveller
1 Employee
2 Branded Traveller
55 Medical Practitioner
57 Psychiatrist
59 Dentist
50 Clinical Admin
99 Organization Admin

Get Users

Returns Users for Company, filtered by parameters. Response is paginated.

Request Parameters

Name Type Description
company_id String The id of Company.
roles [Integer] An Array of Integers representing types of Roles.
name String Returns Users with similar names.
invited_users Boolean When true, will return a list of Users invited to Company. Default false.
invited_employees Boolean When true, will return a list of Users, employees, invited to Company. Default false.
path Parameters
company_id
required
string
Example: {{corp_company_id}}
query Parameters
roles
string
Example: roles=[1]
name
string
Example: name=Erlang
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: {{corp_company_auth}}

Responses

Response samples

Content type
application/json
[]

Get User

Gets User for Company given their ids.

Request Parameters

Name Type Description
company_id String The id of the Company.
user_id String The id of User.
path Parameters
company_id
required
string
Example: {{corp_company_id}}
user_id
required
string
Example: {{corp_user_id}}
header Parameters
Authorization
string
Example: {{corp_company_auth}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "authentication_token": "7affe88b-b551-42aa-9d61-69415e90c30f",
  • "bio": "Bio",
  • "birthday": null,
  • "check_ins": [
    ],
  • "display_name": null,
  • "doctor_settings": null,
  • "email": "traveller@traveller.com",
  • "first_name": "Ericson",
  • "home_country": null,
  • "home_location_lat": null,
  • "home_location_lng": null,
  • "id": "f118f42a-3b9e-479d-94c3-9ee18fa36e4a",
  • "intercom_android_hash": "BAC20C71CF83170EDE430E35645BCA3DD6316A99C0E2C086BF0FDEC52E5491CC",
  • "intercom_ios_hash": "34860885462734E4B7A9E28D011B83CFFC6D88A2122EB013AA545A90A64CE5E0",
  • "intercom_web_hash": "9BC819F4900F56E3686CFD85EE206FE00663A797CA774B865C9E5B6807D75B07",
  • "language": "en",
  • "languages_spoken": [
    ],
  • "last_name": "Erlang",
  • "loc": {
    },
  • "mailing_lists": { },
  • "phone_number": null,
  • "points": null,
  • "profile_pic": {},
  • "roles": [ ],
  • "settings": null,
  • "stripe_account_id": null,
  • "stripe_customer_id": "cus_ElWFjaPyYRiIIF",
  • "subscriptions": [ ],
  • "timezone": "America/Toronto",
  • "timezone_identifier": "Asia/Muscat",
  • "username": null
}

Update User

Updates User for Company given their ids.

Request Parameters

Name Type Description
company_id String The id of the Company.
user_id String The id of the User.

User Object Parameters

Expects these parameters to be wrapped in a key "user".

Name Type Description
bio String Biography.
display_name String Text to show when displaying.
first_name String First name.
last_name String Last name.
email String Email.
home_country String Home country.
phone_number String Phone number.
languages_spoken Array An Array of type String for which languages are spoken.
language String Primary language.
timezone String Timezone.
timezone_identifier Timezone identifier.
name String Name.
password String Password.
password_confirmation String Password confirmation.
profile_pic String Profile picture.
phone_number String Phone number.
path Parameters
company_id
required
string
user_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "authentication_token": "7affe88b-b551-42aa-9d61-69415e90c30f",
  • "bio": "Bio",
  • "birthday": null,
  • "check_ins": [
    ],
  • "display_name": null,
  • "doctor_settings": {
    },
  • "email": "traveller@traveller.com",
  • "first_name": "Ericson",
  • "home_country": null,
  • "home_location_lat": null,
  • "home_location_lng": null,
  • "id": "f118f42a-3b9e-479d-94c3-9ee18fa36e4a",
  • "intercom_android_hash": "BAC20C71CF83170EDE430E35645BCA3DD6316A99C0E2C086BF0FDEC52E5491CC",
  • "intercom_ios_hash": "34860885462734E4B7A9E28D011B83CFFC6D88A2122EB013AA545A90A64CE5E0",
  • "intercom_web_hash": "9BC819F4900F56E3686CFD85EE206FE00663A797CA774B865C9E5B6807D75B07",
  • "language": "en",
  • "languages_spoken": [
    ],
  • "last_name": "Erlang",
  • "loc": {
    },
  • "mailing_lists": { },
  • "phone_number": null,
  • "points": null,
  • "profile_pic": {},
  • "roles": [
    ],
  • "settings": null,
  • "stripe_account_id": null,
  • "stripe_customer_id": "cus_ElWFjaPyYRiIIF",
  • "subscriptions": [
    ],
  • "timezone": "America/Toronto",
  • "timezone_identifier": "Asia/Muscat",
  • "username": null
}

Delete User

Delete User.

Request Parameters

Name Type Description
company_id String The id of Company.
user_id String The id of User.
path Parameters
company_id
required
string
user_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{ }

Get Active Traveller Country Count

Returns a list of users who have had a recent checkin for a particular company.

path Parameters
company_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "AU": 1,
  • "EG": 1,
  • "HK": 1,
  • "IN": 1,
  • "SL": 1,
  • "TH": 1,
  • "US": 4
}

Get Active Travellers

Returns a list of users who have had a recent checkin for a particular company or have an active trip.

Request Parameters

Name Type Description
company_id String The id of the Company.
like String Will filter for similarity on first_name, last_name, or email.
country_codes String Comma separated country codes to restrict search to.
days_prior Integer Number of past days to search checkins.
path Parameters
company_id
required
string
query Parameters
like
string
Example: like=Mike

Will filter for similarity on first_name, last_name, or email

country_codes
string
Example: country_codes=VN,TZ

Comma separated country codes to restrict search to

days_prior
integer
Example: days_prior=8

Number of past days to search checkins

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
Example
Get Active Travellers - Name and Countries
Get Active Travellers - Name and Countries
Get Active Travellers - Name filter
[
  • {
    },
  • {
    }
]

Delete User Role

Removes Users role from Company.

Request Parameters

Name Type Description
company_id String The id of the Company.
role_type Integer The type of Role to remove from User.

Body Parameters

Name Type Description
users [String] An Array of Strings of User ids.
path Parameters
company_id
required
string
query Parameters
role_type
integer
Example: role_type=1
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "users": [
    ]
}

Response samples

Content type
application/json
[]

Create Invited Users

Invite Users to Company.

Request Parameters

Name Type Description
company_id String The id of the Company.
invited_users [Object] An Array of Invited User Objects. See Invited User table below for further details.

Invited User Parameters

Name Type Description
email String The email of the user being invited.
name String The name of the user being invited.
phone_number Strig The phone number of the user being invited.
role_type Integer The type of role the user will be given.
path Parameters
company_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "invited_users": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a Traveller

Create's a user with a traveller role within the organization.

If the user attributes given contains password (and password_confirmation), then the platform will set and enforce the password, otherwise it will not demand a password.

If send_confirmation_email is given, the platform will send an email to confirm with the user. If false, system will not send confirmation email and the email will be assumed to be valid (i.e. email_confirmed_at will be set).

Request Body Parameters

Name Type Description
user User The user's attributes.
send_confirmation_email Boolean When true, will send a confirmation email from Sitata to the user. Default is false.
path Parameters
company_id
required
string
Example: 5dea3b88-1f93-4393-85be-bfed5920c3b5

Your organization's ID

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "authentication_token": "657a8109-0a9e-41e4-a499-426477669325",
  • "bio": null,
  • "birthday": null,
  • "check_ins": [ ],
  • "display_name": null,
  • "doctor_settings": null,
  • "email": "jj@gmail-test123.com",
  • "first_name": "Jack",
  • "home_country": null,
  • "home_location_lat": null,
  • "home_location_lng": null,
  • "id": "88cd1588-501e-42cc-b4a4-6d78b6f6d115",
  • "intercom_android_hash": "7D08B66DBCA81F5DDB6CECF800677FE2B51C69238DA80AB6831449970604542B",
  • "intercom_ios_hash": "9FD241F4EC15D3858F3E2379523FCEEDDFE68CA92EEC87FAFBF760BFFA3DB541",
  • "intercom_web_hash": "EA0680F8117377C33BC6703F20C121302C827685AAD111B2900347AF0228AA49",
  • "language": "en",
  • "languages_spoken": null,
  • "last_name": "Johnson",
  • "loc": null,
  • "mailing_lists": { },
  • "phone_number": null,
  • "points": null,
  • "profile_pic": {},
  • "roles": [
    ],
  • "settings": null,
  • "stripe_account_id": null,
  • "stripe_customer_id": null,
  • "subscriptions": [ ],
  • "timezone": "UTC",
  • "timezone_identifier": null,
  • "username": null
}

Create Invite Users by CSV

Allows to invite users using a CSV file.

path Parameters
company_id
required
string
query Parameters
role_type
integer
Example: role_type=0
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Resend Invited User Invitations

Resend invitations for users invited by Company.

Request Parameters

Name Type Description
company_id String The id of the Company.

Body Parameters

Name Type Description
invited_users [InvitedUser] An Array of Invited Users ids.
path Parameters
company_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "invited_users": [
    ]
}

Response samples

Content type
application/json
{ }

Delete Invited Users

Deletes and cancels the invitaton process after inviting a new User to Company.

Request Parameters

Name Type Description
company_id String The id of Company.

Request Parameters

Name Type Description
invited_users [String] An Array of Strings of Invited User ids.
path Parameters
company_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{ }

Organization > ConferenceCalls

Get For Issue

Returns ConferenceCalls for a given issue at a particular Company.

path Parameters
company_id
required
string
Example: 91955970-34eb-4a1b-97e6-53e9084abbfa
issue_id
required
string
Example: 6ef62a37-d42c-43ae-ab6d-4340b866199d
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json

Responses

Get Conference Calls

Fetch conference calls for the organization.

path Parameters
company_id
required
string
Example: 91955970-34eb-4a1b-97e6-53e9084abbfa
query Parameters
all
boolean
Example: all=true
per-page
integer
Example: per-page=2
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Accept
string
Example: application/json
Content-Type
string
Example: application/json

Responses

Organization > Webhook Endpoints

Webhook Endpoints allow your organization to receive notifications and events from Sitata. Sitata will send a POST request to the url you specify during certain events. It is expected that your server will respond with a 200 status code. If that response is not received, Sitata will attempt to repeat sending the webhook event using exponential backoff. At any time, you may query the list of WebhookEvent's to cancel the process or for a full history of events.

Webhook Endpoint Attributes

Name Type Description
id String The id of the webhook endpoint.
created_at String The time the record was created.
updated_at String The time the record was updated.
enabled Boolean If set to false, the webhook will not be processed.
enabled_events [Integer] If set, only certain events will be processed. If empty or null, webhook will send all events.
signing_secret String Secret key for header signature.
url String Endpoint that data will be sent to.
company_id String Company identifier that webhook endpoint belongs to.

Request Body

When webhook events are sent to your organization. Each will contain a event type and payload field. Each event type follows the Sitata Notification types.

Request Body Attributes

Name Type Description
event Integer The type of event that has occurred.
payload Map The data payload for the event.

Signatures

Sitata sends a Sitata-Signature header in each communication which conatins a timestamp and one or more signatures. This allows your organization to confirm the validity of the communication and its payload. The timestamp is prefixed by t=, and each signature is prefixed by a version scheme. Version schemes start with v, followed by an integer. Currently, the only valid live signature scheme is v1.

The header will look something like:

Sitata-Signature: t=1492774577,v1=ABC123

Sitata's signature is generated using HMAC with SHA-256. The header is signed with the signing_secret of each WebhookEndpoint. You can verify the signature by performing the following steps:

1. Timestamp and signature extraction

Split the header, using the , character as the separator, to get a list of elements. Then split each element, using the = character as the separator, to get a prefix and value pair. The value for the prefix t corresponds to the timestamp, and the value for v1 corresponds to the signature. You can discard all other elements.

2 Prepare the signed payload for comparison

The signed payload is a string which is created by concatenating:

  • The timestamp as a string
  • The character .
  • The raw request body

3 Determine the expected signature and compare

Compute an HMAC with SHA256 hash. Use the Webhook Endpoint's signing_secret as the key and the signed payload from step #2 as the message. Compare the signature value in the header to the expected signature. For additional security, you can compute the difference between the current timestamp and the received time and decide if the difference is within your tolerance. To protect against timing attacks, use a constant-time string comparison to compare the expected signature to the received signature.

Get Webhook Endpoints

Returns Webhook Endpoints for the desired Company. The response is paginated.

path Parameters
company_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39

company identifier

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Webhook Endpoint

Create a new Webhook Endpoint for the desired Company.

Body Parameters

Parameters should be sent to the server wrapped in a key named webhook_endpoint.

Name Type Description
enabled_events [Integer] An array of integers representing the type of events to listen for. Leave empty to listen to all events.
enabled Boolean When false, webhook endpoint will not be active.
url String The full url that is receiving the data. e.g. https://www.abc.co/webhooks/sitata
path Parameters
company_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39

company identifier

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "company_id": "a73fa383-c467-4db2-9cfc-a8f7c4a80b39",
  • "created_at": "2020-05-21T00:50:57.713445Z",
  • "enabled": false,
  • "enabled_events": [
    ],
  • "id": "494cdd02-a638-44bb-a2d7-7d97e6ff2ef5",
  • "signing_secret": "572b1f7c-7928-432a-bba7-8c26d47abdb1",
  • "updated_at": "2020-05-21T00:50:57.713445Z",
  • "url": "https://www.abc.co/webhook/sitata"
}

Get Webhook Endpoint

Returns a Webhook Endpoint for the desired Company.

path Parameters
company_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39

company identifier

id
required
string
Example: 494cdd02-a638-44bb-a2d7-7d97e6ff2ef5

webhook endpoint identifier

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{
  • "company_id": "a73fa383-c467-4db2-9cfc-a8f7c4a80b39",
  • "created_at": "2020-05-21T00:50:57.713445Z",
  • "enabled": true,
  • "enabled_events": [ ],
  • "id": "494cdd02-a638-44bb-a2d7-7d97e6ff2ef5",
  • "signing_secret": "572b1f7c-7928-432a-bba7-8c26d47abdb1",
  • "updated_at": "2020-05-21T01:12:35.147621Z",
  • "url": "https://www.abc.co/webhook/sitata"
}

Delete Webhook Endpoint

Delete a Webhook Endpoint.

path Parameters
company_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39

company identifier

id
required
string
Example: 3e1380f3-0a2b-40b5-8fed-b48d05214ed7

webhook endpoint identifier

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{ }

Update Webhook Endpoint

Create a new Webhook Endpoint for the desired Company.

Body Parameters

Parameters should be sent to the server wrapped in a key named webhook_endpoint.

Name Type Description
enabled_events [Integer] An array of integers representing the type of events to listen for. Leave empty to listen to all events.
enabled Boolean When false, webhook endpoint will not be active.
url String The full url that is receiving the data. e.g. https://www.abc.co/webhooks/sitata
path Parameters
company_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39

company identifier

id
required
string
Example: 494cdd02-a638-44bb-a2d7-7d97e6ff2ef5

webhook identifier

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "company_id": "a73fa383-c467-4db2-9cfc-a8f7c4a80b39",
  • "created_at": "2020-05-21T00:50:57.713445Z",
  • "enabled": true,
  • "enabled_events": [ ],
  • "id": "494cdd02-a638-44bb-a2d7-7d97e6ff2ef5",
  • "signing_secret": "572b1f7c-7928-432a-bba7-8c26d47abdb1",
  • "updated_at": "2020-05-21T01:12:35.147621Z",
  • "url": "https://www.abc.co/webhook/sitata"
}

Organization > Webhook Events

Webhook events keep a record of events sent to your organization through webhook endpoints.

Webhook Event Types

When a Webhook Event is sent to your Webhook Endpoint, it will contain a data payload of extra information. Each Webhook Event has the following structure:

Attribute Type Description
id String identifier of the webhook event
created_at DateTime the time the webhook event was created
updated_at DateTime the time the webhook event was last updated
payload Object The data payload containing extra associated information. See below.
last_response Object The last response your servers replied to Sitata
last_response_stats Integer The last status response value your servers provided
next_attempt_at DateTime the time our system will attempt to re-send the event
completed Boolean true if no more send attempts are planned
attempt_count Integer the number of times Sitata has attempted to send the event
company_id String your company identifier
webhook_endpoint_id String the identifier of the webhook endpoint this event was generated for

New Alert

This event is sent when an alert has been created or updated. Your organization must have Sitata's Advanced Travel Intelligence package to receive these events.

The data payload is as follows:

Attribute Type Description
event Integer The value is 109
alert Object The full alert details. See Trip Alert section.

New Trip Alert Set

This event is sent when a set of your users have been affected by a particular event. Sitata determines which users are affected based on their trip itinerary details. A list of affected trips is also provided. For convenience, if you have saved your own user identifiers to the User record, then this list is provided as well.

The data payload is as follows:

Attribute Type Description
event Integer The value is 110
user_ids Array[String] List of Sitata user identifiers
trip_ids Array[String] List of Sitata trip identifiers
external_ids Array[String] List of third party user identifiers
alert Object The full alert details. See Trip Alert section.

Travel Restriction

Sent when an Travel Restriction is created or updated.

The data payload is as follows:

Attribute Type Description
event Integer The value is 120
entry_requirement Object The Travel Restriction details

Entry Requirement

Sent when an Entry Requirement is created or updated.

The data payload is as follows:

Attribute Type Description
event Integer The value is 121
entry_requirement Object The Entry Requirement details

Updated User

Sent when a user has been updated.

The data payload is as follows:

Attribute Type Description
event Integer The value is 504
user Object The user details. See User section.

Updated User Settings

Sent when a user has updated their settings.

The data payload is as follows:

Attribute Type Description
event Integer The value is 505
user_settings Object The user settings details.

Deleted User

Sent when a user has been deleted.

The data payload is as follows:

Attribute Type Description
event Integer The value is 506
user Object The user details. See User section.

Get Webhook Events

Returns Webhook Eventss for the desired Company. The response is paginated.

path Parameters
company_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Complete Webhook Event

Will set the WebhookEvent's completed field to true. When set to true, the webhook event will no longer be processed in the future if retries are necessary.

path Parameters
company_id
required
string
Example: a73fa383-c467-4db2-9cfc-a8f7c4a80b39

company identifier

id
required
string
Example: 421df908-8728-4aea-851f-26a3553b1713

webhook event identifier

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{
  • "attempt_count": 5,
  • "company_id": "a73fa383-c467-4db2-9cfc-a8f7c4a80b39",
  • "completed": true,
  • "created_at": "2020-05-22T03:08:23.529794Z",
  • "id": "421df908-8728-4aea-851f-26a3553b1713",
  • "last_response": {
    },
  • "last_response_status": 400,
  • "locked": false,
  • "next_attempt_at": "2020-05-22T03:16:23.528770Z",
  • "payload": {
    },
  • "updated_at": "2020-05-22T14:51:22.327830Z",
  • "webhook_endpoint_id": null
}

Privacy Zones

Privacy zones allow sensitive geographical regions to remain private. For example, users can create a privacy zone around their home dwelling and within this region, check-in activity will not occur. Privacy zones require location and distance values.

Privacy Zone Attributes

Name Type Description
id String The id of the privacy zone
created_at String The time the record was created
updated_at String The time the record was updated
lat Double The latitude of the zone
lng Double The longitude of the zone
distance Integer The distance of the zone in meters. Must be greater than or equal to 1000 and less than or equal to 25000
name String A user generated name for the zone. Must be less than 240 characters.

Get Privacy Zones

Get Privacy Zones for User

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Privacy Zone

Create Privacy Zone for User

Privacy Zone Object Attributes

Name Type Description
distance Integer Radius of the Privacy Zone in meters.
lat Double Latitude of Privacy Zone.
lng Double Longitude of Privacy Zone.
name String Name given to this Privacy Zone.
header Parameters
Accept
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "privacy_zone": {
    }
}

Response samples

Content type
application/json
{
  • "user_id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "user": {
    },
  • "updated_at": "2019-05-24T19:27:44.753756Z",
  • "lng": -79.98266910839081,
  • "lat": 42.98097274831085,
  • "id": "96161480-ca69-4eac-abe6-167780c2837b",
  • "distance": 10000,
  • "created_at": "2019-05-24T19:27:44.753743Z"
}

Update Privacy Zone

Update Privacy Zone for given id.

Request Body Attributes

Name Type Description
distance Integer Radius of the Privacy Zone in meters.
lat Double Latitude of Privacy Zone.
lng Double Longitude of Privacy Zone.
name String Name given to this Privacy Zone.
path Parameters
privacy_zone_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "privacy_zone": {
    }
}

Response samples

Content type
application/json
{
  • "user_id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "user": null,
  • "updated_at": "2019-05-24T18:12:06.900754Z",
  • "lng": -80.498642,
  • "lat": 43.451291,
  • "id": "7f46dfdf-eb82-412f-9641-481a37ab6955",
  • "distance": 13500,
  • "created_at": "2019-05-24T18:10:59.012865Z"
}

Delete Privacy Zone

Delete privacy zone

path Parameters
privacy_zone_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{
  • "user_id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "user": null,
  • "updated_at": "2019-05-24T18:46:54.141604Z",
  • "lng": -80.498642,
  • "lat": 43.451291,
  • "id": "1c7fb44f-d93c-42ff-a146-25d2eb03135b",
  • "distance": 10000,
  • "created_at": "2019-05-24T18:46:54.141592Z"
}

Product

Products are the different travel assistance and insurance plans available for sale. Each product contains one or more Benefits.

Product Attributes

Name Type Description
id String The id of the message
created_at String The time the record was created
updated_at String The time the record was updated
name String The name of the product
description String A description of the product for display in markdown format
sibling_name String If the product belongs to a sibling group, this is a common name to use for display of all the sibling products.
sibling_description String If the product belongs to a sibling group, this is a common description to use for display of all the sibling products.
disclaimer String This is a disclaimer description that must be presented along with the product
sort_order Integer This is the sort order of products. Products should be displyed in ascending order.
policy_url String This is a URL to policy wording if the product does not have Product Documents. This field is deprecated in favour of Product Documents.
preselected Boolean When true, Sitata recommends preselecting the product when displaying for purchase.
product_documents [ProductDocument] A list of product documents that are presented to purchasers and available for download. e.g. Policy wordings, terms of business, etc.
identifier String A human readable product identifier.
discontinued Boolean If true, the product is no longer available.
refund_window Integer Refund window defines how many days after puchase the product is available for a refund.
benefits [Benefit] A list of product Benefits.
max_age Intger The maximum age of a customer that can purchase this product (inclusive at time of purchase)
max_trip_length Integer For travel insurnce, the maximum amount of coverage in days which the product will provide.
product_type Integer The type of product. See below.
layout_type Integer Specifies how the product should be displayed. See below.
faqs [ProductFaq] A list of frequently asked questions for the product.
tiered_products [Product] Specifies the list of tiered products related to the current product.
tiered_product_ids [String] Specifies the list of tiered product identifiers related to the current product.
upgrade_products [Product] A list of upgradeable / bundled products related to the current product.
upgrade_product_ids [String] A list of upgradeable / bundled product identifiers related to the current product.
upgrade_siblings [Product] A list of product siblings related to the current product.
upgrade_sibling_ids [String] A list of product sibling identifiers related to the current product.
countries [Country] A list of countries where the product is available.
country_ids [String] A list of country ids where the product is available.
restricted_destination_countries [Country] A list of countries where the product is specifically not available.
restricted_destination_country_ids [String] A list of country ids where the product is specifically not available.

Product Types

Value Description
0 International travel
1 Domestic travel
2 Health

Layout Types

Value Description
0 Tiered
1 Bundled
2 Single

Product Benefit

Benefits describe the benefits and coverage limits of a Product.

Product Benefit Attributes

Name Type Description
id String The id of the benefit
created_at String The time the record was created
updated_at String The time the record was updated
name String The name of the benefit
description String A description of the benefit in markdown format
exclusions String A description of the benefit's exclusions in markdown format. Often empty. IMPORTANT: An empty value does NOT mean the product has no exclusions.
identifier String A human readable identifier of the benefit
sort_order Integer Specifies the order in which to display the benefits. Benefits should be displayed in ascending order.
prominent Boolean When true, it is highly recommended that the benefit be displayed to customers.
limit BenefitLimit Specifies the limits of the benefit. See below.
excess BenefitExcess Specifies the excess associated with the benefit (or Deductible). See below.

Benefit Limit Attributes

Name Type Description
id String The id of the benefit limit
currency_code String The currency used when describing the benefit limit.
cost_modifier Double The multiplying factor to convert the limit into a reasonable unit for display. e.g. 2180 * 0.01 = 21.80 GBP
cost_symbol String A character used to display the type of currency used. e.g. "£" for GBP.
limit Integer Limit is the maximum coverage amount in the smallest monetary unit. e.g. pence for GBP
benefit_id String The id of the benefit that the limit belongs to.

Benefit Excess (or Deductible) Attributes

Name Type Description
id String The id of the benefit excess
currency_code String The currency used when describing the benefit excess.
cost_modifier Double The multiplying factor to convert the excess into a reasonable unit for display. e.g. 2180 * 0.01 = 21.80 GBP
cost_symbol String A character used to display the type of currency used. e.g. "£" for GBP.
amount Integer Amount is the amount of excess associated with the benefit in the smallest monetary unit. e.g. pence for GBP
type Integer The Benefit Excess type. See below.
benefit_id String The id of the benefit that the limit belongs to.

Benefit Excess (or Deductible) Types

Type Description
0 The benefit "excess" is truly an excess.
1 The benefit "excess" is actually a "deductible."

Product Document

Product Documents are necessary documents to present to a User before or after a purchase. For example, a product document could be the Policy Wording of a travel protection plan. There may be multiple product documents for a single product and across multiple different languages.

Product Document Attributes

Name Type Description
id String The id of the message
created_at String The time the record was created
updated_at String The time the record was updated
name String The name of the document
identifier String A human readable identifier for the document
group_ident String If there more than one version of the document (e.g. english and french), this identifier will be common among them.
type Integer The type of product document. See below.
language String The language of the document.
url String If the document is hosted external to Sitata, this value will be the url for it.
sort_order Integer The order to display the document. Product documents should be sorted in ascending order.
file Object A list of urls for the uploaded document.
countries [Country] A list of countries that the document is meant for. If empty, the document applies to all countries.
country_ids [String] A list of country ids that the document is meant for. If empty, the document applies to all countries.
country_divisions [CountryDivision] A list of country divisions that the document is meant for. If empty, the document applies to all divisions.
country_division_ids [String] A list of country division ids that the document is meant for. If empty, the document applies to all divisions.
product_id String The identifier of the product which the document is related to.

Product Document Types

Type Description
0 Policy wording
1 Terms of business
2 Marketing Brochure
99 Other

Product FAQ

Product FAQs are frequently asked questions about a Product.

Product FAQ Attributes

Name Type Description
id String The id of the message
created_at String The time the record was created
updated_at String The time the record was updated
question String The question
answer String The answer to the question in markdown format
order Integer The order to display the question and answer. FAQs should be displayed in ascending order.
starred Boolean When true, it is recommended to prominently display the faq.
product_id String The id of the product the faq is assocaited with.

Product Quote

Product quotes list the pricing for a list of products based on a given set of parameters. Often a single product quote is generated for a single product; however, it is possible to generate a singl product quote for multiple products.

Product Quote Attributes

Name Type Description
id String The id of the message
created_at String The time the record was created
updated_at String The time the record was updated
product_ids [String] A list of product ids that the quote is associated with.
products [Product] A list of products that the quote is associated with.
start String The start date that was used when requesting a quote.
finish String The finish date that was used when requesting a quote.
cost Integer The price of the product(s) in the lowest denomination of currency. e.g. pence for GBP.
taxes Integer The taxes of the product(s) in the lowest denomination of currency. e.g. pence for GBP.
insurance_taxes Integer The insurance taxes of the product(s) in the lowest denomination of currency. e.g. pence for GBP.
currency_code String The currency used when generating the quote.
cost_modifier Double The multiplying factor to convert the excess into a reasonable unit for display. e.g. 2180 * 0.01 = 21.80 GBP
cost_symbol String The currency symbol
num_subscriptions Integer The number of subscriptions that would be created for this quote.
num_people Integer The total number of people (users + beneficiaries) that would benefit from purchasing this quote.
product_quote_group_id String When listing multiple products and multiple quotes, they are grouped together using a Product Quote Group. This is the identifier for that group.
splits [Product Quote Split] This is a list of revenue splits between companies for the product quote.

Safety Categories

SafetyCategory allows Sitata to associate one or more safety categories with an Alert.

Get Safety Categories

Returns a list of safety categories.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Tokens

This endpoint allows a consumer to create a variety of tokens for interaction with the Sitata API.

Create Socket Token

Creates a token for use with Sitata's socket channels.

Body Parameters

Name Type Description
for_socket Boolean When set to true, will create a token for Sitata's socket channels
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
""

Response samples

Content type
application/json
{
  • "token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAAkZTEzNzZkYzctZjJkMy00YjViLTlhNTQtMzE3YmI5MGFhZGFmZAAGc2lnbmVkbgYAjlsn4mUB.jyedlQuzMlkePTTmXER-ZpBeCwfYDc6iQZioY46wgas"
}

Send Login Token

Sends an email to the given email address containing a universal or deep-link which allows a mobile client to automatically log in.

Body Parameters

Name Type Description
email string Email address to send token email to.
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "email": "max-well77@gmail.com"
}

Response samples

Content type
application/json
[ ]

Verify Login Token

Given a valid login token, will reply with the corresponding user's profile details, allowing them to subsequently login using the user's authentication_token.

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "token": "{{token}}"
}

Response samples

Content type
application/json
{
  • "username": "max-well123",
  • "timezone_identifier": "Europe/London",
  • "timezone": "UTC",
  • "settings": null,
  • "roles": [ ],
  • "profile_pic": null,
  • "points": 360,
  • "phone_number": "15196356330",
  • "mailing_lists": {
    },
  • "loc": null,
  • "last_name": "Well",
  • "language": "en",
  • "id": "e1376dc7-f2d3-4b5b-9a54-317bb90aadaf",
  • "home_country": "CA",
  • "first_name": "Max",
  • "email": "max-well77@gmail.com",
  • "display_name": "Max",
  • "check_ins": [ ],
  • "authentication_token": "VXNlcnw0ZmRhasdflaskdfj238923alsdkfjlpBSDJ4MXp2a2dxdjkzczRYcW8=",
  • "age": null
}

Check Coupon Token

Given a valid coupon token, will reply with the full coupon's details for UI display and coupon redemption.

header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "token": "{{token}}"
}

Response samples

Content type
application/json
{
  • "updated_at": "2019-06-24T17:24:20.686999Z",
  • "times_redeemed": 7,
  • "redeem_before": "2020-01-10T17:24:20.685603Z",
  • "percent_off": "50",
  • "max_redemptions": 99,
  • "id": "00069403-5048-419f-b9a6-4d8aac74b046",
  • "human_id": "50off",
  • "duration": 0,
  • "description": "50% off",
  • "created_at": "2019-06-24T17:24:20.686989Z"
}

Travel Monitor

Allow travellers to save settings such that their family or company employees can monitor their trip and be updated when certain events happen.

Travel Monitor Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
name String The name of the person who is the Travel Monitor
email String The email where notifications will be sent to when traveller action is triggered
on_accommodation Integer Frequency of notifications when traveller reaches an accommodation
on_airport_landed Integer Frequency of notifications when traveller flight has landed
on_flight_delayed Integer Frequency of notifications when traveller flight is delayed
on_flight_cancelled Integer Frequency of notifications when traveller flight is cancelled
on_check_in_request Integer Frequency of notifications when traveller reports their safety status
on_trip_alert Integer Frequency of notifications when traveller receives a Trip Alert
on_itinerary_change Integer Frequency of notifications when traveller itinerary changes
company_name String The name of Company
user_id String The User, traveller, who will be informing this Travel Monitor
company_id String The Company who will be informed of this travellers actions

Types

Value Description Extra Data
0 Off
1 First Time Sends notification when action happens for the first time.
2 Always Sends notification everytime when action happens.

Get Travel Monitors

Returns all travel monitors for User.

header Parameters
Accept
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Travel Monitor

Creates a Travel Monitor for User.

Travel Monitor Object Attributes

Name Type Description
name String Given name for Travel Monitor.
email String Email for Travel Monitor.
on_accommodation Integer Frequency of notifications when this action is triggered.
on_check_in_request Integer Frequency of notifications when this action is triggered.
on_airport_landed Integer Frequency of notifications when this action is triggered.
on_flight_cancelled Integer Frequency of notifications when this action is triggered.
on_flight_delayed Integer Frequency of notifications when this action is triggered.
on_trip_alert Integer Frequency of notifications when this action is triggered.
on_itinerary_change Integer Frequency of notifications when this action is triggered.
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "travel_monitor": {
    }
}

Response samples

Content type
application/json
{
  • "user_id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "user": {
    },
  • "updated_at": "2019-05-27T18:20:11.515533Z",
  • "on_flight_delayed": 2,
  • "on_flight_cancelled": 2,
  • "on_airport_landed": 2,
  • "on_accommodation": 2,
  • "name": "daughter",
  • "invite_sent_at": null,
  • "id": "1fe122f8-7201-4a82-bd24-e13db1a24499",
  • "email_confirmed_at": null,
  • "email": "responder@responder.com",
  • "created_at": "2019-05-27T18:20:11.515516Z",
  • "company_name": null,
  • "company_id": null,
  • "company": null
}

Update Travel Monitor

Update Travel Monitor by given id.

Request Parameters

Name Type Description
travel_monitor_id String The id of the Travel Monitor to update.

Travel Monitor Object Attributes

Name Type Description
name String Given name for Travel Monitor.
email String Email for Travel Monitor.
on_accommodation Integer Frequency of notifications when this action is triggered.
on_check_in_request Integer Frequency of notifications when this action is triggered.
on_airport_landed Integer Frequency of notifications when this action is triggered.
on_flight_cancelled Integer Frequency of notifications when this action is triggered.
on_flight_delayed Integer Frequency of notifications when this action is triggered.
on_trip_alert Integer Frequency of notifications when this action is triggered.
on_itinerary_change Integer Frequency of notifications when this action is triggered.
path Parameters
travel_monitor_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "travel_monitor": {
    }
}

Response samples

Content type
application/json
{
  • "user_id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "user": {
    },
  • "updated_at": "2019-05-27T18:57:44.908399Z",
  • "on_flight_delayed": 2,
  • "on_flight_cancelled": 2,
  • "on_airport_landed": 2,
  • "on_accommodation": 0,
  • "name": "Sam",
  • "invite_sent_at": null,
  • "id": "1fe122f8-7201-4a82-bd24-e13db1a24499",
  • "email_confirmed_at": null,
  • "email": "responder@responder.com",
  • "created_at": "2019-05-27T18:20:11.515516Z",
  • "company_name": null,
  • "company_id": null,
  • "company": null
}

Delete Travel Monitor

Delete Travel Monitor by given id.

Request Parameters

Name Type Description
travel_monitor_id String The id of the Travel Monitor to delete.
path Parameters
travel_monitor_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{
  • "user_id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "user": {
    },
  • "updated_at": "2019-05-27T18:57:44.908399Z",
  • "on_flight_delayed": 2,
  • "on_flight_cancelled": 2,
  • "on_airport_landed": 2,
  • "on_accommodation": 0,
  • "name": "Sam",
  • "invite_sent_at": null,
  • "id": "1fe122f8-7201-4a82-bd24-e13db1a24499",
  • "email_confirmed_at": null,
  • "email": "responder@responder.com",
  • "created_at": "2019-05-27T18:20:11.515516Z",
  • "company_name": null,
  • "company_id": null,
  • "company": null
}

Resend Travel Monitor Invitation

Resend invitation for Travel Monitor by given id.

Request Parameters

Name Type Description
travel_monitor_id String The id of the Travel Monitor to resend the invitation to.
path Parameters
travel_monitor_id
required
string
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{
  • "company_id": null,
  • "company_name": null,
  • "created_at": "2019-11-08T18:43:22Z",
  • "email": "memeber@sitata.com",
  • "email_confirmed_at": null,
  • "id": "c00f380f-b203-4168-ade8-48205265b38e",
  • "invite_sent_at": "2019-11-08T18:47:04Z",
  • "name": "Jerry Lopeu",
  • "on_accommodation": 1,
  • "on_airport_landed": 2,
  • "on_check_in_request": 2,
  • "on_flight_cancelled": 2,
  • "on_flight_delayed": 1,
  • "on_itinerary_change": 2,
  • "on_trip_alert": 2,
  • "updated_at": "2019-11-08T18:47:04Z",
  • "user_id": "f118f42a-3b9e-479d-94c3-9ee18fa36e4a"
}

Travel Restrictions

Travel Restrictions are events that affect a person's ability to travel into or within a country or region. If affected_countries is empty, it should be interpreted as a global rule. i.e. all countries are affected.

Travel Restriction Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
effective_as_of String The time the record was last checked
type Integer The type of travel restriction (see below)
value Integer The value of the travel restriction.
start String The time the restriction will begin
finish String The time the restriction will end
closed Boolean True if restriction no longer applies
comment String A textual description of the restriction in markdown format
references [String] A list of URLs from which the restriction was information was collected
airline Airline The airline the restriction is associated to
airline_id String Identifier for the airline
disease Disease The disease the restriction is associated to
disease_id String Identifier for the disease
origin_country Country The country that is imposing the restriction
origin_country_id String The country identifier
affected_countries [Country] A list of countries that are affected by the restriction
affected_country_ids [String] A list of country ids that are affected by the restriction
affected_country_divisiosn [CountryDivision] A list of country divisions that are affected by the restriction
affected_country_division_ids [String] A list of country division ids that are affected by the restriction
affected_country_regions [CountryRegion] A list of country regions that are affected by the restriction
affected_country_region_ids [String] A list of country region ids that are affected by the restriction
categories Deprecated.

Type

Value Description
0 Airline
1 DEPRECATED - Border Closure or Change.
2 Curfew
3 Social Distancing
4 Transportation (usually internal)
99 Other
201 Recommended Border App
401 Non-essential shops open?
402 Accomodations open?
403 Restaurants open?
404 Bars and cafes open?
405 Beaches and tourism sites open?
406 Museums and heritage sites open?
407 Personal care services open? (e.g. nail salon, barber)
408 Places of worship open?
409 Events allowed?
410 Masks required in public?
  • Please note that Type 1 - Border Closure or Change has been deprecated in favour of the Entry Requirements data set. Please see the Entry Requirements section of this documentation.

Value

Value Description
-1 Unknown or Not Applicable
0 Minimal
1 Moderate
2 Significant
3 Total
10 Yes
11 Yes with exceptions
12 No
13 No with exceptions

Restriction levels will vary depending upon type. Below are a few scenarios to help with your understanding. Some types will have a level usch as "minimal" while other's are yes/no answers.

Airline Value Examples

Level Description
0 A single airline has cancelled or restricted some flights.
1 Multiple airlines have cancelled some routes with a limited number of countries or a single country. Some interior flights cancelled.
2 Flights to some countries have been cancelled by the majority of airlines. All interior flights have been suspended.
3 All air traffic has been suspended

Border Value Examples

Level Description
0 A single border crossing has been affected.
1 Multiple border crossings affected.
2 Traffic into or out of the country has been restricted severely and often limited to special circumstances. e.g. Only citizens may enter.
3 Traffic into or out of the country is not possible for the average person.

Curfew Value Examples

Level Description
0 Voluntary curfew. Self-imposed quarantine, etc.
1 Citizens may only leave their homes during certain hours of the day. Curfew implemented some days of the week. e.g. only 3 days per week.
2 Citizens may only leave their homes during certain hours of the day. Curfew implemented every day of the week.
3 Citizens are not allowed to leave their homes without permission.

Social Distancing Value Examples

Level Description
0 The government recommends, but measures are voluntary.
1 Large social gatherings are closed. Sports, public park closures. School closures are possible.
2 Small social gatherings are restricted. Distance between individuals mandated.
3 All but essential services are closed.

Transportation Value Examples

Level Description
0 The government recommends restricted travel.
1 Severely reduced public transportation. Checkpoints could be established along routes.
2 Transportation between states or provinces is no longer allowed.
3 All transportation services shut down. Private transportation limited or restricted entirely.

Get Travel Restrictions For Country

Returns all travel active restrictions for Country. Active restrictions are those that have not expired or those that have the closed attribute set to false. This response will include restrictions imposed by other countries. To understand what is happening solely within the country of interest, choose the restrictions by origin_country. If state-level data is available, the result set will include it. State-level data can be identified by entries that have a value for origin_country_division and origin_country_division_id.

path Parameters
country_id
required
string
Example: RU

Country code or country identifier

header Parameters
Accept
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Get Travel Restrictions

Returns a list of paginated travel restrictions.

Query parameters are all optional and are logically joined by AND conditions except when specifying airports.

When specifying airports, the api will return the restrictions for regions the airports are located within.

If state-level data is available, the result set will include it. State-level data can be identified by entries that have a value for origin_country_division and origin_country_division_id.

query Parameters
disease_id
string
Example: disease_id=abc123

Filter by disease identifier

affected_country_id
string
Example: affected_country_id=AR

Affected country identifier or country code

airline_id
string
Example: airline_id=abc123

Airline identifier

origin_country_id
string
Example: origin_country_id=AR

Origin country identifier or country code

active
integer
Example: active=1

Returns travel restrictions that are active when value is 1. If value is 0, will return travel restrictions that are not active (historical). Omit entirely to disregard start and finish dates.

types
integer
Example: types=405

A comma separated list of types

destination
string
Example: destination=IN

The country that created the requirement. Analagous to origin_country_id. Value expected is country code or country identifier. Should be used in conjunction with "departure."

nationality
string
Example: nationality=US

The country that is affected by the requirement. Analagous to affected_country_id. Value expected is country code or country identifier.

departure
string
Example: departure=DE

The country that is affected by the requirement. Analagous to affected_country_id. Value expected is country code or country identifier. Should be used in conjunction with "destination."

departure_airport
string
Example: departure_airport=AANY

Will returns the travel restrictions in place at the region of departure. Expects the iata or icao code for the airport at the point of departure.

destination_airport
string
Example: destination_airport=LKHO

Will return the travel restrictions in place at the destination region. Expects the iata or icao code for the arrival airport.

destination_lat
number
Example: destination_lat=15.9129

Destination latitude. Should be used in conjunction with other destination and departure coordinate parameters.

destination_lng
number
Example: destination_lng=79.7400

Destination longitude. Should be used in conjunction with other destination and departure coordinate parameters.

departure_lat
number
Example: departure_lat=43.6532

Departure latitude. Should be used in conjunction with other destination and departure coordinate parameters.

departure_lng
number
Example: departure_lng=79.3832

Destination longitude. Should be used in conjunction with other destination and departure coordinate parameters.

header Parameters
Accept
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Trips

A trip keeps information about a user's past, active, and future trips. A trip has destinations and can manage a user's itinerary/bookings through TripSegments.

Trip Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
deleted_at String The time the record was deleted
name String The name of the trip
start Datetime The time that the trip starts
finish Datetime The time that the trip finishes
read Boolean True if the user has read the trip details
muted Boolean True if the user no longer wants to receive notifications about the trip
trip_type Integer The type of trip (see below)
activities [Integer] A list of integers representing the activities for the trip (see below)
company_name String Name of company that the trip belongs to
employee_name String Name of the employee that the trip belongs to
final Boolean DEPRECATED
settings TripSetting Trip settings for the trip (see below)
destinations [Destination] A list of destinations for the trip (see below)
travellers [User] A list of users that own the trip
total_cost Integer The cost of the trip in lowest common currency value. e.g. cents for USD.

Trip Types

Value Description
0 Holiday
1 Business
2 Both
3 Other

Trip Activities

Value Description
0 Beach & Sun
1 Scuba Diving
2 Snorkeling
3 Hiking
4 Camping
5 Kayaking
6 Canoeing
7 Shopping
8 Site Seeing
9 Museums
10 Food
11 Eco Tourism
12 Bicycling
13 Backpacking
14 Golf
15 Rock Climbing
16 Skiing
17 Snowboarding
18 Photography
19 Safari
20 Around The World
21 Medical Tourism
22 Humanitarian Work
23 Gambling
24 Jungle Trekking
25 Cruise
26 Road Trip
27 Amusement Park
28 Concert

Trip Settings

A map of trip settings. Not yet defined.

Destinations

A trip can have one or more destinations.

Destination Attributes

Name Type Description
id String The id of the notification
entry_date Datetime The datetime that the user will enter the Destiantion
exit_date Datetime The datetime that the user will leave the Destiantion
country_id String The UUID of the country that this Destination belongs to
friendly_name String The name of the destination. e.g. Paris
lat Double The latitude of the Destination
lng Double The longitude of the Destination
type Integer The type of Destination (see below)

Destination Types

Value Description
0 Country
1 City
2 Region (e.g. State or Province or Municipality)

Trip Segments

A trip can also have 5 different types of trip segments or bookings: air, hotel, car, rail, and activity. Trip Segments allow a user to keep track of their itinerary for their trip. In the case of an AirSegment, they allow Sitata to monitor flights and airports for cancellations and delays. Segments are created by parsing emails.

Air Segment

Keeps track of plane tickets.

Air Segment Attributes

Name Type Description
id String The id of the air segment
created_at String The time the record was created
updated_at String The time the record was updated
airline String The name of the airline. e.g. Alaska Airlines
class_of_service String The type of service. e.g. Business
confirmation_no String The confirmation number. Usually the PNR. e.g. ABJ3D98
currency String The currencey code. e.g. USD
arrival_datetime Datetime The naive datetime of arrival. e.g. 2015-06-14T19:39:00
arrival_time_zone_id String The IATA timezone identifier for arrival
arrival_datetime_utc Datetime The UTC datetime of arrival
estimated_arrival Datetime The naive datetime for arrival when a flight has been delayed
estimated_arrival_utc Datetime The UTC datetime of arrival when a flight has been delayed
arrival_gate String The airport gate during arrival
arrival_terminal String The airport terminal during arrival
departure_datetime Datetime The naive datetime of departure. e.g. 2015-06-18T19:39:00
departure_time_zone_id String The IATA timezone identifier for departure
departure_datetime_utc Datetime The UTC datetime of departure. e.g. 2015-06-18T19:39:00
estimated_departure Datetime The naive datetime for departure when a flight has been delayed
estimated_departure_utc Datetime The UTC datetime of departure when a flight has been delayed
departure_gate String The airport gate during departure
departure_terminal String The airport terminal during departure
destination String The airport code of the destination. Usually IATA. e.g. PDX
destination_name String The airport name. e.g. Portland International
destination_admin_code String The region code of the destination airport. e.g. TX for Texas
destination_city_name String The city name of the destination airport. e.g. Portland
destination_country String The two character country code of the destination. e.g. CA for Canada
destination_lat Double The latitude of the destination airport
destination_lng Double The longitude of the deatinaion airport
origin String The airport code of the original. Usually IATA. e.g. PDX
origin_name String The airport name of the origin. e.g. Portland International
origin_admin_code String The region code of the origin airport. e.g. TX for Texas
origin_city_name String The city name of the origin airport. e.g. Portland
origin_country String The two character country code of the origin. e.g. CA for Canada
origin_lat Double The latitude of the origin airport
origin_lng Double The longitude of the origin airport
fare_basis_code String e.g. G
flight_number String Flight number e.g. 655
iata_code String IATA code of the airline. e.g. AS
normalized_airline String Airline code. e.g. ASA
number_of_pax Integer Number of passengers
price Decimal Parsed from dollars. e.g. $380.30
seat_assignment String e.g. 22D
source String Name of source. e.g. Trip Advisor
status Integer Status of the flight (see below)
ticket_number String e.g. 123456
tickets [String] A list of ticket numbers
seats [String] A list of seat numbers

Rail Segment

Keeps track of rail tickets.

Rail Segment Attributes

Name Type Description
id String The id of the rail segment
created_at String The time the record was created
updated_at String The time the record was updated
rail_line String The name of the railway. e.g. Amtrak
confirmation_no String The confirmation number. Usually the PNR. e.g. ABJ3D98
currency String The currencey code. e.g. USD
arrival_datetime Datetime The naive datetime of arrival. e.g. 2015-06-14T19:39:00
arrival_time_zone_id String The IATA timezone identifier for arrival
arrival_datetime_utc Datetime The UTC datetime of arrival
departure_datetime Datetime The naive datetime of departure. e.g. 2015-06-18T19:39:00
departure_time_zone_id String The IATA timezone identifier for departure
departure_datetime_utc Datetime The UTC datetime of departure. e.g. 2015-06-18T19:39:00
destination String The railway code of the destination. Usually IATA. e.g. PDX
destination_name String The destination rail station name.
destination_admin_code String The region code of the destination station. e.g. TX for Texas
destination_city_name String The city name of the destination station. e.g. Portland
destination_country String The two character country code of the destination. e.g. CA for Canada
destination_lat Double The latitude of the destination station
destination_lng Double The longitude of the deatinaion station
origin String The railway code of the original. Usually IATA. e.g. PDX
origin_name String The station name of the origin. e.g. Portland International
origin_admin_code String The region code of the origin station. e.g. TX for Texas
origin_city_name String The city name of the origin station. e.g. Portland
origin_country String The two character country code of the origin. e.g. CA for Canada
origin_lat Double The latitude of the origin station
origin_lng Double The longitude of the origin station
train_number String Train number e.g. 655
number_of_pax Integer Number of passengers
price Decimal Parsed from dollars. e.g. $380.30
seat_assignment String e.g. 22D
source String Name of source. e.g. Trip Advisor
status Integer Status of the train segment (see below)
ticket_number String e.g. 123456
tickets [String] A list of ticket numbers
seats [String] A list of seat numbers

Car Segment

Keeps track of car rentals.

Car Segment Attributes

Name Type Description
id String The id of the rail segment
created_at String The time the record was created
updated_at String The time the record was updated
car_company String Name of car company. e.g. Hertz
car_description String Description of car
car_type String Type of car. e.g. Intermediate 2
confirmation_no String Confirmation number
currency String The currencey code. e.g. USD
dropoff_address1 String Address line 1 of dropoff location
dropoff_address2 String Address line 2 of dropoff location
dropoff_admin_code String Region code of dropoff location
dropoff_city_name String City name of dropoff location
dropoff_country String Two character country code of dropoff location. e.g. CA for Canada
dropoff_lat Double Latitude of dropoff location
dropoff_lng Double Longitude of dropoff location
dropoff_postal_code String Postal code of dropoff location
dropoff_datetime Datetime Dropoff datetime. e.g. 2015-07-10T12:00:00
dropoff_time_zone_id String Timezone of dropoff location
dropoff_datetime_utc Datetime Dropoff UTC datetime
hours_of_operation String Hours of operation
normalized_car_company String Car company name. e.g. Hertz
pickup_address1 String Address line 1 of pickup location
pickup_address2 String Address line 2 of pickup location
pickup_admin_code String Region code of pickup location
pickup_city_name String City name of pickup location
pickup_country String Two character country code of pickup location. e.g. CA for Canada
pickup_datetime Datetime Pickup datetime. e.g. 2015-07-10T12:00:00
pickup_time_zone_id String Timezone of pickup location
pickup_datetime_utc Datetime Pickup UTC datetime
pickup_lat Double Latitude of pickup location
pickup_lng Double Longitude of pickup location
pickup_postal_code String Postal code of pickup location
price Decimal Parsed from dollars. e.g. $380.30
source String Name of source. e.g. Trip Advisor
status Integer Status of the car booking (see below)

Hotel Segment

Keeps track of hotel stays.

Hotel Segment Attributes

Name Type Description
id String The id of the rail segment
created_at String The time the record was created
updated_at String The time the record was updated
address1 String Address line 1 of hotel location
address2 String Address line 2 of hotel location
admin_code String Region code for the hotel location. e.g. TX for Texas
cancellation_policy String Cancellation policy
checkin_date Datetime Check-in datetime. e.g. 2015-03-06 15:00:00
checkout_date Datetime Check-out datetime. e.g. 2015-03-07 12:00:00
checkin_date_utc Datetime UTC datetime for check-in
checkout_date_utc Datetime UTC datetime for check-out
time_zone_id String Timezone identifier of the hotel location
city_name String City name of hotel location
confirmation_no String Confirmation number
country String Two character country code of pickup location. e.g. CA for Canada
currency String The currencey code. e.g. USD
hotel_name String The name of the hotel
lat Double Latitude of hotel location
lng Double Longitude of hotel location
number_of_rooms Integer Number of roooms
postal_code String Postal code of hotel location
rate_description String Rate description
room_description String Room description
room_type String Type of room
price Decimal Parsed from dollars. e.g. $380.30
source String Name of source. e.g. Trip Advisor
status Integer Status of the hotel booking (see below)

Activity Segment

Keeps track of activities such as concerts and other types of event tickets.

Activity Segment Attributes

Name Type Description
id String The id of the rail segment
created_at String The time the record was created
updated_at String The time the record was updated
activity_type String Activity type. e.g. General
activity_name String Activity name. e.g. Van Halen Concert
start_name String Name of start location. e.g. Park City Ampitheater
start_admin_code String Region code of start location. e.g. TX for Texas
start_address1 String Address line 1 of start location
start_address2 String Address line 2 of start location
start_city_name String City name of start location
start_country String Two character country code of start. e.g. CA for Canada
start_lat Double Latitude of start location
start_lng Double Longitude of start location
start_postal_code String Postal code of start location
end_name String Name of end location. e.g. Park City Ampitheater
end_admin_code String Region code of end location. e.g. TX for Texas
end_address1 String Address line 1 of end location
end_address2 String Address line 2 of end location
end_city_name String City name of end location
end_country String Two character country code of end. e.g. CA for Canada
end_lat Double Latitude of end location
end_lng Double Longitude of end location
end_postal_code String Postal code of end location
start_datetime Datetime Start time. e.g. 2015-03-06 15:00:00
end_datetime Datetime End time. e.g. 2015-03-07 03:00:00
start_datetime_utc Datetime Start UTC time
end_datetime_utc Datetime End UTC time
time_zone_id String Timezone identifier for the activity
confirmation_no String Confirmation number
currency String The currencey code. e.g. USD
price Decimal Parsed from dollars. e.g. $380.30
source String Name of source. e.g. Trip Advisor
status Integer Status of the hotel booking (see below)

Cruise Segment

Keeps track of cruise legs.

Cruise Segment Attributes

Name Type Description
id String The id of the cruise segment
created_at String The time the record was created
updated_at String The time the record was updated
cruise_line String The name of the cruise line. e.g. Norwegian Cruise
ship_name String The name of the ship. e.g. NORWEGIAN ESCAPE
confirmation_no String The confirmation number. Usually the PNR. e.g. ABJ3D98
currency String The currencey code. e.g. USD
arrival_datetime Datetime The naive datetime of arrival. e.g. 2015-06-14T19:39:00
arrival_time_zone_id String The IATA timezone identifier for arrival
arrival_datetime_utc Datetime The UTC datetime of arrival
departure_datetime Datetime The naive datetime of departure. e.g. 2015-06-18T19:39:00
departure_time_zone_id String The IATA timezone identifier for departure
departure_datetime_utc Datetime The UTC datetime of departure. e.g. 2015-06-18T19:39:00
destination String The airport code of the destination. Usually IATA. e.g. PDX
destination_name String The airport name. e.g. Portland International
destination_admin_code String The region code of the destination airport. e.g. TX for Texas
destination_city_name String The city name of the destination airport. e.g. Portland
destination_country String The two character country code of the destination. e.g. CA for Canada
destination_lat Double The latitude of the destination airport
destination_lng Double The longitude of the deatinaion airport
origin String The airport code of the original. Usually IATA. e.g. PDX
origin_name String The airport name of the origin. e.g. Portland International
origin_admin_code String The region code of the origin airport. e.g. TX for Texas
origin_city_name String The city name of the origin airport. e.g. Portland
origin_country String The two character country code of the origin. e.g. CA for Canada
origin_lat Double The latitude of the origin airport
origin_lng Double The longitude of the origin airport
number_of_pax Integer Number of passengers
price Decimal Parsed from dollars. e.g. $380.30
tickets [String] A list of ticket numbers
seats [String] A list of seat numbers
source String Name of source. e.g. Trip Advisor
status Integer Status of the flight (see below)

Trip Segment Status

Value Description
-1 unknown
0 active
1 past
2 deleted
3 delayed

Get Trips

Returns trips for the current user.

Request Parameters

Name Type Description
since String or Integer Datetime in unix seconds or ISO format. If given, will return trips updated since that time.
page Integer Page number of trips to request
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
Example
Get Trips
Get Trips
Get Trips Since
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Trip

Responds with a list of trips for the requested user. Typically requested by another user or company such as a travel manager. Response is paginated.

Request Parameters

Name Type Description
trip_id String The id of the Trip.
page Integer The page of trips to request.
path Parameters
trip_id
required
string
Example: f07a2591-7850-46a3-9980-9881f52e0076

The trip identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Delete Trip

Deletes a trip.

Request Parameters

Name Type Description
trip_id String Trip id.
path Parameters
trip_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

Edit Trip

Edit a trip for the current user. Partial edits for relationships are not accepted. Therefore, it is best to submit the full trip's attributes all at once.

Request Parameters

Name Type Description
trip_id String The id of the trip

Body Parameters

The request body should be wrapped in a parameter key named trip.

Name Type Description
name String The name of the trip
trip_type Integer The type of trip
start Datetime The date that the trip starts
finish Datetime The date that the trip finishes
activities [Integer] An integer based list of activity identifiers
destinations [Destination] A list of Destination objects
air_segments [AirSegment] A list of AirSegment objects
rail_segments [RailSegment] A list of RailSegment objects
car_segments [CarSegment] A list of CarSegment objects
hotel_segments [HotelSegment] A list of HotelSegment objects
activity_segments [ActivitySegment] A list of ActivitySegment objects
path Parameters
trip_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "trip": {
    }
}

Response samples

Content type
application/json
{
  • "updated_at": "2019-01-19T19:56:24.835202Z",
  • "trip_type": 2,
  • "travellers": [],
  • "start": "2019-02-01T11:55:00.000000Z",
  • "settings": null,
  • "read": false,
  • "name": "Testing edit trip",
  • "muted": false,
  • "id": "91fcd857-ef47-4710-89bd-1c1a3fd0ac26",
  • "finish": "2019-02-01T13:38:00.000000Z",
  • "final": true,
  • "employee_name": null,
  • "destinations": [
    ],
  • "deleted_at": "2019-01-18T02:20:11.443960Z",
  • "created_at": "2019-01-17T19:16:51.543608Z",
  • "company_name": null,
  • "activities": [
    ]
}

Get Trip Itinerary

Returns the itinerary trip segments for a given trip.

Parameters

Name Type Description
trip_id String The id of the trip
path Parameters
trip_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "rail_segments": [
    ],
  • "hotel_segments": [
    ],
  • "car_segments": [ ],
  • "air_segments": [
    ],
  • "activity_segments": [ ]
}

Get Trip Segment

Return a trip segment for the given trip segment id

Parameters

Name Type Description
id String The id of the trip segment
path Parameters
id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "updated_at": "2019-02-10T04:00:48.539859Z",
  • "id": "ec43ae24-cc77-4a83-8914-ea0122288954",
  • "destination_city_name": "Sydney",
  • "origin_lat": -37.8181,
  • "tickets": null,
  • "confirmation_no": "Abc123",
  • "origin_admin_code": "VIC",
  • "ticket_number": "2309230202",
  • "origin": "Mel ST",
  • "created_at": "2019-02-10T04:00:48.539850Z",
  • "origin_name": "Melbourne (Southern Cross) Station",
  • "destination_lat": -33.8827,
  • "arrival_time_zone_id": "Australia/Sydney",
  • "destination_country": "AU",
  • "destination": "Syd ST",
  • "seat_assignment": null,
  • "destination_admin_code": "MSW",
  • "departure_datetime": "2019-03-09T09:00:00.000000",
  • "destination_lng": 151.2066,
  • "price": "181.100",
  • "arrival_datetime_utc": "2019-03-09T09:30:00.000000Z",
  • "source": "NSW Transport",
  • "currency": "CAD",
  • "status": null,
  • "departure_datetime_utc": "2019-03-08T22:00:00.000000Z",
  • "seats": null,
  • "arrival_datetime": "2019-03-09T20:30:00.000000",
  • "number_of_pax": 1,
  • "train_number": "123",
  • "rail_line": null,
  • "origin_country": "AU",
  • "origin_lng": 144.9524,
  • "departure_time_zone_id": "Australia/Sydney",
  • "destination_name": "Sydney Central Station",
  • "origin_city_name": "Melbourne"
}

Delete Trip Segment

Removes a trip segment for a given trip.

Parameters

Name Type Description
trip_id String The id of the trip
id String The id of the trip segment
path Parameters
trip_id
required
string
id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

Create Trip

Create a trip for the current user.

Body Parameters

The request body should be wrapped in a parameter key named trip.

Name Type Description
name String The name of the trip
trip_type Integer The type of trip
start Datetime The date that the trip starts
finish Datetime The date that the trip finishes
activities [Integer] An integer based list of activity identifiers
destinations [Destination] A list of Destination objects
air_segments [AirSegment] A list of AirSegment objects
rail_segments [RailSegment] A list of RailSegment objects
car_segments [CarSegment] A list of CarSegment objects
hotel_segments [HotelSegment] A list of HotelSegment objects
activity_segments [ActivitySegment] A list of ActivitySegment objects
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "trip": {
    }
}

Response samples

Content type
application/json
Example
Create Trip With Cruise Segments
Create Trip With Cruise Segments
Create Trip - European Vacation
Create Trip
{
  • "updated_at": "2019-03-26T13:05:22.953145Z",
  • "trip_type": 0,
  • "travellers": [],
  • "start": "2019-03-10T19:00:00.000000Z",
  • "settings": null,
  • "read": false,
  • "name": null,
  • "muted": false,
  • "id": "6a493f69-fa5c-408d-8ce1-68e003137b3e",
  • "finish": "2019-03-17T12:00:00.000000Z",
  • "final": true,
  • "employee_name": null,
  • "destinations": [
    ],
  • "deleted_at": null,
  • "created_at": "2019-03-26T13:05:22.902539Z",
  • "company_name": null,
  • "activities": [ ]
}

TripAlerts

DEPRECATED This keeps track of which alerts were sent to a user and if that user has read the alert or not. It has since been replaced by Notification

Get Trip Alerts

Responds with a list of Trip Alerts for the current user. Response is paginated.

Request Parameters

Name Type Description
page String The page number to retrieve.
since Integer If provided will respond with only trips that were updated since the timestamp given. Expects format to be unix time.
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Users

Keeps track of users that can access the Sitata platform.

User Attributes

Name Type Description
id String The id of the user
created_at String The time the record was created
updated_at String The time the record was updated
display_name String Name used to display to other users. Used mostly by responders.
first_name String First name
last_name String Last name
age Integer DEPRECATED
birthday Date Birthday of user
email String Email address of user
home_country String Two character code of country for the user. e.g. CA for Canada
phone_number String Phone number of user
language String Two character language code for the user. e.g. "es" for Spanish
timezone String DEPRECATED
timezone_identifier String Timezone identifier for the user
profile_pic Map Map of urls to the user's profile picture
username String Username chosen by the user for public display
points Integer Point total accumulated by user by participating in the platform

Private Attributes

These attributes are only shown for the user requesting them.

Name Type Description
authentication_token String Authentication token used to access Sitata
settings [UserSettings] Settings for the user. See below.
mailing_lists Map A map of activated mailing lists for the user
check_ins [CheckIn] A list of CheckIns belonging to the user
loc LastKnownLocation The last known location of the user. See Below.
roles [Role] A list of roles that the user has on the Sitata Platform. See below.
subscriptions [Subscription] A list of subscriptions that the user has.

Responder Attributes

These attributes are only shown for users that have a responder (doctor, dentist, etc) role.

Name Type Description
bio String Biography of the responder
languages_spoken [String] A list of two character codes of languages spoken by the responder. e.g. ["en", "fr", "es"]
doctor_settings DoctorSettings A map of settings for the responder. See Below.

User Settings

User settings describe settings for most users (travellers).

User Settings Attributes

Name Type Description
send_trip_alert_email Boolean True if user wants to receive emails about trip alerts
send_all_good_email Boolean True if user wants to receive emails when no alerts found
send_trip_alert_push Boolean True if user wants to receive a push notification for trip alerts
send_all_good_push Boolean True if user wants to receive a push notification when no alerts found
check_in_with_location Boolean True if user wants to check in with their location
follow_after_comment_report Boolean True if user wants to follow community reports after leaving a comment
community_reward_email Boolean True if user wants to receive emails about rewards
community_reward_push Boolean True if user wants to receive a push notification about rewards
community_proximity_email Boolean True if user wants to receive emails when another nearby user reports
community_proximity_push Boolean True if user wants to receive a push notification when another nearby user reports

Doctor Settings

Doctor settings describe settings for responders.

Doctor Settings Attributes

Name Type Description
id String The id of the user
created_at String The time the record was created
updated_at String The time the record was updated
clinic_appt_cost Integer Cost of a clinic appointment in cents.
housecall_cost Integer Cost of a housecall appointment in cents.
telemed_consult_cost Integer Cost of a telemedicine appointment in cents.
istm_number String ISTM identifier for travel medicine doctors
clinic_address Address The clinic address string with lat/lng

Last Known Location

The user's last know location.

Last Known Location Attributes

Name Type Description
lat Double Latitude of the user's last known location
lng Double Longitude of the user's last known location
at Datetime Time of user's last known location
country_code String The two character country code of the user's last known location
acc Integer The accuracy of the user's last known location. Refer to CheckIn.
trip_id String The trip id associated with this user's last known location

Roles

A user can have one or more roles on the Sitata platform.

Name Type Description
id String id of the role
created_at String The time the record was created
updated_at String The time the record was updated
type Integer The role type (see below)
company Company A short form of the company including the id and name attributes.

Role Types

Value Description
0 Traveller
1 Employee
2 Branded Traveller
55 Medical Practitioner
57 Psychiatrist
59 Dentist
50 Clinical Admin
99 Organization Admin

Get Responders

Request a list of responders (doctors, dentists, practitioners, etc) near the given location.

Request Parameters

Name Type Description
lat Double Latitude.
lng Double Longitude.
query Parameters
lat
number
Example: lat=43.6532

Latitude

lng
number
Example: lng=-79.3832

Longitude

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
[]

My Profile

Returns User's full profile details.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}

Responses

Response samples

Content type
application/json
{}

Get Token

Return a signed token containing the User's id.

Request Parameters

Name Type Description
user_id String The id of the User.
path Parameters
user_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAAkZjExOGY0MmEtM2I5ZS00NzlkLTk0YzMtOWVlMThmYTM2ZTRhZAAGc2lnbmVkbgYAlApPPW4B.wezkzaZCmhkKrtyDr7vRPbQqtR4NVs5zsxHFEpyrmvo"
}

Create User

Create User.

User Object Attributes

Name Type Description
bio String Biography.
display_name String Text to show when displaying.
first_name String First name.
last_name String Last name.
email String Email.
home_country String Home country.
phone_number String Phone number.
languages_spoken Array An Array of type String for which languages are spoken.
language String Primary language.
timezone String Timezone.
timezone_identifier Timezone identifier.
name String Name.
password String Password.
password_confirmation String Password confirmation.
profile_pic String Profile picture.
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{}

Sign In User

Checks the user's sign in credentials and returns an API user's full profile details if they are correct.

Request Parameters

Name Type Description
email String Email.
password String Password.
query Parameters
email
string
Example: email=email@sitata.com
password
string
Example: password=password
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "email": "ranimem@getnada.com",
  • "password": "testsitata"
}

Response samples

Content type
application/json
{
  • "username": null,
  • "timezone_identifier": "Asia/Muscat",
  • "timezone": "UTC",
  • "settings": null,
  • "roles": [
    ],
  • "profile_pic": {},
  • "points": null,
  • "phone_number": null,
  • "mailing_lists": { },
  • "loc": null,
  • "last_name": "Ford",
  • "language": "en",
  • "id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "home_country": null,
  • "first_name": "Dr.Mustang",
  • "email": "email@sitata.com",
  • "display_name": "Mike Smith",
  • "check_ins": [ ],
  • "authentication_token": "0f805e17-323b-406c-9648-da4bc7f9495f"
}

Update User

Update User.

Request Parameters

Name Type Description
user_id String The id of the User.

User Object Attributes

Name Type Description
bio String Biography.
display_name String Text to show when displaying.
first_name String First name.
last_name String Last name.
email String Email.
home_country String Home country.
phone_number String Phone number.
languages_spoken Array An Array of type String for which languages are spoken.
language String Primary language.
timezone String Timezone.
timezone_identifier Timezone identifier.
name String Name.
password String Password.
profile_pic String Profile picture.
path Parameters
user_id
required
string
Example: e1376dc7-f2d3-4b5b-9a54-317bb90aadaf

User Identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "authentication_token": "7affe88b-b551-42aa-9d61-69415e90c30f",
  • "bio": "Bio",
  • "birthday": null,
  • "check_ins": [
    ],
  • "display_name": null,
  • "doctor_settings": {
    },
  • "email": "traveller@traveller.com",
  • "first_name": "Ericson",
  • "home_country": null,
  • "home_location_lat": null,
  • "home_location_lng": null,
  • "id": "f118f42a-3b9e-479d-94c3-9ee18fa36e4a",
  • "intercom_android_hash": "BAC20C71CF83170EDE430E35645BCA3DD6316A99C0E2C086BF0FDEC52E5491CC",
  • "intercom_ios_hash": "34860885462734E4B7A9E28D011B83CFFC6D88A2122EB013AA545A90A64CE5E0",
  • "intercom_web_hash": "9BC819F4900F56E3686CFD85EE206FE00663A797CA774B865C9E5B6807D75B07",
  • "language": "en",
  • "languages_spoken": [
    ],
  • "last_name": "Erlang",
  • "loc": {
    },
  • "mailing_lists": { },
  • "phone_number": null,
  • "points": null,
  • "profile_pic": {},
  • "roles": [
    ],
  • "settings": null,
  • "stripe_account_id": null,
  • "stripe_customer_id": "cus_ElWFjaPyYRiIIF",
  • "subscriptions": [
    ],
  • "timezone": "America/Toronto",
  • "timezone_identifier": "Asia/Muscat",
  • "username": null
}

Delete

Delete user

Request Parameters

Name Type Description
user_id String The id of the User.
Authorizations:
None
path Parameters
user_id
required
string
header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[ ]

Update User Settings

Update User.

Request Parameters

Name Type Description
user_id String The id of the User.

User Object Attributes

Name Type Description
bio String Biography.
display_name String Text to show when displaying.
first_name String First name.
last_name String Last name.
email String Email.
home_country String Home country.
phone_number String Phone number.
languages_spoken Array An Array of type String for which languages are spoken.
language String Primary language.
timezone String Timezone.
timezone_identifier Timezone identifier.
name String Name.
password String Password.
profile_pic String Profile picture.
path Parameters
user_id
required
string
Example: e1376dc7-f2d3-4b5b-9a54-317bb90aadaf

User Identifier

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "authentication_token": "7affe88b-b551-42aa-9d61-69415e90c30f",
  • "bio": "Bio",
  • "birthday": null,
  • "check_ins": [
    ],
  • "display_name": null,
  • "doctor_settings": {
    },
  • "email": "traveller@traveller.com",
  • "first_name": "Ericson",
  • "home_country": null,
  • "home_location_lat": null,
  • "home_location_lng": null,
  • "id": "f118f42a-3b9e-479d-94c3-9ee18fa36e4a",
  • "intercom_android_hash": "BAC20C71CF83170EDE430E35645BCA3DD6316A99C0E2C086BF0FDEC52E5491CC",
  • "intercom_ios_hash": "34860885462734E4B7A9E28D011B83CFFC6D88A2122EB013AA545A90A64CE5E0",
  • "intercom_web_hash": "9BC819F4900F56E3686CFD85EE206FE00663A797CA774B865C9E5B6807D75B07",
  • "language": "en",
  • "languages_spoken": [
    ],
  • "last_name": "Erlang",
  • "loc": {
    },
  • "mailing_lists": { },
  • "phone_number": null,
  • "points": null,
  • "profile_pic": {},
  • "roles": [
    ],
  • "settings": null,
  • "stripe_account_id": null,
  • "stripe_customer_id": "cus_ElWFjaPyYRiIIF",
  • "subscriptions": [
    ],
  • "timezone": "America/Toronto",
  • "timezone_identifier": "Asia/Muscat",
  • "username": null
}

Verify Phone Number

Confirm User phone number.

Request Parameters

Name Type Description
phone_number_confirmation_code Integer Confirmation code sent to User.
header Parameters
Accept
string
Example: application/json
Content-Type
string
Example: application/json
Authorization
string
Example: TKN {{authenticaton_token}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "phone_number_confirmation_code": "7790"
}

Response samples

Content type
application/json
{
  • "username": null,
  • "timezone_identifier": "Asia/Muscat",
  • "timezone": "Asia/Yangon",
  • "stripe_customer_id": null,
  • "stripe_account_id": "acct_1EEHKPDl5XiS4L5R",
  • "settings": null,
  • "roles": [ ],
  • "profile_pic": {
    },
  • "points": null,
  • "phone_number": "2894899264",
  • "mailing_lists": { },
  • "loc": null,
  • "last_name": "Ford",
  • "languages_spoken": [
    ],
  • "language": "en",
  • "intercom_web_hash": "62FC8E78735237321F2739AA582C24CB3B432BC5C6607E0432A66C1BF843FEF3",
  • "intercom_ios_hash": "CB7F4D213CFB7F1159476E45F0639D8D761DB975BAD2BD9F676C66FE7C255494",
  • "intercom_android_hash": "3974B0BF20279A23378E9DC181CB6FBB7E1678D89DEBA9D11F1066BB239DE47F",
  • "id": "34ceebdb-7253-468a-85d1-981ce983e335",
  • "home_location_lng": null,
  • "home_location_lat": null,
  • "home_country": null,
  • "first_name": "Bill",
  • "email": "responder@responder.com",
  • "doctor_settings": null,
  • "display_name": "Mike Smith",
  • "check_ins": [ ],
  • "birthday": null,
  • "bio": "bio",
  • "authentication_token": "0f805e17-323b-406c-9648-da4bc7f9495f"
}

Vaccinations

A Vaccination keeps track of information about vaccinations recommended when travelling to certain countries. Each vaccination contains a "datum" which allows certain organizations to customize the content presented to their travellers.

Vaccination Attributes

Name Type Description
id String The id of the notification
created_at String The time the record was created
updated_at String The time the record was updated
name String The name of the vaccination
datum VaccinationDatum The datum for the vaccination.

Vaccination Datum

Vaccination Datum Attributes

Name Type Description
id String The id of the notification
company_id String The company id that the datum belongs to
description String The description of the vaccination in markdwon format
routine Boolean If true, the vaccination is a routine one
schedule String Describes the schedule when taking the vaccination in markdown format
side_effects String Describes any side-effects in markdown format

Get Vaccinations

Returns Vaccination's.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Products

List Products

Return a list of products available for purchase depending on the parameters given.

path Parameters
country_code
required
string
Example: CA

Two character country code of purchase origin.

currency_code
required
string
Example: GBP

Three character currency code for the purchase.

assistance_only
boolean
Example: true

When true, will only return Sitata's Travel Assistance products.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

List Products With Pricing (Quote)

Return a list of products available for purchase along with their current cost depending on the parameters given.

header Parameters
Authorization
string
Example: TKN {{authenticaton_token}}
Content-Type
string
Example: application/json
Request Body schema: application/json
currency_code
string

Required. Three character currency code for the purchase.

country_code
string

Required. Two character country code of purchase origin.

subscriptions
array

Required. The list of subscrptions that should be created when executing the purchase. A subscription should be created for each user that wants to access the Sitata mobile application. In most cases, only a single subscription with the purchaser listed as the 'User' is necessary and all other members of the Subscription can be listed as beneficiaries under the subscription.

start
integer

The unix time for the subscription start. This parameter can be omitted if specifying Trip details. See below.

finish
integer

The unix time for the subscription finish. This parameter can be omitted if specifying Trip details. See below.

trip
object

Optional. The Trip details which typically includes the list of destinations, start time, finish time, itinerary items, and total cost.

product_ids
array

Optional. A list of product identifiers to request for. You may use the human readable identifiers.

Responses

Request samples

Content type
application/json
{
  • "currency_code": "GBP",
  • "country_code": "HK",
  • "subscriptions": [
    ],
  • "trip": {
    }
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]