Get Resource Availability

Get Resource Availability

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

Return the availability for resources.

Path Parameters

NameTypeDescription

venueId

integer

The id of the venue

startDate

date

The start date of the period from which to include the resource availability details.

endDate

date

The end date of the period from which to include the resource availability details.

resourceIds

array

The end date of the period from which to include the resource availability details.

{
    "meta": {
        "totalResults": 2,
        "start": 0,
        "perPage": 100,
        "count": 2
    },
    "results": [
        {
            "id": 1,
            "unAvailableTimes": [
                {
                    "startDate": "2018-01-17 08:00:00",
                    "endDate": "2018-01-17 09:00:00"
                }
            ]
        },
        {
            "id": 24,
            "unAvailableTimes": []
        }
    ]
}

Example Request

Get Resource Availability

{
    "venueId": 1,
    "startDate": "2018-01-10 00:00:00",
    "endDate": "2018-01-18 23:59:00",
    "resourceIds": [1, 24]
}

Returns

A collection object with the following properties in the results

PropertyDescription

id

The unique resource identifier

unAvailableTimes

The unavailable date time ranges

Last updated