6. List Zones By Level
Op name:
scgrids.listZonesByLevel
This lists all the Zones for a given Level
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.listZonesByLevel | (Required) Operation Name |
org | (Required) Organisation ID | |
pid | (Required) Project ID | |
propid | (Optional) Property ID |
Body:
{
"LID": "",
"ESK": ""
}
More example Requests/Responses:
I. Example Request: List Zones By Level
Body:
{
"LID": "",
"ZoneCategoryIDs": [
"LABS"
],
"ESK": ""
}
I. Example Response: List Zones By Level
{
"status": 200,
"message": "Success",
"data": [
{
"InsID": "",
"LID": "",
"ZoneCategoryID": "LABS",
"Name": "New test name",
"Area": 6000,
"FloorType": "Test floor type",
"Status": "PENDING"
},
{
"InsID": "",
"LID": "",
"ZoneCategoryID": "LABS",
"Name": "Zone 5",
"Area": 3000,
"FloorType": "hardwood",
"Status": "active"
}
],
"LEK": ""
}
Status Code: 200
Error codes: