Get Venue Room Option List

Last updated 4 months ago

post
Get Venue Room Option List

[PlatformAddress]/api/1.0/venue?action=getVenueRoomOptionList
Get a list of room options for a venue.
Request
Response
Body Parameters
venueId
required
integer
The unique id of the venue to which the room options belong
start
optional
integer
The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result.)
perPage
required
integer
The number of booking accomodation groups to fetch
200: OK
{
"meta": {
"totalResults": 2,
"start": 0,
"perPage": 100,
"count": 2
},
"results": [
{
"id": 1,
"venueId": 1,
"name": "Test Room Option 1",
"description": "Test Room Option 1",
"price": 100,
"priceExcludedTaxIds": [1],
"cost": 100,
"costExcludedTaxIds": [1],
"costcenterId": null,
"createdDate": "2018-08-08 12:37:14 UTC",
"modifiedDate": "2018-08-08 12:37:14 UTC"
},
{
"id": 2,
"venueId": 1,
"name": "Test Room Option 2",
"description": "Test Room Option 2",
"price": 100,
"priceExcludedTaxIds": [1],
"cost": 100,
"costExcludedTaxIds": [1],
"costcenterId": null,
"createdDate": "2018-08-08 18:21:59 UTC",
"modifiedDate": "2018-08-08 18:21:59 UTC"
}
]
}

The result from this call will be a collection of room options the user has access to. This call also accepts the pagination and filter properties.

Venue Room Option

Property

Type

Description

id

integer

The unique id of the room option

venueId

integer

The unique id of the venue to which the room option belongs

name

string

The name of the room option (e.g. "Breakfast")

description

string

The description of the room option. This can be html formatted text

price

number

The sale price of the room option. The amount either includes or excludes tax depending on how the venue is configured

priceExcludedTaxIds

array of integers

The unique ids of the taxes that are excluded from price

cost

number

The cost of the room option. The amount either includes or excludes tax depending on how the venue is configured

costExcludedTaxIds

array of integers

The unique ids of the taxes that are excluded from cost

costcenterId

integer

The unique id of the cost center assigned to the room option

createdDate

datetime

The date & time the room option was created

modifiedDate

datetime

The date & time the room option was last modified