Link Search Menu Expand Document

9. List Zone Categories

Op name:

scgrids.listZoneCategories

This lists all the system level Zone categories for a given Property type

Endpoint:

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

Headers:

Key Value Description
Authorization   (Required) Login Access Token
x-sc-identity external (Required)

Query params:

Key Value Description
op scgrids.listZoneCategories (Required) Operation Name
org   (Required) Organisation ID
pid scnoop (Required) Project ID is scnoop when it’s not known

Body:

{
    "PropertyTypeID": ""
}

More example Requests/Responses:

Body:

{
    "PropertyTypeID": ""
}
I. Example Response: List Zone Categories 
{
    "status": 200,
    "message": "Success",
    "data": [
        {
            "Name": "Auditoriums/Theaters",
            "PropertyTypeID": "SCHOOL",
            "CategoryID": "AUDITORIUMS/THEATERS"
        },
        {
            "Name": "Classrooms",
            "PropertyTypeID": "SCHOOL",
            "CategoryID": "CLASSROOMS"
        },
        {
            "Name": "Labs",
            "PropertyTypeID": "SCHOOL",
            "CategoryID": "LABS"
        },
        {
            "Name": "Swimming Pools",
            "PropertyTypeID": "SCHOOL",
            "CategoryID": "SWIMMING_POOLS"
        }
    ]
}

Status Code: 200

Error codes:

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


Table of contents