Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Information of the operation

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.reservation


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/reservationGroup



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter

propertyIdIntegertruepath parameter

searchStringfalserequest parameter

locatorStringfalserequest parameter

arrivalFromLocalDatefalserequest parameter

arrivalToLocalDatefalserequest parameter

departureFromLocalDatefalserequest parameter

departureToLocalDatefalserequest parameter

stayFromLocalDatefalserequest parameter

stayToLocalDatefalserequest parameter

createdFromLocalDateTimefalserequest parameter

createdToLocalDateTimefalserequest parameter

profileIdListList of Integerfalserequest parameter

productIdListList of Integerfalserequest parameter

reservationSituationTypeIdIntegerfalserequest parameter

sourceIdIntegerfalserequest parameter

channelIdIntegerfalserequest parameter

segmentIdIntegerfalserequest parameter

assignedUserIdIntegerfalserequest parameter

offsetIntegerfalserequest parameter0
limitIntegerfalserequest parameter10
sortStringfalserequest parameter

sortModeStringfalserequest parameter


Example request

Code Block
languagepowershell
themeDJango
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservationGroup



Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity

Insert excerpt
ReservationGroup
ReservationGroup
nopaneltrue

Example response

Code Block
themeDJango
{
	    "count": 221,
    	"offset": 0,
   	 "limit": 110,
    	"list": [
        {
		
            "id": 241,
		"createdDate": 2021-03-05T07:27:37.536Z,
		"modifiedDate
            "reservationSituationType": null,
		"reservationSituationType
            "reservationStatusType": {
			
                "id": 0,
			"active": null,
			"inactiveReason": null,
			1,
                "code": "RES",
			"name": "Reserved"
		},
		                "name": "test2Reserved",
		"expiredDate": null,
		"arrival                "nameI18n": "2020-05-30Reserved",
		"departure                "colorCode": "2020-06-01",
		"arrivalTime": null,
		"departureTime": null,
		"pmsLocator#43a047"
            },
            "name": "GALI00000024test",
		"crsLocator
            "expiredDate": null,
		"otaLocator
            "arrival": null,
		"cmLocator": null,
		"remark": "this is a reservation remark",
		"privateRemark": null,
		"reservationGroupRoomBlockList": [{
			"id": 16,
			"productOccupancy": {
				"id": 3,
				"product": {
					"id": 677,
					"code": "DBL",
					"name": "Double",
					"productType": {
						"id": 1,
						"code": "ACC",
						"name": "Accommodation",
						"nameI18n": "Accommodation"
					}
				},
				"adult": 1,
				"junior": 0,
				"child": 0,
				"infant": 0
			},
			"reservationGroupRoomBlockDailyList": [{
					"id": 40,
					"date": "2020-05-30",
					"quantity": 0,
					"price": 0.000000,
					"quantityConsumed": 0,
					"quantityAvailable": 0
				},
				{
					"id": 41,
					"date": "2020-05-31",
					"quantity": 0,
					"price": 0.000000,
					"quantityConsumed": 0,
					"quantityAvailable": 0
				}
			]
		}],
		"allotment": null,
		"rate": {
			"id": 2,
			"code": "BAR",
			"name": "Best Available Rate"
		},
		"currency": {
			"id": 1,
			"code": "EUR",
			"name": "Euro",
			"nameI18n": "Euro"
		},
		"offer": {
			"id": 17,
			"code": "MIN3N",
			"name": "Minimum 3 nights"
		},
		"offerAmountDiscount": 0.000000,
		"offerPercentDiscount": 15.000000,
		"promotion": null,
		"promotionAmountDiscount": null,
		"promotionPercentDiscount": null,
		"board": {
			"id": 6,
			"code": "BB",
			"name": "Bed And Breakfast",
			"serviceList": [{
				"id": 63,
				"code": "BRK",
				"name": "Breakfast"
			}]
		},
		"boardPriceAdult": 11.000000,
		"boardPriceJunior": 37.000000,
		"boardPriceChild": 0.000000,
		"boardPriceInfant": 0.000000,
		"booker": {
			"id": 27,
			"name": "Abata",
			"code": "ABATA",
			"taxId": "2322814",
			"companyEmailList": [{
				"id": 27,
				"primary": true,
				"emailAddressType": {
					"id": 1,
					"code": "1",
					"name": "Personal",
					"nameI18n": "Personal"
				},
				"email": "eburnsd@wikia.com",
				"remark": null
			}],
			"companyAddressList": [{
				"id": 27,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home"
				},
				"street": "4 Independence Lane",
				"city": "Richmond",
				"stateProvName": "Virginia",
				"stateProvCode": null,
				"postalCode": "23228",
				"countryCode": "IN",
				"remark": "Address Remark"
			}],
			"companyPhoneList": [{
				"id": 27,
				"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-(804)542-5801",
				"extension": "1",
				"remark": "Phone Remark"
			}],
			"companyTaxAddress": {
				"id": 17,
				"communicationLocationType": null,
				"street": "4 Independence Lane",
				"city": "Richmond",
				"stateProvName": "Virginia",
				"stateProvCode": null,
				"postalCode": "23228",
				"countryCode": "IR",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks"
		},
		"bookerAccommodationPercentageCommission": null,
		"bookerAccommodationAmountCommission": null,
		"bookerBoardPercentageCommission": null,
		"bookerBoardAmountCommission": null,
		"billTo": {
			"id": 11,
			"name": "Tesipro",
			"code": "TESIP",
			"taxId": "1234",
			"companyEmailList": [{
				"id": 11,
				"primary": true,
				"emailAddressType": {
					"id": 1,
					"code": "1",
					"name": "Personal",
					"nameI18n": "Personal"
				},
				"email": "creynolds21@g.co",
				"remark": null
			}],
			"companyAddressList": [{
				"id": 11,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home"
				},
				"street": "199 Hermina Place",
				"city": "Mobile",
				"stateProvName": "Gerona",
				"stateProvCode": "ES-GI",
				"postalCode": "36610",
				"countryCode": "ES",
				"remark": "Address Remark"
			}],
			"companyPhoneList": [{
				"id": 11,
				"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-(251)190-6133",
				"extension": "1",
				"remark": "Phone Remark"
			}],
			"companyTaxAddress": {
				"id": 1,
				"communicationLocationType": null,
				"street": "199 Hermina Place",
				"city": "Mobile",
				"stateProvName": "Orense",
				"stateProvCode": "ES-OR",
				"postalCode": "36610",
				"countryCode": "ES",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks"
		},
		"billToAccommodationPercentageCommission": null,
		"billToAccommodationAmountCommission": null,
		"billToBoardPercentageCommission": null,
		"billToBoardAmountCommission": null,
		"billToAccommodationPercentageDiscount": null,
		"billToAccommodationAmountDiscount": null,
		"billToBoardPercentageDiscount": null,
		"billToBoardAmountDiscount": null,
		"central": null,
		"centralAccommodationPercentageCommission": null,
		"centralAccommodationAmountCommission": null,
		"centralBoardPercentageCommission": null,
		"centralBoardAmountCommission": null,
		"company": null,
		"companyAccommodationPercentageCommission": null,
		"companyAccommodationAmountCommission": null,
		"companyBoardPercentageCommission": null,
		"companyBoardAmountCommission": null,
		"paymentType": {
			"id": 6,
			"code": "AC",
			"name": "Pay Agency Company",
			"nameI18n": "Pay Agency Company"
		},
		"policy": {
			"id": 12,
			"code": "24H",
			"name": "24 Hours 1 Night"
		},
		"source": {
			"id": 9,
			"code": "COM",
			"name": "Company"
		},
		"segment": {
			"id": 18,
			"code": "WEDD",
			"name": "Wedding"
		},
		"channel": {
			"id": 9,
			"code": "IDS",
			"name": "Internet Distribution System"
		},
		"groupInvoice": false,
		"reservationPriceModelType": {
			"id": 1,
			"code": "AAT",
			"name": "Amount After Tax"
		},
		"totalQuantity": 0,
		"totalQuantityConsumed": 0,
		"totalQuantityAvailable": 0,
		"totalPrice": 0.000000,
		"reservationGroupHolder": null
	}"2023-10-24",
            "departure": "2023-10-25",
            "arrivalTime": null,
            "departureTime": null,
            "pmsLocator": "GSEP00000001",
            "crsLocator": null,
            "otaLocator": null,
            "cmLocator": null,
            "remark": null,
            "privateRemark": null,
            "reservationGroupRoomBlockList": null,
            "allotment": null,
            "rate": 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,
                "chainBoardId": 1,
                "code": "RO",
                "name": "Room Only",
                "nameI18n": "Room Only",
                "serviceList": null
            },
            "boardPriceAdult": 0.000000,
            "boardPriceJunior": 0.000000,
            "boardPriceChild": 0.000000,
            "boardPriceInfant": 0.000000,
            "boardAmountAfterDiscountAdult": 0.000000,
            "boardAmountAfterDiscountJunior": 0.000000,
            "boardAmountAfterDiscountChild": 0.000000,
            "boardAmountAfterDiscountInfant": 0.000000,
            "boardAmountAfterTaxAdult": 0.000000,
            "boardAmountBeforeTaxAdult": 0.000000,
            "boardAmountNetAfterTaxAdult": 0.000000,
            "boardAmountNetBeforeTaxAdult": 0.000000,
            "boardAmountInvoiceAfterTaxAdult": 0.000000,
            "boardAmountInvoiceBeforeTaxAdult": 0.000000,
            "boardAmountAfterTaxJunior": 0.000000,
            "boardAmountBeforeTaxJunior": 0.000000,
            "boardAmountNetAfterTaxJunior": 0.000000,
            "boardAmountNetBeforeTaxJunior": 0.000000,
            "boardAmountInvoiceAfterTaxJunior": 0.000000,
            "boardAmountInvoiceBeforeTaxJunior": 0.000000,
            "boardAmountAfterTaxChild": 0.000000,
            "boardAmountBeforeTaxChild": 0.000000,
            "boardAmountNetAfterTaxChild": 0.000000,
            "boardAmountNetBeforeTaxChild": 0.000000,
            "boardAmountInvoiceAfterTaxChild": 0.000000,
            "boardAmountInvoiceBeforeTaxChild": 0.000000,
            "boardAmountAfterTaxInfant": 0.000000,
            "boardAmountBeforeTaxInfant": 0.000000,
            "boardAmountNetAfterTaxInfant": 0.000000,
            "boardAmountNetBeforeTaxInfant": 0.000000,
            "boardAmountInvoiceAfterTaxInfant": 0.000000,
            "boardAmountInvoiceBeforeTaxInfant": 0.000000,
            "booker": null,
            "bookerAccommodationPercentageCommission": null,
            "bookerAccommodationAmountCommission": null,
            "bookerBoardPercentageCommission": null,
            "bookerBoardAmountCommission": null,
            "billTo": null,
            "billToAccommodationPercentageCommission": null,
            "billToAccommodationAmountCommission": null,
            "billToBoardPercentageCommission": null,
            "billToBoardAmountCommission": null,
            "billToAccommodationPercentageDiscount": null,
            "billToAccommodationAmountDiscount": null,
            "billToBoardPercentageDiscount": null,
            "billToBoardAmountDiscount": null,
            "central": null,
            "centralAccommodationPercentageCommission": null,
            "centralAccommodationAmountCommission": null,
            "centralBoardPercentageCommission": null,
            "centralBoardAmountCommission": null,
            "company": null,
            "companyAccommodationPercentageCommission": null,
            "companyAccommodationAmountCommission": null,
            "companyBoardPercentageCommission": null,
            "companyBoardAmountCommission": null,
            "paymentType": {
                "id": 1,
                "code": "G",
                "name": "Pay Guest",
                "nameI18n": "Pay Guest"
            },
            "policy": {
                "id": 12,
                "code": "24H",
                "name": "24 Hours 1 Night"
            },
            "source": {
                "id": 8,
                "code": "AGE",
                "name": "Agency"
            },
            "segment": {
                "id": 22,
                "code": "CRU",
                "name": "Cruise"
            },
            "channel": {
                "id": 7,
                "code": "CRS",
                "name": "Central ReservationSystem"
            },
            "groupInvoice": false,
            "reservationPriceModelType": {
                "id": 1,
                "code": "AAT",
                "name": "Amount After Tax"
            },
            "totalQuantity": 0,
            "totalQuantityConsumed": 0,
            "totalQuantityAvailable": 0,
            "totalAccommodationPrice": 0.000000,
            "totalBoardPrice": 0.000000,
            "totalServicePrice": 0.000000,
            "totalStayServicePrice": 0.000000,
            "totalPrice": 0.000000,
            "reservationGroupHolder": null,
            "createdDate": "2023-12-05T15:06:40.537Z",
            "modifiedDate": null
        }
    ]
}