Link Search Menu Expand Document

6. List Zones By Building

Op name:

scgrids.listZonesByBuilding

This lists all the Zones details for a given Building

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.listZonesByBuilding (Required) Operation Name
org   (Required) Organisation ID
pid   (Required) Project ID

Body:

{
    "ESK": ""
}

More example Requests/Responses:

I. Example Response: List Zones By Building
{
    "status": 200,
    "message": "Success",
    "data": [
        {
            "InsID": "",
            "LID": "",
            "BeaconID": "test",
            "ZoneCategoryID": "LABS",
            "Name": "Zone 5",
            "Area": 3000,
            "FloorType": "hardwood",
            "Tags": {
                "Category": "test"
            },
            "Units": {
                "General": [
                    "windows",
                    "stairs",
                    "railings"
                ]
            },
            "Status": "active",
            "OperatingHours": {
                "0": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "1": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "2": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "3": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "4": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "5": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "6": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ]
            },
            "PID": ""
        }
    ]
}

Status Code: 200

Error codes:

400
Possible reasons:
1. Missing op/org/pid



Table of contents