DELETE api/Clients/{id}

Delete a Client if you are a System Admin

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

ID for Client to delete

integer

Required

Body Parameters

None.

Response Information

Resource Description

returns true if successful

DeleteResponse
NameDescriptionTypeAdditional information
Success

Was it successful or not

boolean

None.

Messages

Array of messages

Collection of Message

None.

ServerInformation

Relevant information regarding the Server

ServerInformation

None.

VersionInformation

Relevant information regarding the API's version

VersionInformation

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:34:45.7869585+10:00",
    "BuildDateUTC": "2025-11-09T21:34:45.7869585+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  },
  "Success": true
}