Trips & Waivers APIs (1.0.0)

Download OpenAPI specification:Download

Introduction

The Trips and Waivers platform is a powerful platform centered around your travelers' itineraries.

For an introduction to the platform please see the following:

Trips & Waivers answer questions such as

  • Is there a problem with the traveler making a connection?
  • Are the traveller's flights on-time?
  • Does a traveller trip qualify for an airline travel waiver?

The following set of APIs are available:

  • Trip Import - Import a traveler's trip into the trip platform for monitoring, and set up monitoring to either push alerts to your infrastructure, or for pull.
  • Pull Trip Alerts - Get the latest alerts for your travelers, if using pull instead of push
  • Trip Status - Get the latest information about a particular trip for a traveler
  • Test Delivery - Simulate alerts to your endpoints for testing
  • Status - General status of outbound (push) alerts and current state of API
  • Reference - APIs to aid in development

Licensing

Trips & Waivers APIs currently require a contract to use.

Schemas

Click the download button at the top of this document to download the OpenApi spec for this API.

Related articles

Keep travelers informed with Traveler Trip Alerts - Showcase article on how to use Traveler Trip Alerts

Notify agents of traveler disruptions with Agent Trip Alerts - Showcase article on how to use Agent Trip Alerts

Related products

Flight Status (FlightStats APIs) - Current flight information for flights about three days in advance of departure until about seven days after arrival

Flight Alerts (FlightStats APIs) - Push based alerts for single flights or bulk

Trip Import

Trip import

The Trip Import API provides access for developers to import Trips into the Trip platform. With the Trip Import API, developers are also able to also specify the alerting options.

query Parameters
appId
required
string

ID of the application making the request

appKey
required
string

Authentication key of the application making the request

Request Body schema: */*

The array of Trips to import

Array
referenceNumber
required
string [ 1 .. 45 ] characters

Identifier for the trip that is unique amongst current and future trips. Most often set to the record locator from the PNR or a customer provided system key

cancelled
boolean

True if this trips is cancelled

Array of objects (ImportFlight) [ items ]
object

A map of attributes associated with the trip

Array of objects (ImportPassenger) [ items ]
object (Alerting)
Array of objects (Ticket) [ items ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pull Trip Alerts

Pull trip alerts

This resource allows you to receive trip alerts via a request/response mechanism. It provides trip alerts in chronological order of the alert triggering time, remembering the last item returned and returning subsequent alerts in subsequent calls.

query Parameters
appId
required
string

ID of the application making the request

appKey
required
string

Authentication key of the application making the request

maxAlerts
integer [ 1 .. 100 ]
Default: 1

The maximum number of alerts to return in a single call (default = 1, limit=100)

peek
boolean

Allows you to retrieve alerts without changing the position of the last alert retrieved

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reset

Move the alerts service's internal cursor to next return alerts that were triggered at or after this point in time.

query Parameters
appId
required
string

ID of the application making the request

appKey
required
string

Authentication key of the application making the request

timestamp
required
string

The timestamp to set the cursor position to in UTC ("YYYY-MM-DDThh:mm:ssZ")

Responses

Trip Status

Trip status

The Trip Status API provides access to the latest trip status for developers to build rich, full-featured applications leveraging the Cirium expertise and industry leading knowledge. With the Trip Status API developers are able to request information about a specific trip. Cirium will then respond to the request and provide the latest itinerary plus flight status for the trip status.

path Parameters
referenceNumber
required
string [ 1 .. 45 ] characters

Key that you use to identify the Trip

query Parameters
appId
required
string

ID of the application making the request

appKey
required
string

Authentication key of the application making the request

extendedOptions
string <multi>

Extended Options. "Include Irregular Operations" will add related irregular operation flight status information for the trip.

Responses

Response samples

Content type
application/json
{
  • "referenceNumber": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "updatedDateTime": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "cancelled": true,
  • "monitorable": true,
  • "legs": [
    ],
  • "attributes": {
    },
  • "passengers": [
    ],
  • "emailAddresses": [
    ],
  • "relatedFlightStatuses": [
    ]
}

Test Delivery

Test delivery

This resource allows you to send a test alert to your application to verify that your application is able to properly receive test alerts

query Parameters
appId
required
string

ID of the application making the request

appKey
required
string

Authentication key of the application making the request

alertType
required
string
Enum: "Actual Connection Problem" "Connection Info" "Connection Information Gate Change" "Estimated Connection Problem" "Flight Arrival Delay" "Flight Arrival Gate Change" "Flight Arrived" "Flight Arrived Late" "Flight Baggage Change" "Flight Cancellation" "Flight Departed" "Flight Departed Late" "Flight Departure Delay" "Flight Departure Gate Change" "Flight Departure Update" "Flight Diversion" "Flight Reinstated" "Leg Arrival Delay" "Leg Arrival Gate Change" "Leg Arrival Info" "Leg Arrived" "Leg Baggage Change" "Leg Departed" "Leg Departure Delay" "Leg Departure Gate Change" "Leg Departure Info" "Scheduled Arrival Update" "Scheduled Departure Update" "Trip Reminder"

Alert Type

deliverTo
required
string
Default: "https://www.example.com"

URL in which to deliver the Test Alert

Responses

Response samples

Content type
application/json
Example

The Actual Connection Problem alert type informs agencies about connection problems that have actually occurred between flights in their trip. Unlike the Estimated Connection Problem alert, this alert is not used as an alert to notify passengers because the alert triggers after the departing flight in a connection has departed.

This alert is based on actual gate departures, actual gate arrivals, and the Minimum Connect Time (MCT) published by the airline.

This alert is sent if the connection time for any connection on the trip falls below a level that indicates the connection would have been at risk. Only one Actual Connection Problem alert is sent for any given at-risk connection.

The connection in this sample is at risk. The trip has one leg with three flights.

Under the alertDetails attribute, you can see:

  • type is Actual Connection Problem.
  • The alert is for the connection of the second and third flight in the leg.
  • legIndex is 0
  • inboundFlightIndex is 1
  • outboundFlightIndex is 2
  • The dateTime attribute shows that the alert was sent at 2019-11-20T18:05:06.616893Z.
  • The connectionTime (current) is -63 minutes.
  • The minimumConnectTime is 45. Minimum Connect Time (MCT) is a value published by the airline representing the minimum recommended connect time for booked connections.

Under the flightStatuses attribute for the connecting flights you can see:

  • The second flight actually arrived at 2019-11-20T13:00:00.
  • The third flight actually departed at "2019-11-20T11:57:00.
Loading...

Status

Delivery status

Provides the status of outbound (push) alerts sent from the Traveler Trip Alerts system

query Parameters
appId
required
string

ID of the application making the request

appKey
required
string

Authentication key of the application making the request

Responses

Response samples

Content type
application/json
{
  • "latestAlert": "string",
  • "lastSuccessfulAlert": "string",
  • "minutesBehind": 0
}

Trip alerts status

Provides the current state of the Trips Alerts API with the endpoints accessible by your account

query Parameters
appId
required
string

ID of the application making the request

appKey
required
string

Authentication key of the application making the request

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "accessibleEndpoints": [
    ]
}

Reference

Wireless providers

List of wireless providers that can be used when specifying a SMS via Email delivery point on an imported trip.

THIS API HAS BEEN DEPRECATED AND SHOULD NOT BE USED IN NEW PROJECTS

query Parameters
appId
required
string

ID of the application making the request

appKey
required
string

Authentication key of the application making the request

Responses

Response samples

Content type
application/json
[
  • {
    }
]
)