13. ListZoneByZoneCategory
Op name:
scgrids.listZonesByZoneCategory
This lists all the Zones for a given ZoneCategory
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.listZonesByZoneCategory | |
| org | ||
| pid |
Body:
{
"ZoneCategoryID": "",
"ESK": ""
}
More example Requests/Responses:
I. Example Request: ListZoneByZoneCategory
Body:
{
"ZoneCategoryID": "",
"ExclusiveStartKey": ""
}
I. Example Response: ListZoneByZoneCategory
{
"status": 200,
"message": "Success",
"data": [
{
"InsID": "",
"LID": "",
"ZoneCategoryID": "",
"Name": "Zone 5",
"Area": 3000,
"FloorType": "hardwood",
"Status": "active",
"PID": ""
},
{
"InsID": "",
"LID": "",
"ZoneCategoryID": "",
"Name": "Zone 5",
"Area": 3000,
"FloorType": "hardwood",
"Status": "active",
"PID": ""
}
],
"LEK": ""
}
Status Code: 200
Error codes: