Operation
Returns a paginated list of ReservationRoomStay
GET
https://{environment}.ulysescloud.com/api/v1/chain/{chainId}/property/{propertyId}/reservationRoomStay
Request
| Property | Type | Required | Default value | Description |
|---|---|---|---|---|
| chainId | int | true | Unique identificator of the chain. | |
| propertyId | int | true | Unique identificator of the property. | |
otaLocator | String | false | ||
pmsLocator | String | false | ||
crsLocator | String | false | ||
cmLocator | String | false | ||
| arrivalFrom | date | false | ||
| arrivalTo | date | false | ||
| departureFrom | date | false | ||
| departureTo | date | false | ||
| stayFrom | date | false | ||
| stayTo | date | false | ||
| createdFrom | dateTime | false | ||
| createdTo | dateTime | false | ||
| reservationStatusTypeId | int | false | ||
| reservationSituationTypeId | int | false | ||
| offset | int | false | 0 | |
| limit | int | false | 10 | |
| sort | string | false | Id | |
| sortMode | string | false | Desc |
Example request
GET https://prod.ulysescloud.com/api/v1/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": 38,
"offset": 0,
"limit": 1,
"list": [
{
"id": 1,
"reservationStatusType": {
"id": 4,
"code": "COM",
"name": "Committed"
},
"reservationSituationType": {
"id": 2,
"code": "CO",
"name": "CheckOut"
},
"arrival": "2019-04-20",
"departure": "2019-04-21",
"arrivalTime": null,
"departureTime": null,
"quantity": 1,
"accommodation": {
"id": 24,
"name": "Double"
},
"adult": 30,
"junior": 0,
"child": 0,
"infant": 0,
"productFee": {
"id": 24,
"name": "Double"
},
"adultFee": 2,
"juniorFee": 0,
"childFee": 0,
"infantFee": 0,
"pmsLocator": "0000000001/1",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"remark": null,
"mainProductBoard": null,
"reservationRoomStayGuests": [
{
"id": 1,
"documentType": {
"id": 2,
"code": "2",
"name": "Passport"
},
"documentNumber": "MNZLDtSw",
"givenName": "Jeremy",
"middleName": "Stéphanie",
"surName": "Gardner",
"genderType": {
"id": 2,
"code": "F",
"name": "Female"
},
"birthDate": "2001-04-30",
"birthCountry": {
"id": 231,
"code": "VEN",
"name": "VENEZUELA"
},
"birthPlace": "Waterbury",
"effectiveDate": "2018-04-30",
"expireDate": "2018-04-30",
"street": "03 Rusk Park",
"city": "Waterbury",
"stateProvName": "Connecticut",
"stateProv": null,
"country": {
"id": 231,
"code": "VEN",
"name": "VENEZUELA"
},
"postalCode": "6726",
"nationalityCountry": {
"id": 231,
"code": "VEN",
"name": "VENEZUELA"
},
"ocr": null,
"email": "phill8m@usnews.com",
"phoneNumber": "1-(203)205-9014"
},
{
"id": 2,
"documentType": {
"id": 2,
"code": "2",
"name": "Passport"
},
"documentNumber": "aohhZTZj",
"givenName": "Gregory",
"middleName": "Marie-françoise",
"surName": "Owens",
"genderType": {
"id": 2,
"code": "F",
"name": "Female"
},
"birthDate": "2001-04-30",
"birthCountry": {
"id": 102,
"code": "IRQ",
"name": "IRAQ"
},
"birthPlace": "Kansas City",
"effectiveDate": "2018-04-30",
"expireDate": "2018-04-30",
"street": "47 Dexter Place",
"city": "Kansas City",
"stateProvName": "Missouri",
"stateProv": null,
"country": {
"id": 102,
"code": "IRQ",
"name": "IRAQ"
},
"postalCode": "64199",
"nationalityCountry": {
"id": 102,
"code": "IRQ",
"name": "IRAQ"
},
"ocr": null,
"email": "jmartinezp7@bigcartel.com",
"phoneNumber": "1-(816)452-4459"
},
{
"id": 1316,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1317,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1318,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1319,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1320,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1321,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1322,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1323,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1324,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1325,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1326,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1327,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1328,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1329,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1330,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1331,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1332,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1333,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1334,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1335,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1336,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1337,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1338,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1339,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1340,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1341,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1342,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
},
{
"id": 1343,
"documentType": null,
"documentNumber": null,
"givenName": "",
"middleName": "",
"surName": "",
"genderType": null,
"birthDate": null,
"birthCountry": null,
"birthPlace": null,
"effectiveDate": null,
"expireDate": null,
"street": null,
"city": null,
"stateProvName": null,
"stateProv": null,
"country": null,
"postalCode": null,
"nationalityCountry": null,
"ocr": null,
"email": null,
"phoneNumber": null
}
],
"reservationRoomStayDaily": [
{
"id": 1,
"date": "2019-04-20",
"allotment": null,
"rate": {
"id": 1,
"code": "BAR",
"name": "Best Rate Available"
},
"price": 146,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"productBoard": null,
"boardPriceAdult": null,
"boardPriceJunior": null,
"boardPriceChild": null,
"boardPriceInfant": null,
"paymentType": {
"id": 2,
"code": "GG",
"name": "Pay Guest Guest"
},
"propertyPolicy": {
"id": 57,
"code": "24H",
"name": "24 Hours Before Arrival"
},
"propertySource": {
"id": 13,
"code": "COM",
"name": "Company"
},
"propertySegment": {
"id": 24,
"code": "HACC",
"name": "Home Account"
},
"propertyChannel": {
"id": 24,
"code": "IDS",
"name": "IDS"
},
"postingDate": "2019-04-30"
}
],
"reservationRoomStayServiceList": null
}
]
}