Get Venue Rate Plan Room Rate List

Get Rate Plan Room Rate List

POST [PlatformAddress]/api/1.0/venue?action=getRoomRateList

Get a list of rate plan room rates.

Path Parameters

Name	Type	Description
venueId*	integer	The id of the venue
barId*	integer	The id of the rate plan
barRateId*	integer	The id of the rate plan rate
roomId	integer	The id of the room

200

{
    "meta": {
        "totalResults": 3,
        "start": 0,
        "perPage": 3,
        "count": 3
    },
    "results": [
        {
            "id": 1,
            "barId": 1,
            "barRateId": 1,
            "roomId": 1,
            "cost": 55,
            "costDouble": null,
            "costTriple": null,
            "costQuad": null,
            "costExcludedTaxIds": [],
            "actualCost": 45,
            "actualCostDouble": null,
            "actualCostTriple": null,
            "actualCostQuad": null,
            "actualCostExcludedTaxIds": []
        },
        {
            "id": 2,
            "barId": 1,
            "barRateId": 1,
            "roomId": 22,
            "cost": 50,
            "costDouble": null,
            "costTriple": null,
            "costQuad": null,
            "costExcludedTaxIds": [],
            "actualCost": 45,
            "actualCostDouble": null,
            "actualCostTriple": null,
            "actualCostQuad": null,
            "actualCostExcludedTaxIds": []
        },
        {
            "id": 3,
            "barId": 1,
            "barRateId": 1,
            "roomId": 23,
            "cost": 50,
            "costDouble": 70,
            "costTriple": 0,
            "costQuad": 0,
            "costExcludedTaxIds": [],
            "actualCost": 0,
            "actualCostDouble": 0,
            "actualCostTriple": 0,
            "actualCostQuad": 0,
            "actualCostExcludedTaxIds": []
        }
    ]
}

The result from this call will be a collection of all the room rates the user has access to. it does not accept pagination or filter properties.

Example Request

{
  "venueId": 1,
  "barId": 1,
  "barRateId": 1,
}

Rate Plan Room Rate

Property	Type	Description
id	integer	The unique id of the room rate
barId	integer	The unique id of the rate plan
barRateId	integer	The unique id of the rate plan rate
roomId	integer	The unique id of the room
cost	double	The sale price of the room rate. Represents single occupancy when multi occupancy is enabled.
costDouble	double	The sale price of the room rate for double occupancy
costTriple	double	The sale price of the room rate for triple occupancy
costQuad	double	The sale price of the room rate for quad occupancy
costExcludedTaxIds	array	The excluded tax identifiers of the sale price
actualCost	double	The cost of the room rate. Represents single occupancy when multi occupancy is enabled.
actualCostDouble	double	The cost of the room rate for double occupancy
actualCostTriple	double	The cost of the room rate for triple occupancy
actualCostQuad	double	The cost of the room rate for quad occupancy
actualCostExcludedTaxIds	array	The excluded tax identifiers of the cost