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": 25,
"offset": 1,
"limit": 10,
"list": [
{
"id": 2,
"createdDate": 2021-03-05T07:27:37.536Z,
"modifiedDate": null,
"reservationStatusType": {
"id": 5,
"code": "CO",
"name": "CheckedOut",
"nameI18n": "CheckedOut",
"colorCode": "#757575"
},
"arrival": "2020-05-10",
"departure": "2020-05-13",
"arrivalTime": null,
"departureTime": null,
"quantity": 1,
"accommodation": {
"id": 692,
"name": "Double Deluxe",
"roomType": {
"id": 17,
"name": "Double",
"nameI18n": "Double",
"mainImage": "1/2/propertyroomtypeimages/1cb6be6d-5056-484d-9c95-c574f4603a35.jpg"
}
},
"room": {
"id": 10,
"code": "110",
"name": "110",
"roomSpaceStatusType": {
"id": 2,
"code": "DI",
"name": "Dirty",
"nameI18n": "Dirty"
},
"reservationRoomStay": null,
"roomSituationType": {
"id": 1,
"code": "EM",
"name": "Empty",
"nameI18n": "Empty"
}
},
"adult": 1,
"junior": 0,
"child": 0,
"infant": 0,
"productFee": {
"id": 797,
"name": "City Tax Mallorca"
},
"adultFee": 0,
"juniorFee": 0,
"childFee": 0,
"infantFee": 0,
"pmsLocator": "ALI00000001/2",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"remark": null,
"reservationRoomStayGuests": [
{
"id": 3,
"documentType": {
"id": 2,
"code": "P",
"name": "Passport",
"nameI18n": "Passport"
},
"documentNumber": "HtXlGovS",
"givenName": "Lisa",
"surName": "Bécassine",
"secondSurName": "Mcdonald",
"genderType": {
"id": 1,
"code": "M",
"name": "Male",
"nameI18n": "Male"
},
"birthDate": "2002-06-09",
"birthCountryCode": "EG",
"birthPlace": "San Jose",
"effectiveDate": "2019-06-09",
"expireDate": "2019-06-09",
"street": "32 Monica Road",
"city": "San Jose",
"stateProvName": "California",
"stateProvCode": null,
"countryCode": "EG",
"postalCode": "95133",
"nationalityCountryCode": "EG",
"countryOfIssuanceCode": "EG",
"ocr": null,
"email": "nwestrb@lycos.com",
"phoneNumber": "1-(408)161-2172"
}
],
"mainBoard": {
"id": 7,
"code": null,
"name": "HalfBoard",
"serviceList": [
{
"id": 63,
"code": "BRK",
"name": "Breakfast"
},
{
"id": 68,
"code": "DINNER",
"name": "Dinner"
}
]
},
"reservationRoomStayDaily": [
{
"id": 4,
"date": "2020-05-10",
"room": {
"id": 10,
"code": "110",
"name": "110",
"roomSpaceStatusType": {
"id": 2,
"code": "DI",
"name": "Dirty",
"nameI18n": "Dirty"
},
"reservationRoomStay": null,
"roomSituationType": {
"id": 1,
"code": "EM",
"name": "Empty",
"nameI18n": "Empty"
}
},
"allotment": null,
"rate": {
"id": 2,
"code": "BAR",
"name": "Best Available Rate"
},
"amountAfterTax": 206.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro"
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"board": {
"id": 7,
"code": null,
"name": "HalfBoard",
"serviceList": [
{
"id": 63,
"code": "BRK",
"name": "Breakfast"
},
{
"id": 68,
"code": "DINNER",
"name": "Dinner"
}
]
},
"boardPriceAdult": 56.000000,
"boardPriceJunior": 77.000000,
"boardPriceChild": 0.000000,
"boardPriceInfant": 0.000000,
"paymentType": {
"id": 2,
"code": "GG",
"name": "Pay Guest Guest",
"nameI18n": "Pay Guest Guest"
},
"propertyPolicy": {
"id": 12,
"code": "24H",
"name": "24 Hours 1 Night"
},
"propertySource": {
"id": 13,
"code": "PHO",
"name": "Phone"
},
"propertySegment": {
"id": 18,
"code": "WEDD",
"name": "Wedding"
},
"propertyChannel": {
"id": 10,
"code": "OTA",
"name": "Online Travel Agency"
},
"booker": null,
"billTo": {
"id": 994,
"name": "Janyx",
"code": "JANYX3",
"taxId": "84105983",
"companyEmailList": [
{
"id": 994,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal",
"nameI18n": "Personal"
},
"email": "jrobinsonra@mit.edu",
"remark": null
}
],
"companyAddressList": [
{
"id": 994,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home"
},
"street": "48 Northwestern Street",
"city": "Salt Lake City",
"stateProvName": "Utah",
"stateProvCode": null,
"postalCode": "84105",
"countryCode": "CY",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 994,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home",
"nameI18n": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice",
"nameI18n": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(801)421-8231",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 984,
"communicationLocationType": null,
"street": "48 Northwestern Street",
"city": "Salt Lake City",
"stateProvName": "Utah",
"stateProvCode": null,
"postalCode": "84105",
"countryCode": "SH",
"remark": "Address Remark"
},
"remark": "Company Remarks"
},
"central": null,
"company": null,
"reservationGroup": null
},
{
"id": 5,
"date": "2020-05-11",
"room": {
"id": 10,
"code": "110",
"name": "110",
"roomSpaceStatusType": {
"id": 2,
"code": "DI",
"name": "Dirty",
"nameI18n": "Dirty"
},
"reservationRoomStay": null,
"roomSituationType": {
"id": 1,
"code": "EM",
"name": "Empty",
"nameI18n": "Empty"
}
},
"allotment": null,
"rate": {
"id": 2,
"code": "BAR",
"name": "Best Available Rate"
},
"amountAfterTax": 206.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro"
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"board": {
"id": 7,
"code": null,
"name": "HalfBoard",
"serviceList": [
{
"id": 63,
"code": "BRK",
"name": "Breakfast"
},
{
"id": 68,
"code": "DINNER",
"name": "Dinner"
}
]
},
"boardPriceAdult": 56.000000,
"boardPriceJunior": 77.000000,
"boardPriceChild": 0.000000,
"boardPriceInfant": 0.000000,
"paymentType": {
"id": 2,
"code": "GG",
"name": "Pay Guest Guest",
"nameI18n": "Pay Guest Guest"
},
"propertyPolicy": {
"id": 12,
"code": "24H",
"name": "24 Hours 1 Night"
},
"propertySource": {
"id": 13,
"code": "PHO",
"name": "Phone"
},
"propertySegment": {
"id": 18,
"code": "WEDD",
"name": "Wedding"
},
"propertyChannel": {
"id": 10,
"code": "OTA",
"name": "Online Travel Agency"
},
"booker": null,
"billTo": {
"id": 994,
"name": "Janyx",
"code": "JANYX3",
"taxId": "84105983",
"companyEmailList": [
{
"id": 994,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal",
"nameI18n": "Personal"
},
"email": "jrobinsonra@mit.edu",
"remark": null
}
],
"companyAddressList": [
{
"id": 994,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home"
},
"street": "48 Northwestern Street",
"city": "Salt Lake City",
"stateProvName": "Utah",
"stateProvCode": null,
"postalCode": "84105",
"countryCode": "CY",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 994,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home",
"nameI18n": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice",
"nameI18n": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(801)421-8231",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 984,
"communicationLocationType": null,
"street": "48 Northwestern Street",
"city": "Salt Lake City",
"stateProvName": "Utah",
"stateProvCode": null,
"postalCode": "84105",
"countryCode": "SH",
"remark": "Address Remark"
},
"remark": "Company Remarks"
},
"central": null,
"company": null,
"reservationGroup": null
},
{
"id": 6,
"date": "2020-05-12",
"room": {
"id": 10,
"code": "110",
"name": "110",
"roomSpaceStatusType": {
"id": 2,
"code": "DI",
"name": "Dirty",
"nameI18n": "Dirty"
},
"reservationRoomStay": null,
"roomSituationType": {
"id": 1,
"code": "EM",
"name": "Empty",
"nameI18n": "Empty"
}
},
"allotment": null,
"rate": {
"id": 2,
"code": "BAR",
"name": "Best Available Rate"
},
"amountAfterTax": 206.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro"
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"board": {
"id": 7,
"code": null,
"name": "HalfBoard",
"serviceList": [
{
"id": 63,
"code": "BRK",
"name": "Breakfast"
},
{
"id": 68,
"code": "DINNER",
"name": "Dinner"
}
]
},
"boardPriceAdult": 56.000000,
"boardPriceJunior": 77.000000,
"boardPriceChild": 0.000000,
"boardPriceInfant": 0.000000,
"paymentType": {
"id": 2,
"code": "GG",
"name": "Pay Guest Guest",
"nameI18n": "Pay Guest Guest"
},
"propertyPolicy": {
"id": 12,
"code": "24H",
"name": "24 Hours 1 Night"
},
"propertySource": {
"id": 13,
"code": "PHO",
"name": "Phone"
},
"propertySegment": {
"id": 18,
"code": "WEDD",
"name": "Wedding"
},
"propertyChannel": {
"id": 8,
"code": "GDS",
"name": "Global Distribution System"
},
"booker": null,
"billTo": {
"id": 994,
"name": "Janyx",
"code": "JANYX3",
"taxId": "84105983",
"companyEmailList": [
{
"id": 994,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal",
"nameI18n": "Personal"
},
"email": "jrobinsonra@mit.edu",
"remark": null
}
],
"companyAddressList": [
{
"id": 994,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home"
},
"street": "48 Northwestern Street",
"city": "Salt Lake City",
"stateProvName": "Utah",
"stateProvCode": null,
"postalCode": "84105",
"countryCode": "CY",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 994,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home",
"nameI18n": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice",
"nameI18n": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(801)421-8231",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 984,
"communicationLocationType": null,
"street": "48 Northwestern Street",
"city": "Salt Lake City",
"stateProvName": "Utah",
"stateProvCode": null,
"postalCode": "84105",
"countryCode": "SH",
"remark": "Address Remark"
},
"remark": "Company Remarks"
},
"central": null,
"company": null,
"reservationGroup": null
}
],
"reservationRoomStayServiceList": null
}
]
}