ReservationGroup list [GET]

Operation

Information of the operation

GET

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

Request

Property	Type	Required	Type parameter	Default value
chainId	Integer	true	path parameter
propertyId	Integer	true	path parameter
search	String	false	request parameter
locator	String	false	request parameter
arrivalFrom	LocalDate	false	request parameter
arrivalTo	LocalDate	false	request parameter
departureFrom	LocalDate	false	request parameter
departureTo	LocalDate	false	request parameter
stayFrom	LocalDate	false	request parameter
stayTo	LocalDate	false	request parameter
createdFrom	LocalDateTime	false	request parameter
createdTo	LocalDateTime	false	request parameter
profileIdList	List of Integer	false	request parameter
productIdList	List of Integer	false	request parameter
reservationSituationTypeId	Integer	false	request parameter
sourceId	Integer	false	request parameter
channelId	Integer	false	request parameter
segmentId	Integer	false	request parameter
assignedUserId	Integer	false	request parameter
offset	Integer	false	request parameter	0
limit	Integer	false	request parameter	10
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/reservationGroup

Response

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Field	Type	Required	Description
id	int	true	Unique identifier for the Reservation.
reservationSituationType	ReservationSituationType	false	The situation of this group.
reservationStatusType	ReservationStatusType	true	The status of this group.
name	String	true	Name given to this group.
expiredDate	LocalDate	true	The date that this group is expired.
arrival	string	true	Date of arrival (yyyy-MM-dd).
departure	string	true	Date of departure (yyyy-MM-dd).
arrivalTime	string	false	Time of arrival (HH:mm:ss).
departureTime	string	false	Time of arrival (HH:mm:ss).
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	A few words about the group sent usually by the client.
privateRemark	string	false	A few words about the group created in the property.
reservationGroupRoomBlockList	Array of ReservationGroupRoomBlock.	true
allotment	Allotment	false	The allotment related to this group.
rate	Rate	false	The rate used in this group.
currency	Currency	true	The currency used for this group.
offer	Offer	false	The offer used in this group.
offerAmountDiscount	BigDecimal	false	Amount discount related to the offer (ie: 2€).
offerPercentDiscount	BigDecimal	false	Percent discount related to the offer (ie: 3%).
promotion	P romotion	false	The promotion used in this group.
promotionAmountDiscount	BigDecimal	false	Amount discount related to the promotion (ie: 2€).
promotionPercentDiscount	BigDecimal	false	Percent discount related to the promotion (ie: 3%).
board	Board	true	Board that applies to this group.
boardPriceAdult	BigDecimal	true	The price for each adult with this board.
boardPriceJunior	BigDecimal	true	The price for each junior with this board.
boardPriceChild	BigDecimal	true	The price for each child with this board.
boardPriceInfant	BigDecimal	true	The price for each infant with this board.
boardAmountAfterDiscountAdult	BigDecimal	false
boardAmountAfterDiscountJunior	BigDecimal	false
boardAmountAfterDiscountChild	BigDecimal	false
boardAmountAfterDiscountInfant	BigDecimal	false
boardAmountAfterTaxAdult	BigDecimal	false
boardAmountBeforeTaxAdult	BigDecimal	false
boardAmountNetAfterTaxAdult	BigDecimal	false
boardAmountNetBeforeTaxAdult	BigDecimal	false
boardAmountInvoiceAfterTaxAdult	BigDecimal	false
boardAmountInvoiceBeforeTaxAdult	BigDecimal	false
boardAmountAfterTaxJunior	BigDecimal	false
boardAmountBeforeTaxJunior	BigDecimal	false
boardAmountNetAfterTaxJunior	BigDecimal	false
boardAmountNetBeforeTaxJunior	BigDecimal	false
boardAmountInvoiceAfterTaxJunior	BigDecimal	false
boardAmountInvoiceBeforeTaxJunior	BigDecimal	false
boardAmountAfterTaxChild	BigDecimal	false
boardAmountBeforeTaxChild	BigDecimal	false
boardAmountNetAfterTaxChild	BigDecimal	false
boardAmountNetBeforeTaxChild	BigDecimal	false
boardAmountInvoiceAfterTaxChild	BigDecimal	false
boardAmountInvoiceBeforeTaxChild	BigDecimal	false
boardAmountAfterTaxInfant	BigDecimal	false
boardAmountBeforeTaxInfant	BigDecimal	false
boardAmountNetAfterTaxInfant	BigDecimal	false
boardAmountNetBeforeTaxInfant	BigDecimal	false
boardAmountInvoiceAfterTaxInfant	BigDecimal	false
boardAmountInvoiceBeforeTaxInfant	BigDecimal	false
booker	Company	false
bookerAccommodationPercentageCommission	BigDecimal	false
bookerAccommodationAmountCommission	BigDecimal	false
bookerBoardPercentageCommission	BigDecimal	false
bookerBoardAmountCommission	BigDecimal	false
billTo	Company	false
billToAccommodationPercentageCommission	BigDecimal	false
billToAccommodationAmountCommission	BigDecimal	false
billToBoardPercentageCommission	BigDecimal	false
billToBoardAmountCommission	BigDecimal	false
billToAccommodationPercentageDiscount	BigDecimal	false
billToAccommodationAmountDiscount	BigDecimal	false
billToBoardPercentageDiscount	BigDecimal	false
billToBoardAmountDiscount	BigDecimal	false
central	Company	false
centralAccommodationPercentageCommission	BigDecimal	false
centralAccommodationAmountCommission	BigDecimal	false
centralBoardPercentageCommission	BigDecimal	false
centralBoardAmountCommission	BigDecimal	false
company	Company	false
companyAccommodationPercentageCommission	BigDecimal	false
companyAccommodationAmountCommission	BigDecimal	false
companyBoardPercentageCommission	BigDecimal	false
companyBoardAmountCommission	BigDecimal	false
paymentType	PaymentType	false
policy	Policy	true
source	Source	false
segment	Segment	false
channel	Channel	false
groupInvoice	boolean	true
reservationPriceModelType	ReservationPriceModelType	true
totalQuantity	BigDecimal	false
totalQuantityConsumed	BigDecimal	false
totalQuantityAvailable	BigDecimal	false
totalAccommodationPrice	BigDecimal	false
totalBoardPrice	BigDecimal	false
totalServicePrice	BigDecimal	false
totalStayServicePrice	BigDecimal	false
totalPrice	BigDecimal	false
reservationGroupHolder	ReservationGroupHolder	true	The holder of this group.
createdDate	LocalDateTime	true
modifiedDate	LocalDateTime	false
cutOffDate	LocalDateTime	false

