Get Function Space Category List

Get Venue Function Space Category List

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

Return the venue function space category list for the venue.

Path Parameters

NameTypeDescription

venueId*

integer

The id of the venue

perPage

integer

The number of menu to get in a single call

{
    "meta": {
        "totalResults": 5,
        "start": 0,
        "perPage": 10,
        "count": 5
    },
    "results": [
        {
            "id": 2,
            "name": "B Category"
        },
        {
            "id": 1,
            "name": "A Category"
        },
        {
            "id": 3,
            "name": "C"
        },
        {
            "id": 4,
            "name": "abc"
        },
        {
            "id": 5,
            "name": "D Category"
        }
    ]
}

Example Request

Get Venues Function Space Category List

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

Returns

A collection object with the following properties in the results

PropertyData TypeDescription

id

integer

The unique id of the space category.

name

string

The name of the space category.

Throws

CodeDescription

Specific Code: 24150

Account does not exist

Specific Code: 24102

Venue does not exist

Specific Code: 24408

Feature not allowed

Last updated