GET Batch/LogCleanup?clientID={clientID}

Performs the Log Cleanup process, depending on the input. If a ClientID is provided, it will perform it for that Client only. If no ClientID is provided, it will perform it for all Clients.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientID

Integer ID of Client to act on. If null, will act on all clients. Default is null

integer

None.

Body Parameters

None.

Response Information

Resource Description

with a flag indicating if action was taken

GetBooleanResponse
NameDescriptionTypeAdditional information
Bool

The boolean result

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:44:14.3001561+10:00",
    "BuildDateUTC": "2025-11-09T21:44:14.3001561+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  },
  "Bool": true
}