Developer Guide
API Parameters
Elements Supported in Itinerary Data
| Element | Required/ Optional | Sample Value | Description |
|---|---|---|---|
| ItineraryList | Required | NA | List of Itineraries. This tag serves as the root element of the JSON request |
| RequiredData | Required | NA | This tag serves as the parent tag for all elements that are required. |
| AccountCode | Required | 12345 | Account code assigned by CIBT. This will be constant unless the partner is sending data for multiple companies with their unique pricing plan. |
| ApplicationDomain | Required | USA | Application domain is a country code associated with the “Account Code” assigned by CIBT. Please refer to the below list of application domains. |
| State | Required | VA | State should be provided in this field. This field is required for countries (ApplicationDomains) that are jurisdictional, like the USA, CAN, AUS and GER. Please refer to the below list of state codes. In all countries which are not mentioned above State should be set as “NA”. |
| FirstName | Required | John | 20-character maximum |
| LastName | Required | Doe | 20-character maximum |
| Required | JohnTraveler@cibt.com | 50-character maximum | |
| Nationality | Required | USA | Needs to be an ISO code of the traveler’s nationality. See reference section. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 |
| DepartureDate | Required | 12/31/2014 | Date Format: MM/DD/YYYY |
| Destination1 | Required | CHN | Needs to be an ISO code of the destination. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 |
| Purpose1 | Required | B | B=Business, T=Tourist, TR=Transit
Please refer to the below list of purpose codes. Required if Destination1 is provided. |
| EntryDate1 | Required | 2024-01-01T10:00:00 | This will be the Entry Date to the destination 1 (first destination) Format : YYYY-MM-DDTHH:MM:SS
The time portion is optional. |
| ExitDate1 | Optional; strongly recommended | 2024-01-01T10:00:00 | This is the exit date from the destination 1
Format : YYYY-MM-DDTHH:MM:SS The time portion is optional. |
| Destination2 | Conditionally required | IND | You can send up to three destinations total. Second and third destinations are optional. Required if itinerary includes more than one destination. Needs to be an ISO code of the destination. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 |
| Purpose2 | Conditionally required | T | B=Business, T=Tourist, TR=Transit
Please refer to the below list of purpose codes. Required if Destination2 is provided. |
| EntryDate2 | Optional; strongly recommended | 2024-01-01T10:00:00 | This will be the Entry Date to the destination 2 Format : YYYY-MM-DDTHH:MM:SS
The time portion is optional. |
| ExitDate2 | Optional; strongly recommended | 2024-01-01T10:00:00 | This is the exit date from the destination 2
Format : YYYY-MM-DDTHH:MM:SS The time portion is optional. |
| Destination3 | Conditionally required | GBR | You can send up to three destinations total. Required if itinerary includes more than two destinations. Needs to be an ISO code of the destination. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 |
| Purpose3 | Conditionally required | B | B=Business, T=Tourist, TR=Transit
Please refer to the below list of purpose codes. Required if Destination3 is provided. |
| EntryDate3 | Optional; strongly recommended | 2024-01-01T10:00:00 | This will be the Entry Date to the destination 3 Format : YYYY-MM-DDTHH:MM:SS
The time portion is optional. |
| ExitDate3 | Optional; strongly recommended | 2024-01-01T10:00:00 | This is the exit date from the destination 3
Format : YYYY-MM-DDTHH:MM:SS The time portion is optional. |
| optionalData | Required | NA | This tag serves as the parent tag for all elements that are optional. |
| ExternalReference | Optional | PNR12345 | Unique number for this itinerary. Usually the Record Locator or PNR Number. This unique number can be used as an input field for reports. 20-character maximum |
| CountryOfResidence | Optional | USA | Three letter ISO country code to identify the country of residence of the traveler. If the partner wants to provide one single file that contains itineraries for travelers residing in multiple countries, this field must be specified. |
| AgentEmail | Optional | agentsally@cibttravel.com | CIBT can send the VAP email to this agent email in addition to the traveler if desired by the partner. 50-character maximum. |
| AgentName | Optional | Sally Field | This can be made available on the reports. 50-character maximum. |