Concur Itinerary Event
Overview
The Itinerary API provides clients and authorized partners access to travel itinerary data through the events on the public topic public.concur.travel.itinerary
. Subscribers to this event will receive events when an itinerary is created, updated, deleted, cancelled, or anonymized (for GDPR/RTBF compliance). To subscribe to these events follow the steps described on the Event Subscription Service v4 page.
Limitations
Access to this documentation does not provide access to the subscription.
Scope Usage
Name | Description |
---|---|
travel.itinerary.read |
Get itinerary record. |
events.topic.read |
Get event record. |
Events
All events under topic public.concur.travel.itinerary
are listed below.
EventType | Description |
---|---|
ItineraryCreated |
Published when a new trip is created. |
ItineraryUpdated |
Published when any update to the existing trip is made, including segment cancellations. |
ItineraryCancelled |
Published when an existing trip reservations are cancelled. |
ItineraryAonymized |
Published when an existing trip is anonymized on account of requests for GDPR, RTBF, and client termination. |
ItineraryDeleted |
Published when an existing trip is deleted permanently. |
Schema
Schema for Event
Name | Type | Format | Description |
---|---|---|---|
id |
UUID |
RFC 4122 | EventId, unique identifier of this event. |
correlationId |
UUID |
RFC 4122 | Unique identifier used for logging/traceability. |
eventType |
string |
string |
Event type identified on the topic. |
topic |
string |
string |
Public topic public.concur.travel.itinerary that the event belongs to. |
timeStamp |
timeStamp |
RFC 3339 | Current system time (UTC) when the event notification is issued. |
facts |
map |
Facts Schema | Key-value pairs providing the content of the event. |
Schema for Facts
Name | Type | Format | Description |
---|---|---|---|
id |
UUID |
RFC 4122 | Unique identifier for this itinerary. |
companyId |
UUID |
RFC 4122 | Company unique identifier from profile service that this itinerary belong to. |
userId |
UUID |
RFC 4122 | User Unique identifier from profile service that that this itinerary belong to. |
hrefs |
map |
- | Key-value pairs providing Itineray schema version and URI of the itinerary record retrieved via the Itinerary v4 API. |
Note The hrefs in facts will be empty for ItineraryDeleted and ItineraryAnonymized events since the itinerary record has been deleted or anonymized and no further updates will be provided for the trip.
Sample Events
{
"id": "51519e89-2c1d-47ec-bd93-7c4ace9c57e6",
"eventType": "ItineraryCreated| ItineraryUpdated| ItineraryCancelled",
"timeStamp": "2016-01-01T23:01:01.000Z",
"topic": "public.concur.travel.itinerary",
"correlationId": "b2fd900a-5935-46fc-8d29-599de9864e21",
"facts": {
"id": "51519e89-2c1d-47ec-bd93-7c4ace9c57e9",
"userId": "b7d12989-0489-471a-81cd-175f8b78afa5",
"companyId": "ab83bc5f-f66e-4ce0-9dcc-7dbf0195e061",
"hrefs": {
"v4": "https://us.api.concursolutions.com/travel/v4/trips/51519e89-2c1d-47ec-bd93-7c4ace9c57e6"
}
}
}
{
"id": "51519e89-2c1d-47ec-bd93-7c4ace9c57e7",
"eventType": "ItineraryDeleted|ItineraryAnonymized",
"timeStamp": "2016-01-01T23:01:01.000Z",
"topic": "public.concur.travel.itinerary",
"correlationId": "b2fd900a-5935-46fc-8d29-599de9864e21",
"facts": {
"id": "51519e89-2c1d-47ec-bd93-7c4ace9c57e8",
"userId": "b7d12989-0489-471a-81cd-175f8b78afa5",
"companyId": "ab83bc5f-f66e-4ce0-9dcc-7dbf0195e061"
}
}