Our support and download center

Already a Riskline client or partner? Or interested to know more? Browse our Frequently Asked Questions to learn more or check our Downloads section for more information.

API

Riskline Summaries

Requirements

A URL endpoint where we will POST the data. http://www.example.com/summaries/new

The data is json encoded. We also provide a form data option (application/x-www-form-urlencoded).

An initial sync is provided to populate the database on your end. After that, we push data only when risk levels change.

Fields

  • country: string, uppercase, country iso code 2 letters risk_level: string (“Low”, “Moderate”, “Medium”, “High”, “Extreme”)
  • summary: string, short text summarizing the situation in a given country
  • client_id: integer

Sample

Riskline Pre-travel Advisory

Requirements

A URL endpoint where we will POST the data. http://www.example.com/ptas/new

The data is json encoded. We also provide a form data option (application/x-www-form-urlencoded).

An initial sync is provided to populate the database on your end. After that, we push data only when risk levels change or when advisories for that country are updated.

PTAs contain risk level, risk advisories (not risk alerts), summaries and custom text boxes that are added by admins on their Riskline portal. The text boxes can be country specific or global (for all countries) and also visible only for certain risk levels.

Fields

  • file: string, base64encoded file contents
  • country: string, uppercase, country iso code 2 letters
  • risk_level: integer, if client on Riskline manages its own risk levels for each country
  • client_id: integer

Sample { 'file':base64encodefile, 'country':AZ, 'risk_level':2, 'client_id':84536 }

Riskline Country Reports

Requirements

A URL endpoint where we will POST the data. http://www.example.com/country-reports

Once a URL is provided to use, we will send data over.

The data is updated each time it is changing.

The data is json ecoded.

Fields

  • country: string, uppercase, country iso code 2 letters
  • risk_level: integer, from 1 to 5: Low, Moderate, Medium, High, Extreme
  • client_id: integer
  • geometries: array of polygons
  • pdf: url of downloadable PDF document
  • chapters: array of report chapters
  • ---- chapter_id: integer
  • ---- title: string
  • ---- risk_level: integer, from 1 to 5 (optional)
  • ---- sections: array of sections/texts
  • --------- chapter_id: integer
  • --------- title: string (optional)
  • --------- text: text
  • --------- subcategory_id: integer (matches alert categories, if you need to display related alerts)
  • --------- subcategory: string (matches alert categories)

Sample

Riskline Cities

Requirements

A URL endpoint where we will POST the data. http://www.example.com/cities

The data is json encoded.

Fields

  • name: string
  • code: string, city code
  • country: string, 2 letter iso code, uppercased
  • risk_level: integer, risk level
  • overview: text
  • arrival: text
  • getting_around: text
  • safety: text
  • health: text
  • calendar: text
  • latitude: float longitude: float
  • zoom: integer, zoom level
  • client_id: integer, company id

Sample

Riskline Alerts

Requirements

A URL endpoint where will POST the data. http://www.example.com/alerts

Correction to alerts (fact correction, typo correction) is provided via a PUT request to an endpoint. http://www.example.com/alerts/:id

Deleting alerts, that were sent in error is done via a DELETE request to an endpoint. http://www.example.com/alerts/:id

The data is json encoded

Fields

  • title: string
  • text: string, text lengths of 560 characters (if the Breaking flag is set) or 600 characters.
  • country: string, uppercase, country iso code 2 letters breaking: integer, 1 or 0
  • risklevel: string: Low, Moderate, Medium, High, Extreme duration: object with startdate and end_date - UTC timestamps)
  • category: integer (one of 7 categories) - see additional file, regarding categories
  • airports: optional, comma separated list of airport codes (IATA 3 letter codes)
  • regions: optional, array of regions, each with name and code (29 countries), a dump with a list is available
  • geo: optional, object with 2 keys: lat and lng location_explanation: optional, string, name or a description of the lat/lng location

Sample

Difference between Risk Alerts and Risk Notices

Breaking is a flag to differentiate between Alert and Notice.

Here is an explanation:

Risk alerts and risk notices are measured using benchmarks tied to the impact on reliable, safe and secure travel. Notices apply to upcomming and potentially disruptive events (planned protests, g20 Summit, etc), while alerts are issued in response to incidents as they happen.

Riskline Advisories

Requirements

A URL endpoint where we will POST the data: New advisories are sent via a POST request. POST http://www.example.com/advisories

Updates to existing advisories are done via PUT requests POST http://www.example.com/advisories/:id

Removing advisories is done via a DELETE request DELETE http://www.example.com/advisories/:id

The data is json encoded.

Fields

  • id: integer
  • text: string
  • Is_published: boolean
  • title: string
  • risklevelid: integer (1 to 5)
  • risk_level: string (Low, Moderate, Medium, High, Extreme)
  • country: string, 2 letter iso_code
  • geometries: optional, array of polygons
  • country_geometries: array of polygons for the country shape

A geometry has the following fields:

  • coordinates: geometry.coordinates
  • color: geometry.color
  • text: optional, string
  • name: optional, string

Sample

Can't you find the answer to your question?

Contact Us