Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
LocationSource
GET /locationSource/{organizationId}/{locationId}
Description
Get itinerary by organization ID.
URL
/locationSource/{organizationId}/{locationId}
Method
GET
Request Header
| Parameter | Mandatory | Description |
|---|---|---|
Authorization | Yes | Authorization |
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | long | Organization ID | |
locationId | Yes | long | Expected location ID |
Responses
| Code | Response |
|---|---|
200 OK | { "message": "OK", "result": { "organizationId": 9006378915988111, "locationIds": [9003630136944275], "source": "iJet", "type": "Air", "pnr": "F13517", "supplier": "UA", "number": "03", "fromIata": "DCA", "toIata": "BOS", "fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-01T15:24:00Z", "address": "", "supplierCode": "UA", "supplierName": "United Airlines" } } |
401 Unauthorized | Authentication failure |
404 Not Found | Location ID not found |
500 Internal Error | System Error / Internal Error |
POST /locationSource/{organizationId}/BatchGet
Description
Get itineraries in batch by organization ID and location IDs.
URL
/locationSource/{organizationId}/BatchGet
Method
POST
Request Header
| Parameter | Mandatory | Description |
|---|---|---|
Authorization | Yes | Authorization |
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | long | Organization ID |
Request Body
NOTE: The size of response increases as the size of location ID array. The location ID array size limit is set as 4,096; if the size of array is exceeded, 413 will return.
| Code | Response |
|---|---|
{ locationIds: [123456789, 234567891, 345678912] } NOTE: The maximum number of IDs is 4096. |
Responses
| Code | Response |
|---|---|
200 OK | The request will return 200 if the location IDs are partially found. { locationSources: [ { "organizationId": 9006378915988111, "locationIds": [9003630136944272, 9003630136944273], "source": "iJet", "type": "Air", "pnr": "F13517", "supplier": "", "number": "", "fromIata": "DCA", "toIata": "BOS", "fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-01T15:24:00Z", "address": "", "supplierCode": "", "supplierName": "" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944273, 9003630136944274], "source": "ISOS", "type": "Air", "pnr": "d7637cf6-d45d-435c-a50b-65e0bfa26f45", "supplier": "AB", "number": "12", "fromIata": "JFK", "toIata": "IHR", "fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-01T15:24:00Z", "address": "", "supplierCode": "AB", "supplierName": "Air Berlin" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944274, 9003630136944275], "source": "Concur", "type": "Air", "pnr": "t7637cf6-d45d-435c-a50b-65e0bfa26f45", "supplier": "SQ", "number": "221", "fromIata": "SIN", "toIata": "SYD", |
"fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-01T15:24:00Z", "address": "", "supplierCode": "SQ", "supplierName": "Singapore Airlines" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944276], "source": "ISOS", "type": "Hotel", "pnr": "F65517", "supplier": "Park Hyatt Maldives Hadahaa", "number": "", "fromIata": "", "toIata": "", "fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-02T15:24:00Z", "address": "North Huvadhoo, Gaafu Alifu Atoll, Republic of Maldives", "supplierCode": "", "supplierName": "Park Hyatt Maldives Hadahaa" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944277], "source": "Concur", "type": "Hotel", "pnr": "F13787", "supplier": "HH", "number": "", "fromIata": "", "toIata": "", "fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-02T15:24:00Z", "address": "152 West 26th Street", "supplierCode": "", "supplierName": "Hilton" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944278, 9003630136944279], "source": "ISOS", "type": "Rail", "pnr": "F56817", "supplier": "", "number": "03", "fromIata": "BJS", "toIata": "XTF", | |
"fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-02T15:24:00Z", "address": "", "supplierCode": "", "supplierName": "Airport Express Rail" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944280, 9003630136944281], "source": "Concur", "type": "Rail", "pnr": "F13321", "supplier": "2V", "number": "42", "fromIata": "BJS", "toIata": "XTF", "fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-02T15:24:00Z", "address": "", "supplierCode": "2V", "supplierName": "Amtrak" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944282, 9003630136944283], "source": "ISOS", "type": "Car", "pnr": "F13217", "supplier": "CA", "number": "816", "fromIata": "SZX", "toIata": "CAN", "fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-02T15:24:00Z", "address": "", "supplierCode": "", "supplierName": "Amtrak" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944286, 9003630136944285], "source": "Concur", "type": "Car", "pnr": "d8737cf6-d45d-435c-a50b-65e0bfa26f45", "supplier": "WN", "number": "5736", "fromIata": "OAK", "toIata": "LAX", "fromDate": "2017-02-01T13:43:00Z", "toDate": "2017-02-02T15:24:00Z", | |
"address": "", "supplierCode": "", "supplierName": "Enterprise" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944288, 9003630136944287], "source": "Magnatech", "type": "Air", "pnr": "QBSIGA", "supplier": "CX", "number": "716", "fromIata": "SIN", "toIata": "HKG", "fromDate": "2019-05-21T10:00:00Z", "toDate": "2019-05-21T14:05:00Z", "address": "", "supplierCode": "CX", "supplierName": "Cathay Pacific Airways" }, { "organizationId": 9006378915988111, "locationIds": [9003630136944290, 9003630136944289], "source": "Magnatech", "type": "Hotel", "pnr": "QBSIGA", "supplier": "The Westin Singapore", //The Hotel Name "number": "", "fromIata": "SIN", "toIata": "SIN", "fromDate": "2019-05-19T00:00:00Z", "toDate": "2019-05-21T00:00:00Z", "address": "12 Marina View Asia Square Tower, 2, Singapore 018961", "supplierCode": "", "supplierName": "The Westin Singapore" } ] } | |
401 Unauthorized | Authentication failure |
413 Payload Too Large | { "message": "The amount of data requested exceeds the limit.", "status": 413 } |
500 Internal Error | System Error / Internal Error |
GET /locationSource/{organizationId}?
Description
Get itineraries by specific parameter combinations.
URL
Search by PNR
◊ The parameters startTime
and endTime are not supported.
◊ Supported URL:
/locationSource/{organizationId}?PNR={PNR}
Search by Flight/Rail Code and Number
◊ The parameters
supplierCode and number are required and must match exactly.
◊ The parameters startTime
and endTime are required.
◊ The parameter top is
optional.
◊ Supported URLs:
/locationSource/{organizationId}?
supplierCode={code}&number={number}&startTime={startTime}&endTime={endTime}&top={top}
Search by Supplier Name
◊ The parameter
supplierName supports fuzzy search; it requires at least 3 characters.
◊ The parameters startTime
and endTime are required.
◊ The parameter top is
optional.
◊ Supported URL:
/locationSource/{organizationId}?
supplierName={supplierName}&startTime={startTime}&endTime={endTime}&top={top}
Search by IATA
◊ The parameter IATA must
match exactly on either departure or arrival IATA.
◊ The parameters startTime
and endTime are required.
◊ The parameter top is
optional.
◊ Supported URL:
/locationSource/{organizationId}?
IATA={IATA}&startTime={startTime}&endTime={endTime}&top={top}
Method
GET
Request Header
| Parameter | Mandatory | Description |
|---|---|---|
Authorization | Yes | Basic Auth |
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | long | Organization ID | |
PNR | Conditional | string | Passenger Name Record | |
supplierCode | Conditional | string | Flight/Rail code, exact match | |
number | Conditional | string | Flight/Rail number, exact match | |
supplierName | Conditional | string | Supplier name, fuzzy search, at least 3 characters | |
IATA | Conditional | string | IATA code, exact match | |
startTime | Conditional | DateTime | The start of the search time range | |
endTime | Conditional | DateTime | The end of the search time range, which must be after startTime | |
top | No | long | Returns the top records (0, 1,000), default 1000 |
Parameter Handling
Strict, return 400 if the parameter combination is not allowed.
Responses
| Code | Response |
|---|---|
200 OK | { "locationSources":[ { "organizationId":9006378915988111, "locationIds":[ 9003630136944272, 9003630136944273 ], "source":"iJet", "type":"Air", "pnr":"F13517", "supplier":"", "number":"", "fromIata":"DCA", "toIata":"BOS", "fromDate":"2017-02-01T13:43:00Z", "toDate":"2017-02-01T15:24:00Z", "address":"", "supplierCode":"", "supplierName":"" }, { "organizationId":9006378915988111, "locationIds":[ 9003630136944273, 9003630136944274 ], "source":"ISOS", "type":"Air", "pnr":"d7637cf6-d45d-435c-a50b-65e0bfa26f45", "supplier":"AB", "number":"12", "fromIata":"JFK", "toIata":"IHR", "fromDate":"2017-02-01T13:43:00Z", "toDate":"2017-02-01T15:24:00Z", "address":"", "supplierCode":"AB", "supplierName":"Air Berlin" } ] } |
401 Unauthorized | Authentication failure |
404 Not Found | Organization not found / Itinerary not found |
500 Internal Error | System Error / Internal Error |