Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "DeviceZoneName"
    ],
    "properties":{
        "DeviceZoneID":{
            "description":"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.",
            "type":"integer"
        },
        "DeviceZoneName":{
            "description":"The name for the new device zone.",
            "type":"string",
            "example":"Default First Zone"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new device zone.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceZonesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new device zone.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new device zone.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceZonesRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new device zone.

Show Source

• Array of: object deviceZonesRead

{
    "description":"The properties of the new device zone.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceZonesRead"
    }
}

Nested Schema : deviceZonesRead

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "DeviceZoneID":{
            "description":"The device zone ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceZoneName":{
            "description":"The device zone name.",
            "type":"string",
            "example":"Default First Zone"
        },
        "DeviceCount":{
            "description":"The number of devices.",
            "type":"integer",
            "example":"1"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top