Jump to

• Request
• Response

Delete Multiple Device Type Categories

post

/api/device/Categories/delete

Deletes multiple device type categories by providing the category IDs.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object items
  The list of device type category IDs.

{
    "type":"array",
    "items":{
        "description":"The list of device type category IDs.",
        "type":"object",
        "properties":{
            "DeviceTypeCategoryID":{
                "type":"integer",
                "example":"2"
            }
        }
    },
    "example":"{\n \"DeviceTypeCategoryID\": \"1\",\n \"DeviceTypeCategoryID\": \"2\"\n}"
}

Example:

{
 "DeviceTypeCategoryID": "1",
 "DeviceTypeCategoryID": "2"
}

Nested Schema : items

Type: object

The list of device type category IDs.

Show Source

• DeviceTypeCategoryID: integer
  Example: 2

{
    "description":"The list of device type category IDs.",
    "type":"object",
    "properties":{
        "DeviceTypeCategoryID":{
            "type":"integer",
            "example":"2"
        }
    }
}

Back to Top

Response

200 Response

Successful operation

Body ()

Root Schema : SuccessfulDeleteOperation

Type: object

The response body for a successful delete operation.

Show Source

• message: string
  The response message.

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

  Example: true

{
    "description":"The response body for a successful delete operation.",
    "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":"Deleted record"
        }
    },
    "type":"object"
}

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":{
                "description":"An error.",
                "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
  An error.

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

Nested Schema : items

Type: object

An error.

Back to Top