<back to all web services


Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/bookings/{Id}/resources/availableFind available resources.
ResourceTypeAvailableResourcesQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoEnter the company and id you want to see the information for a resourcetype, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown
IdpathintYesEnter the id for the booking.
ResourceTypeIdqueryintYesEnter the id for a resourcetype.
ResourceTypeAvailableResourcesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resourcetype id
ResourcesformList<AvailableResourceResponse>NoThe available resources
AvailableResourceResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resource id
NameformstringNoThe resource name
DescriptionformstringNoThe resource description
ColorformstringNoThe resource color in scheduler in hexadecimal color code. Example: #00b0f0 for blue.
ImageUrlformUriNoThe image url of the resource

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other


The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /bookings/{Id}/resources/available HTTP/1.1 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length