Get Space Hire Plans

Get Space Hire Plan List

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

Get a list of space hire plans.

Path Parameters

Name	Type	Description
venueId*	integer	The id of the venue
perPage	integer	The number of space hire plan to get in a single call

200

{
    "meta": {
        "totalResults": 2,
        "start": 0,
        "perPage": 50,
        "count": 2
    },
    "results": [
        {
            "id": 1,
            "name": "RHP",
            "code": "RHP",
            "description": null,
            "createdDate": "2017-12-18 12:17:49 UTC",
            "modifiedDate": "2018-01-15 05:44:41 UTC"
        },
        {
            "id": 8,
            "name": "Test Hire Plan",
            "code": "HIRE123",
            "description": "<p>test</p> ",
            "createdDate": "2019-04-03 11:27:42 UTC",
            "modifiedDate": "2020-04-29 04:43:02 UTC"
        }
    ]
}

The result from this call will be a collection of all the space hire plans the user has access to. This call also accepts the pagination and filter properties.

Example Request

Get a specific space hire plan list

{
  "venueId": "1",
  "perPage": "50",
}