Skip to content

Request

The IDeaS API uses an asynchronous communication flow to validate the format of inbound data and ensure the required data attributes are provided in the messages.

Asynchronous communication offers several advantages when you are delivering data to the IDeaS API.

One of the primary benefits is improving system efficiency by allowing you to transmit data without waiting for the IDeaS API to acknowledge it before continuing with other tasks. This non-blocking nature ensures that your systems and the IDeaS API can perform tasks concurrently, reducing idle time and optimizing resource utilization.

Asynchronous communication also enhances scalability, as it allows both your systems and the IDeaS API to handle a larger volume of requests without being limited by the time it takes to process each one sequentially.

Furthermore, it increases resilience, as the systems can process data independently of delays or failures in other parts of the network, allowing for retries or reprocessing without interrupting overall operations.

Asynchronous Message Flow

Asynchronous Message Flow

Sample Request - Sending a Reservation

[
{
"clientCode": "TESTCLIENT",
"propertyCode": "TESTHOTELCODE",
"correlationId": "6825ceed2ea6702a68b8e6",
"lastModifiedDateTime": "2021-10-14T12:55:20.311Z",
"reservationId": "219849-839960",
"confirmationNumber": "839960",
"status": "RESERVED",
"bookingDateTime": "2022-01-01T12:23:34Z",
"numberOfRooms": 1,
"multiReservationId": null,
"shareId": "2321",
"cancellationDateTime": null,
"cancellationReason": null,
"channel": "GDS",
"nationality": "NL",
"roomStays": [
126 collapsed lines
{
"arrivalDate": "2021-07-03",
"departureDate": "2021-07-04",
"roomTypeCode": "SGC",
"bookedRoomTypeCode": "DBL",
"marketSegmentCode": "CORP",
"groupBlockCode": "Grp1",
"sourceBookingCode": "AA",
"roomNumber": "100",
"numberOfAdults": 1,
"numberOfChildren": 2,
"currencyCode": "USD",
"rateCode": "FLRA3",
"rates": [
{
"startDate": "2021-07-03",
"endDate": "2021-07-04",
"rateValue": "68.87",
"grossRateValue": "82.64"
}
],
"childAgeBuckets": [
{
"minimumAge": "3",
"maximumAge": "8",
"numberOfChildren": "2"
}
],
"services": [
{
"startDate": "2021-07-03",
"endDate": "2021-07-04",
"serviceName": "SPCT",
"serviceValue": 2.83,
"inclusive": false,
"reservationPackage": false,
"roomRevenuePackage": false
}
]
},
{
"arrivalDate": "2021-07-05",
"departureDate": "2021-07-06",
"roomTypeCode": "SGC",
"bookedRoomTypeCode": "DBL",
"marketSegmentCode": "CORP",
"groupBlockCode": "Grp2",
"sourceBookingCode": "BB",
"roomNumber": "101",
"numberOfAdults": "1",
"numberOfChildren": "2",
"currencyCode": "USD",
"rateCode": "FLRA4",
"rates": [
{
"startDate": "2021-07-05",
"endDate": "2021-07-06",
"rateValue": "89.99",
"grossRateValue": "105.67"
},
{
"startDate": "2021-07-07",
"endDate": "2021-07-08",
"rateValue": "78.87",
"grossRateValue": "92.64"
}
],
"childAgeBuckets": [
{
"minimumAge": "5",
"maximumAge": "10",
"numberOfChildren": "1"
}
],
"services": [
{
"startDate": "2021-07-05",
"endDate": "2021-07-06",
"serviceName": "BKF",
"serviceValue": 10,
"inclusive": false,
"reservationPackage": false,
"roomRevenuePackage": false
}
]
}
],
"profiles": [
{
"id": "7564321",
"name": "IDeaS",
"profileType": "COMPANY",
"context": null
}
],
"stayRevenue": {
"daily": [
{
"occupancyDate": "2021-07-03",
"netRoomRevenue": "68.87",
"netFoodRevenue": "0.00",
"netBeverageRevenue": "0.00",
"netOtherRevenue": "2.83",
"netTicketPrice": "80.00",
"ticketPrice": "100.00",
"netTotalRevenue": "151.7",
"grossTotalRevenue": "185.47"
},
{
"occupancyDate": "2021-07-04",
"netRoomRevenue": "68.87",
"netFoodRevenue": "0.00",
"netBeverageRevenue": "0.00",
"netOtherRevenue": "2.83",
"netTicketPrice": "80.00",
"ticketPrice": "100.00",
"netTotalRevenue": "151.7",
"grossTotalRevenue": "185.47"
}
],
"summary": {
"netTotalTicketRevenue": "160.00",
"totalTicketRevenue": "200.00"
}
}
}
]

Sample Response - Successful Response

{
"responses": "202",
"description": "Accepted"
}

API References and Examples