POST public-api/customers/delete

This method is used to delete customers. It takes a list of customer numbers to delete. It requires the Delete Customer permission. It accepts a maximum of 500 records at a time. A customer that is still in use, for example one that currently has assets checked out to them, is not deleted and that entry reports an "in use" error.

Request Information

URI Parameters

None.

Body Parameters

Collection of string

Request Formats

application/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

Response Information

Resource Description

WaspResultOfListOfWaspResultOfString

Name	Type	Additional information
Data	Collection of WaspResultOfString	None.
Messages	Collection of WtResult	None.
BatchNumber	integer	None.
HasError	boolean	None.
HasHttpError	boolean	None.
HasMessage	boolean	None.
HasSuccessWithMoreDataRemaining	boolean	None.
TotalRecordsLongCount	integer	None.

Response Formats

application/json

Sample:

{
  "Data": [
    {
      "Data": "sample string 1",
      "Messages": [
        {
          "ResultCode": 0,
          "Message": "sample string 1",
          "HttpStatusCode": 200,
          "FieldName": "sample string 2"
        },
        {
          "ResultCode": 0,
          "Message": "sample string 1",
          "HttpStatusCode": 200,
          "FieldName": "sample string 2"
        }
      ],
      "BatchNumber": 1,
      "HasError": false,
      "HasHttpError": false,
      "HasMessage": true,
      "HasSuccessWithMoreDataRemaining": false,
      "TotalRecordsLongCount": 1
    },
    {
      "Data": "sample string 1",
      "Messages": [
        {
          "ResultCode": 0,
          "Message": "sample string 1",
          "HttpStatusCode": 200,
          "FieldName": "sample string 2"
        },
        {
          "ResultCode": 0,
          "Message": "sample string 1",
          "HttpStatusCode": 200,
          "FieldName": "sample string 2"
        }
      ],
      "BatchNumber": 1,
      "HasError": false,
      "HasHttpError": false,
      "HasMessage": true,
      "HasSuccessWithMoreDataRemaining": false,
      "TotalRecordsLongCount": 1
    }
  ],
  "Messages": [
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    },
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    }
  ],
  "BatchNumber": 1,
  "HasError": false,
  "HasHttpError": false,
  "HasMessage": true,
  "HasSuccessWithMoreDataRemaining": false,
  "TotalRecordsLongCount": 1
}