Link Search Menu Expand Document

8. List Zone Asset By Zone Category

Op name:

scgrids.listZoneUnitsByZoneCategory

This lists all the stayet level Zone Units/Assets

Endpoint:

Method: POST
Type: application/json
URL: /v1/actions

Headers:

Key Value Description
Authorization   (Required) The Acccess Token or HMAC Signature
x-sc-identity external (Required)

Query params:

Key Value Description
op scgrids.listZoneAssetsByZoneCategory (Required) Operation Name
org   (Required) Organisation ID
pid scnoop (Required) Project ID

Body:

{
    "ZoneCategoryID": "CONFERENCE_ROOMS"
}

More example Requests/Responses:

Body:

{
    "ZoneCategoryID": "CONFERENCE_ROOMS"
}
I. Example Response: List Zone Units By Zone Category
{
    "status": 200,
    "message": "Success",
    "data": [
        {
            "Name": "Door/Opening",
            "ImageURL": "https://dummyimage.com/5:5x250",
            "ZoneCategoryID": "CONFERENCE_ROOMS",
            "UnitID": "DOOR/OPENING"
        },
        {
            "Name": "Windows",
            "ImageURL": "https://dummyimage.com/5:5x250",
            "ZoneCategoryID": "CONFERENCE_ROOMS",
            "UnitID": "WINDOWS"
        }
    ]
}

Status Code: 200

Error codes:

400
Possible reasons:
1. Missing op/org/pid
2. Missing ZoneCategoryID in the body



Table of contents