Example response

{
    "count": 1,
    "offset": 0,
    "limit": 10,
    "list": [
        {
            "id": 1,
            "reservationSituationType": null,
            "reservationStatusType": {
                "id": 1,
                "code": "RES",
                "name": "Reserved",
                "nameI18n": "Reserved",
                "colorCode": "#43a047"
            },
            "name": "test",
            "expiredDate": null,
            "arrival": "2023-10-24",
            "departure": "2023-10-25",
            "arrivalTime": null,
            "departureTime": null,
            "pmsLocator": "GSEP00000001",
            "crsLocator": null,
            "otaLocator": null,
            "cmLocator": null,
            "remark": null,
            "privateRemark": null,
            "reservationGroupRoomBlockList": [
			{
        		"id": 1,
		        "productAccommodation": {
		            "id": 722,
		            "chainProductId": 49,
		            "code": "DBL",
		            "name": "Double",
		            "nameI18n": "Double",
		            "productType": {
		                "id": 1,
		                "code": "ACC",
		                "name": "Accommodation",
        		        "nameI18n": "Accommodation"
		            }
		        },
        		"propertyRoomSubType": null,
		        "adult": 2,
		        "junior": 0,
		        "child": 0,
        		"infant": 0,
		        "reservationGroupRoomBlockDailyList": [
        		    {
                		"id": 1,
		                "date": "2024-01-02",
        		        "quantity": 1,
                		"price": 800.000000,
			            "quantityConsumed": 1,
            		    "quantityAvailable": 0
		            },
        		    {
		                "id": 3,
        		        "date": "2024-01-03",
                		"quantity": 0,
		                "price": 0.000000,
        		        "quantityConsumed": 0,
                		"quantityAvailable": 0
		            },
        		    {
                		"id": 4,
		                "date": "2024-01-04",
        		        "quantity": 0,
                		"price": 0.000000,
		                "quantityConsumed": 0,
        		        "quantityAvailable": 0
		            },
        		    {
                		"id": 5,
		                "date": "2024-01-05",
        		        "quantity": 0,
                		"price": 0.000000,
		                "quantityConsumed": 0,
        		        "quantityAvailable": 0
		            }
        		]
		    }
			],
            "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
        }
    ]
}