1. Create Zone
Op name:
scgrids.createZone
This creates a Zone object for a given Level 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.createZone | (Required) Operation Name |
| org | (Required) Organisation ID | |
| pid | (Required) Project ID | |
| propid | (Required) Property ID |
Body:
{
"Zone": [
{
"Name": "Zone 5",
"Area": 3000,
"FloorType": "hardwood",
"Tags": {
"Category": "test"
},
"LID": "",
"ZoneCategoryID": "AUDITORIUMS/THEATERS",
"Units": {
"General": [
{
"Key": "windows",
"Count": 1
},
{
"Key": "stairs",
"Count": 2
},
{
"Key": "railings",
"Count": 2
}
]
},
"IsBuildingOperatingHours": true,
"Status": "active",
"BeaconID": "test"
}
]
}
More example Requests/Responses:
I. Example Request: Create Zone
Body:
{
"Zone": [
{
"Name": "Zone 5",
"Area": 3000,
"FloorType": "hardwood",
"Tags": {
"Category": "test"
},
"LID": "",
"ZoneCategoryID": "",
"Units": {
"General": [
{
"Key": "windows",
"Count": 1
},
{
"Key": "stairs",
"Count": 2
},
{
"Key": "railings",
"Count": 2
}
]
},
"OperatingHours": {
"0": [
{
"Start": "0000",
"End": "2359"
}
],
"1": [
{
"Start": "0000",
"End": "2359"
}
],
"2": [
{
"Start": "0000",
"End": "2359"
}
],
"3": [
{
"Start": "0000",
"End": "2359"
}
],
"4": [
{
"Start": "0000",
"End": "2359"
}
],
"5": [
{
"Start": "0000",
"End": "2359"
}
],
"6": [
{
"Start": "0000",
"End": "2359"
}
]
},
"Status": "active",
"BeaconID": "test"
},
{
"Name": "Zone 2",
"Area": 3000,
"FloorType": "hardwood",
"Tags": {
"Category": "test"
},
"LID": "",
"ZoneCategoryID": "",
"Units": {
"General": [
{
"Key": "windows",
"Count": 1
},
{
"Key": "stairs",
"Count": 2
},
{
"Key": "railings",
"Count": 2
}
]
},
"Status": "active",
"BeaconID": "test",
"IsBuildingOperatingHours": true
}
]
}
I. Example Response: Create Zone
{
"status": 201,
"message": "Success",
"data": [
{
"OrgId": "",
"PID": "",
"LID": "",
"InsID": "}",
"BeaconID": "test",
"ZoneCategoryID": "LABS",
"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",
"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"
}
]
},
"IsBuildingOperatingHours": false,
"CreatedOn": 1611811493
},
{
"OrgId": "",
"PID": "",
"LID": "",
"InsID": "}",
"BeaconID": "test",
"ZoneCategoryID": "LABS",
"Name": "Zone 2",
"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,
"CreatedOn": 1611811493
}
]
}
Status Code: 200
Error codes: