List Zones by IDs

12. List Zones By IDs

Op name:

scgrids.listZonesByIDs

This gets the details of given zones

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

Body:

{
    "InsIDs": ["", ""]
}

More example Requests/Responses:

Body:

{
    "InsIDs": ["", ""]
}

I. Example Response: List Zones By IDs

{
    "status": 200,
    "message": "Success",
    "data": [
        {
            "InsID": "",
            "LID": "",
            "BeaconID": "test",
            "ZoneCategoryID": "",
            "Name": "Zone 5",
            "Area": 3000,
            "FloorType": "hardwood",
            "Tags": {
                "Category": "test"
            },
            "Units": {
                "General": [
                    {
                        "Key": "windows",
                        "Count": 1
                    },
                    {
                        "Key": "stairs",
                        "Count": 2
                    },
                    {
                        "Key": "railings",
                        "Count": 2
                    }
                ]
            },
            "Status": "active",
            "IsBuildingOperatingHours": true,
            "PID": ""
        }
    ]
}

12. List Zones By IDs

I. Example Response: List Zones By IDs

400

Possible reasons:

1. Missing op/org/pid

2. Missing InsIDs in the body

Table of contents