7. Get Zone
Op name:
scgrids.readZone
This gets the Zone given by it’s ID for a 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.readZone | (Required) Operation Name |
| org | (Required) Organisation ID | |
| pid | (Required) Project ID |
Body:
{
"InsID": ""
}
More example Requests/Responses:
I. Example Request: Get Zone
Body:
{
"InsID": ""
}
I. Example Response: Get Zone
{
"status": 200,
"message": "Success",
"data": {
"InsID": "",
"LID": "",
"BeaconID": "test",
"ZoneCategoryID": "",
"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: