Operation
Returns a paginated list of ReservationRoomStay
GET
https://{environment}.ulysescloud.com/public/api/v1/con/chain/{chainId}/property/{propertyId}/reservationRoomStay
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | int | true | path parameter | Unique identificator of the chain. | |
| propertyId | int | true | path parameter | Unique identificator of the property. | |
otaLocator | String | false | request parameter | ||
pmsLocator | String | false | request parameter | ||
crsLocator | String | false | request parameter | ||
cmLocator | String | false | request parameter | ||
| arrivalFrom | date | false | request parameter | ||
| arrivalTo | date | false | request parameter | ||
| departureFrom | date | false | request parameter | ||
| departureTo | date | false | request parameter | ||
| stayFrom | date | false | request parameter | ||
| stayTo | date | false | request parameter | ||
| createdFrom | dateTime | false | request parameter | ||
| createdTo | dateTime | false | request parameter | ||
| reservationStatusTypeId | list of int | false | request parameter | ||
| roomId | list of int | false | request parameter | ||
| offset | int | false | request parameter | ||
| limit | int | false | request parameter | ||
| sort | string | false | request parameter | ||
| sortMode | string | false | request parameter |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservationRoomStay
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true |
Entity
| Field | Type | Required | Description |
|---|---|---|---|
| id | int | false | Unique identifier for the Reservation. |
| reservationStatusType | ReservationStatusType | false | Status |
| reservationSituationType | ReservationSituationType | false | Situation of the Reservation Room Stay |
| arrival | string | false | Date of arrival (yyyy-MM-dd). |
| departure | string | false | Date of departure (yyyy-MM-dd). |
| arrivalTime | string | false | Time of arrival (HH:mm:ss). |
| departureTime | string | false | Time of arrival (HH:mm:ss). |
| quantity | int | false | Amount of accommodations |
| accommodation | Accommodation | false | The type of Acoommodation |
| room | Room | false | Room asigned. |
| adult | int | false | Amount of adults. |
| junior | int | false | Amount of juniors. |
| child | int | false | Amount of childs. |
| infant | int | false | Amount of infants. |
| accomodationAmount | bigDecimal | false | Amount of the accomodation. |
| boardAmount | bigDecimal | false | Amount of the boards. |
| serviceAmount | bigDecimal | false | Amount of the services. |
| totalAmount | bigDecimal | false | Total amount of the stay. |
| productFee | Fee | false | The type of fee applied to this ReservationRoomStay |
| pmsLocator | string | false | Locator used in the PMS. |
| crsLocator | string | false | Locator used in the CRS. |
| otaLocator | string | false | Locator used in the OTA. |
| cmLocator | string | false | Locator used in the CM. |
| remark | string | false | |
| reservationRoomStayGuests | Array of ReservationRoomStayGuest | true | Guests that has this ReservationRoomStay. |
| mainBoard | Board | true | Board associated to this ReservationRoomStay. |
reservationRoomStayDaily | Array of ReservationRoomStayDaily | true | |
reservationRoomStayServiceList | Array of ReservationRoomStayService | true | |
| createdDate | LocalDateTime | false | |
| modifiedDate | LocalDateTime | false | |
| mainBooker | Company | false | |
| mainBillTo | Company | false | |
| mainCentral | Company | false | |
| mainCompany | Company | false | |
| mainRate | Rate | false | |
| mainOffer | Offer | false | |
| mainPromotion | Promotion | false | |
| deposit | ReservationDeposit | false | |
| reservationType | ReservationType | false | |
| reservationRoomStayCustomFieldValueSet | List<ReservationRoomStayCustomFieldValue> | false | |
| Property | Property | false |
Example response
{
"count": 7,
"offset": 0,
"limit": 2,
"list": [
{
"id": 1,
"reservationStatusType": {
"id": 4,
"code": "IH",
"name": "InHouse",
"nameI18n": "InHouse",
"colorCode": "#64b5f6"
},
"arrival": "2021-03-16",
"departure": "2021-03-17",
"arrivalTime": "01:00:00",
"departureTime": "00:00:00",
"quantity": 1,
"accommodation": {
"id": 692,
"name": "Double",
"roomType": {
"id": 17,
"name": "Double",
"nameI18n": "Double",
"mainImage": "1/2/propertyroomtypeimages/c7faf58c-c47c-490f-a5c8-a4e8e5d0bc12.jpg"
}
},
"room": {
"id": 1,
"code": "101",
"name": "101",
"roomSpaceStatusType": {
"id": 2,
"code": "DI",
"name": "Dirty",
"nameI18n": "Dirty"
},
"reservationRoomStay": null,
"roomSituationType": {
"id": 2,
"code": "OC",
"name": "Occupied",
"nameI18n": "Occupied"
}
},
"adult": 2,
"junior": 1,
"child": 1,
"infant": 1,
"accommodationAmount": 0.000000,
"boardAmount": 0.000000,
"serviceAmount": 0.000000,
"totalAmount": 0.000000,
"productFee": {
"id": 797,
"name": "City Tax Barcelona"
},
"pmsLocator": "ALI00000001/1",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"remark": null,
"reservationRoomStayGuests": [
{
"id": 1,
"documentType": {
"id": 5,
"code": "D",
"name": "National identity document",
"nameI18n": "National identity document"
},
"documentNumber": "DOC 6",
"givenName": "Marilyn",
"surName": "Angèle",
"secondSurName": "Roberts",
"genderType": {
"id": 1,
"code": "M",
"name": "Male",
"nameI18n": "Male"
},
"birthDate": "2000-01-01",
"birthCountryCode": "ES",
"birthPlace": "Lansing",
"effectiveDate": "2015-06-15",
"expireDate": "2024-01-01",
"street": null,
"city": null,
"stateProvName": "Michigan",
"stateProvCode": null,
"countryCode": "NR",
"postalCode": "48901",
"nationalityCountryCode": "NR",
"countryOfIssuanceCode": "NR",
"ocr": null,
"email": "mroberts5t@is.gd",
"phoneNumber": "1-(517)462-0078",
"allowMarketing": false,
"allowThirdParty": false,
"language": {
"id": 1,
"code": "ES",
"name": "Spanish",
"nameI18n": "Spanish"
}
},
{
"id": 2,
"documentType": {
"id": 5,
"code": "D",
"name": "National identity document",
"nameI18n": "National identity document"
},
"documentNumber": "DOC 9",
"givenName": "Walter",
"surName": "Åke",
"secondSurName": "Webb",
"genderType": {
"id": 1,
"code": "M",
"name": "Male",
"nameI18n": "Male"
},
"birthDate": "2000-01-01",
"birthCountryCode": "ES",
"birthPlace": "New York City",
"effectiveDate": "2015-06-15",
"expireDate": "2024-01-01",
"street": null,
"city": null,
"stateProvName": "New York",
"stateProvCode": null,
"countryCode": "EH",
"postalCode": "10110",
"nationalityCountryCode": "EH",
"countryOfIssuanceCode": "EH",
"ocr": null,
"email": "wwebbo3@microsoft.com",
"phoneNumber": "1-(646)870-8357",
"allowMarketing": false,
"allowThirdParty": false,
"language": {
"id": 1,
"code": "ES",
"name": "Spanish",
"nameI18n": "Spanish"
}
}
],
"mainBoard": {
"id": 5,
"code": "RO",
"name": "Room Only",
"serviceList": null
},
"reservationRoomStayDaily": [
{
"id": 1,
"date": "2021-03-16",
"room": {
"id": 1,
"code": "101",
"name": "101",
"roomSpaceStatusType": {
"id": 2,
"code": "DI",
"name": "Dirty",
"nameI18n": "Dirty"
},
"reservationRoomStay": null,
"roomSituationType": {
"id": 2,
"code": "OC",
"name": "Occupied",
"nameI18n": "Occupied"
}
},
"allotment": null,
"rate": null,
"amountBeforeTax": 0.000000,
"amountAfterTax": 0.000000,
"centralAccommodationPercentageCommission": null,
"centralAccommodationAmountCommission": null,
"centralBoardPercentageCommission": null,
"centralBoardAmountCommission": null,
"companyAccommodationPercentageCommission": null,
"companyAccommodationAmountCommission": null,
"companyBoardPercentageCommission": null,
"companyBoardAmountCommission": null,
"bookerAccommodationPercentageCommission": null,
"bookerAccommodationAmountCommission": null,
"bookerBoardPercentageCommission": null,
"bookerBoardAmountCommission": null,
"billToAccommodationPercentageCommission": null,
"billToAccommodationAmountCommission": null,
"billToBoardPercentageCommission": null,
"billToBoardAmountCommission": null,
"billToAccommodationPercentageDiscount": null,
"billToAccommodationAmountDiscount": null,
"billToBoardPercentageDiscount": null,
"billToBoardAmountDiscount": null,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"board": {
"id": 5,
"code": "RO",
"name": "Room Only",
"serviceList": null
},
"boardPriceAdult": 0.000000,
"boardPriceJunior": 0.000000,
"boardPriceChild": 0.000000,
"boardPriceInfant": 0.000000,
"paymentType": {
"id": 1,
"code": "G",
"name": "Pay Guest",
"nameI18n": "Pay Guest"
},
"propertyPolicy": {
"id": 12,
"code": "24H",
"name": "24 Hours 1 Night"
},
"propertySource": {
"id": 13,
"code": "PHO",
"name": "Phone"
},
"propertySegment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"propertyChannel": {
"id": 12,
"code": "WEBM",
"name": "Booking Engine Mobile"
},
"booker": null,
"billTo": null,
"central": null,
"company": null,
"reservationGroup": null
}
],
"reservationRoomStayServiceList": null,
"createdDate": "2021-04-15T14:29:45.151Z",
"modifiedDate": "2021-04-16T14:59:53.891Z"
},
{
"id": 2,
"reservationStatusType": {
"id": 3,
"code": "NS",
"name": "NoShow",
"nameI18n": "NoShow",
"colorCode": "#000000"
},
"arrival": "2021-03-16",
"departure": "2021-03-17",
"arrivalTime": null,
"departureTime": null,
"quantity": 1,
"accommodation": {
"id": 692,
"name": "Double",
"roomType": {
"id": 17,
"name": "Double",
"nameI18n": "Double",
"mainImage": "1/2/propertyroomtypeimages/c7faf58c-c47c-490f-a5c8-a4e8e5d0bc12.jpg"
}
},
"room": null,
"adult": 2,
"junior": 1,
"child": 1,
"infant": 0,
"accommodationAmount": 0.000000,
"boardAmount": 0.000000,
"serviceAmount": 0.000000,
"totalAmount": 0.000000,
"productFee": {
"id": 797,
"name": "City Tax Barcelona"
},
"pmsLocator": "ALI00000002/2",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"remark": null,
"reservationRoomStayGuests": [
{
"id": 3,
"documentType": null,
"documentNumber": null,
"givenName": "TEST 2",
"surName": null,
"secondSurName": null,
"genderType": null,
"birthDate": null,
"birthCountryCode": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProvCode": null,
"countryCode": "ES",
"postalCode": null,
"nationalityCountryCode": null,
"countryOfIssuanceCode": null,
"ocr": null,
"email": null,
"phoneNumber": null,
"allowMarketing": null,
"allowThirdParty": null,
"language": {
"id": 1,
"code": "ES",
"name": "Spanish",
"nameI18n": "Spanish"
}
},
{
"id": 4,
"documentType": null,
"documentNumber": null,
"givenName": null,
"surName": null,
"secondSurName": null,
"genderType": null,
"birthDate": null,
"birthCountryCode": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProvCode": null,
"countryCode": null,
"postalCode": null,
"nationalityCountryCode": null,
"countryOfIssuanceCode": null,
"ocr": null,
"email": null,
"phoneNumber": null,
"allowMarketing": null,
"allowThirdParty": null,
"language": null
}
],
"mainBoard": {
"id": 5,
"code": "RO",
"name": "Room Only",
"serviceList": null
},
"reservationRoomStayDaily": [
{
"id": 2,
"date": "2021-03-16",
"room": null,
"allotment": null,
"rate": null,
"amountBeforeTax": 0.000000,
"amountAfterTax": 0.000000,
"centralAccommodationPercentageCommission": null,
"centralAccommodationAmountCommission": null,
"centralBoardPercentageCommission": null,
"centralBoardAmountCommission": null,
"companyAccommodationPercentageCommission": null,
"companyAccommodationAmountCommission": null,
"companyBoardPercentageCommission": null,
"companyBoardAmountCommission": null,
"bookerAccommodationPercentageCommission": null,
"bookerAccommodationAmountCommission": null,
"bookerBoardPercentageCommission": null,
"bookerBoardAmountCommission": null,
"billToAccommodationPercentageCommission": null,
"billToAccommodationAmountCommission": null,
"billToBoardPercentageCommission": null,
"billToBoardAmountCommission": null,
"billToAccommodationPercentageDiscount": null,
"billToAccommodationAmountDiscount": null,
"billToBoardPercentageDiscount": null,
"billToBoardAmountDiscount": null,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"board": {
"id": 5,
"code": "RO",
"name": "Room Only",
"serviceList": null
},
"boardPriceAdult": 0.000000,
"boardPriceJunior": 0.000000,
"boardPriceChild": 0.000000,
"boardPriceInfant": 0.000000,
"paymentType": {
"id": 1,
"code": "G",
"name": "Pay Guest",
"nameI18n": "Pay Guest"
},
"propertyPolicy": {
"id": 12,
"code": "24H",
"name": "24 Hours 1 Night"
},
"propertySource": {
"id": 13,
"code": "PHO",
"name": "Phone"
},
"propertySegment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"propertyChannel": {
"id": 12,
"code": "WEBM",
"name": "Booking Engine Mobile"
},
"booker": null,
"billTo": null,
"central": null,
"company": null,
"reservationGroup": null
}
],
"reservationRoomStayServiceList": null,
"createdDate": "2021-04-15T14:30:14.781Z",
"modifiedDate": "2021-04-16T14:18:45.026Z"
}
]
}