Create a Device Zone
post
/api/device/Zones
Creates a new device zone.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DeviceZoneID: integer
The device zone ID assigned for the new device zone. It must be a unique value that is not used by other zones and not 1 (which is the default zone). If the DeviceZoneID is not provided, it will be automatically generated by incrementing the value of the last device zone.
-
DeviceZoneName(required): string
The name for the new device zone.Example:
Default First Zone
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the new device zone.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : deviceZonesRead
Type:
Show Source
object
-
DeviceCount: integer
The number of devices.Example:
1
-
DeviceZoneID: integer
The device zone ID.Example:
1
-
DeviceZoneName: string
The device zone name.Example:
Default First Zone
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object