Rate GetById [GET]

Operation

Information of the operation

GET Request

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

Request

Property	Type	Required	Type parameter	Description
chainId	Integer	true	path parameter	Unique identificator of the chain.
propertyId	Integer	true	path parameter	Unique identificator of the property.
rateId	Integer	true	path parameter	Unique identificator of the rate.

Example Single Property request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/rate/1

Response

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

Entity

Field	Type	Required	Description
id	int	true	Id of the Rate
code	string	true	Code of the Rate
name	string	true	Name of the Rate
rateType	RateType	true	RateType of the ChainRate that belongs this Rate
releaseDay	int	true	ReleaseDay of the Offer
deadLineDay	int	true	DeadLineDay of the Offer
startDate	LocalDate	true	StartDate of the Offer
endDate	LocalDate	true	EndDate of the Offer
startSellDate	LocalDate	false	StartSellDate of the Offer
endSellDate	LocalDate	false	EndSellDate of the Offer
propertyId	int	false	Id of the property (Only for multiproperty request)

Example response

{
"id" : 1,
"createdDate" : "2024-11-12T08:47:21.274Z",
"createdUser" : 1,
"property" : null,
"chainRate" : {
"id" : 1,
"createdDate" : "2024-11-12T08:47:21.096Z",
"createdUser" : 1,
"chain" : null,
"code" : "BAR",
"name" : "Best Available Rate",
"nameI18nId" : 11057,
"nameI18n" : "Best Available Rate",
"descriptionI18nId" : 11058,
"chainRateType" : {
"id" : 2,
"createdDate" : "2024-11-12T08:43:11.662Z",
"createdUser" : 1,
"code" : "CLU",
"name" : "Club/Concierge",
"nameI18nId" : 9079,
"nameI18n" : "Club/concierge",
"descriptionI18nId" : 9080,
"order" : 2
},
"startDate" : "2022-01-01",
"endDate" : "2025-12-31",
"currency" : {
"id" : 1,
"codeISO4217" : "EUR",
"name" : "Euro",
"nameI18n" : "Euro",
"decimalPlaces" : 2,
"symbol" : "€",
"numberISO4217" : "978"
},
"releaseDay" : 0,
"deadLineDay" : 0,
"minStay" : 0,
"maxStay" : 0,
"manual" : true,
"internalUse" : false,
"combinable" : true,
"chainPolicy" : {
"id" : 6,
"createdDate" : "2024-11-12T08:43:10.532Z",
"createdUser" : 1,
"chain" : null,
"code" : "24H",
"name" : "24 Hours 1 Night",
"nameI18nId" : 8915,
"nameI18n" : "24 Hours 1 Night",
"descriptionI18nId" : 8916,
"nonRefundable" : false,
"deadLineDay" : 1,
"deadLineHour" : 0,
"colorCode" : "#43A047",
"order" : 6,
"chargeValue" : 100.000000,
"policyChargeType" : null,
"propertyPolicySet" : null
},
"chainSource" : {
"id" : 5,
"createdDate" : "2024-11-12T08:43:11.031Z",
"createdUser" : 1,
"code" : "EMA",
"name" : "Email",
"nameI18nId" : 8963,
"nameI18n" : "Email",
"descriptionI18nId" : 8964,
"colorCode" : "#00ACC1",
"order" : 5,
"propertySourceSet" : null
},
"chainSegment" : {
"id" : 9,
"createdDate" : "2024-11-12T08:43:11.143Z",
"createdUser" : 1,
"code" : "CAGE",
"name" : "Company Agent",
"nameI18nId" : 8985,
"nameI18n" : "Company Agent",
"descriptionI18nId" : 8986,
"colorCode" : "#FDD835",
"order" : 9,
"sumAsHouseUse" : false,
"propertySegmentSet" : null
},
"priceModelType" : {
"id" : 1,
"code" : "OCC",
"name" : "Occupancy",
"nameI18n" : "Occupancy"
},
"negotiated" : false,
"productPackage" : false,
"groupBoardInAccommodation" : true,
"boardAmountIncluded" : false,
"order" : 1,
"active" : true,
"chainRateChainProductIncludedSet" : null,
"chainRateChainBoardAllowedSet" : null,
"chainRateProfileSet" : null,
"chainRateProfileExcludedSet" : null,
"chainRateChainProfileGroupSet" : null,
"rateSet" : null
},
"name" : "Best Available Rate",
"nameI18nId" : 11059,
"nameI18n" : "Best Available Rate",
"descriptionI18nId" : 11060,
"chainRateType" : {
"id" : 2,
"createdDate" : "2024-11-12T08:43:11.662Z",
"createdUser" : 1,
"code" : "CLU",
"name" : "Club/Concierge",
"nameI18nId" : 9079,
"nameI18n" : "Club/concierge",
"descriptionI18nId" : 9080,
"order" : 2
},
"startDate" : "2022-01-01",
"endDate" : "2025-12-31",
"currency" : {
"id" : 1,
"codeISO4217" : "EUR",
"name" : "Euro",
"nameI18n" : "Euro",
"decimalPlaces" : 2,
"symbol" : "€",
"numberISO4217" : "978"
},
"releaseDay" : 0,
"deadLineDay" : 0,
"minStay" : 0,
"maxStay" : 0,
"manual" : true,
"internalUse" : false,
"combinable" : true,
"propertyPolicy" : {
"id" : 6,
"createdDate" : "2024-11-12T08:43:18.907Z",
"createdUser" : 1,
"property" : null,
"chainPolicy" : {
"id" : 6,
"createdDate" : "2024-11-12T08:43:10.532Z",
"createdUser" : 1,
"chain" : null,
"code" : "24H",
"name" : "24 Hours 1 Night",
"nameI18nId" : 8915,
"nameI18n" : "24 Hours 1 Night",
"descriptionI18nId" : 8916,
"nonRefundable" : false,
"deadLineDay" : 1,
"deadLineHour" : 0,
"colorCode" : "#43A047",
"order" : 6,
"chargeValue" : 100.000000,
"policyChargeType" : null,
"propertyPolicySet" : null
},
"active" : true,
"propertyPolicyDailySet" : null,
"propertyPreferenceSet" : null
},
"propertySource" : {
"id" : 5,
"createdDate" : "2024-11-12T08:43:18.986Z",
"createdUser" : 1,
"property" : null,
"chainSource" : {
"id" : 5,
"createdDate" : "2024-11-12T08:43:11.031Z",
"createdUser" : 1,
"code" : "EMA",
"name" : "Email",
"nameI18nId" : 8963,
"nameI18n" : "Email",
"descriptionI18nId" : 8964,
"colorCode" : "#00ACC1",
"order" : 5,
"propertySourceSet" : null
},
"active" : true,
"reservationRoomStayDailySet" : null,
"propertyPreferenceSet" : null
},
"propertySegment" : {
"id" : 9,
"createdDate" : "2024-11-12T08:43:18.970Z",
"modifiedDate" : "2024-11-12T08:43:18.970Z",
"createdUser" : 1,
"property" : null,
"chainSegment" : {
"id" : 9,
"createdDate" : "2024-11-12T08:43:11.143Z",
"createdUser" : 1,
"code" : "CAGE",
"name" : "Company Agent",
"nameI18nId" : 8985,
"nameI18n" : "Company Agent",
"descriptionI18nId" : 8986,
"colorCode" : "#FDD835",
"order" : 9,
"sumAsHouseUse" : false,
"propertySegmentSet" : null
},
"active" : true,
"reservationRoomStayDailySet" : null,
"propertyPreferenceSet" : null
},
"priceModelType" : {
"id" : 1,
"code" : "OCC",
"name" : "Occupancy",
"nameI18n" : "Occupancy"
},
"negotiated" : false,
"productPackage" : false,
"groupBoardInAccommodation" : true,
"boardAmountIncluded" : false,
"active" : true,
"order" : 1,
"rateProductServiceSet" : null,
"rateProductOccupancySet" : null,
"rateProductIncludedSet" : [ ],
"rateBoardAllowedSet" : [ {
"id" : 1,
"createdDate" : "2024-11-12T08:47:21.657Z",
"createdUser" : 1,
"board" : {
"id" : 1,
"createdDate" : "2024-11-12T08:43:18.129Z",
"createdUser" : 1,
"property" : null,
"chainBoard" : {
"id" : 1,
"createdDate" : "2024-11-12T08:43:10.326Z",
"createdUser" : 1,
"code" : "RO",
"name" : "Room Only",
"nameI18nId" : 8901,
"nameI18n" : "Room Only",
"folioType" : {
"id" : 1,
"code" : "M",
"name" : "Main",
"nameI18n" : "Main",
"colorCode" : "#43a047"
},
"boardSet" : null,
"chainBoardChainProductBreakdownSet" : null
},
"amountIncludedInAccommodation" : true,
"active" : true,
"boardProductBreakdownSet" : null,
"boardAvailabilitySet" : null
}
}, {
"id" : 2,
"createdDate" : "2024-11-12T08:47:21.657Z",
"createdUser" : 1,
"board" : {
"id" : 2,
"createdDate" : "2024-11-12T08:43:18.252Z",
"createdUser" : 1,
"property" : null,
"chainBoard" : {
"id" : 2,
"createdDate" : "2024-11-12T08:43:10.373Z",
"createdUser" : 1,
"code" : "BB",
"name" : "Bed And Breakfast",
"nameI18nId" : 8902,
"nameI18n" : "Bed And Breakfast",
"folioType" : {
"id" : 1,
"code" : "M",
"name" : "Main",
"nameI18n" : "Main",
"colorCode" : "#43a047"
},
"boardSet" : null,
"chainBoardChainProductBreakdownSet" : null
},
"amountIncludedInAccommodation" : true,
"active" : true,
"boardProductBreakdownSet" : null,
"boardAvailabilitySet" : null
}
}, {
"id" : 3,
"createdDate" : "2024-11-12T08:47:21.657Z",
"createdUser" : 1,
"board" : {
"id" : 3,
"createdDate" : "2024-11-12T08:43:18.430Z",
"createdUser" : 1,
"property" : null,
"chainBoard" : {
"id" : 3,
"createdDate" : "2024-11-12T08:43:10.389Z",
"createdUser" : 1,
"code" : "HB",
"name" : "HalfBoard",
"nameI18nId" : 8903,
"nameI18n" : "Half Board",
"folioType" : {
"id" : 1,
"code" : "M",
"name" : "Main",
"nameI18n" : "Main",
"colorCode" : "#43a047"
},
"boardSet" : null,
"chainBoardChainProductBreakdownSet" : null
},
"amountIncludedInAccommodation" : true,
"active" : true,
"boardProductBreakdownSet" : null,
"boardAvailabilitySet" : null
}
}, {
"id" : 4,
"createdDate" : "2024-11-12T08:47:21.657Z",
"createdUser" : 1,
"board" : {
"id" : 4,
"createdDate" : "2024-11-12T08:43:18.589Z",
"createdUser" : 1,
"property" : null,
"chainBoard" : {
"id" : 4,
"createdDate" : "2024-11-12T08:43:10.405Z",
"createdUser" : 1,
"code" : "FB",
"name" : "FullBoard",
"nameI18nId" : 8904,
"nameI18n" : "Full Board",
"folioType" : {
"id" : 1,
"code" : "M",
"name" : "Main",
"nameI18n" : "Main",
"colorCode" : "#43a047"
},
"boardSet" : null,
"chainBoardChainProductBreakdownSet" : null
},
"amountIncludedInAccommodation" : true,
"active" : true,
"boardProductBreakdownSet" : null,
"boardAvailabilitySet" : null
}
} ],
"rateProfileSet" : null,
"rateProfileExcludedSet" : null,
"rateChainProfileGroupSet" : null,
"hasDifferenceWithChain" : false,
"rateProductFunctionRoomSet" : null
}