POST api/PurgeCustomer

Request Information

URI Parameters

None.

Body Parameters

CustomerPurge
NameDescriptionTypeAdditional information
CustomerNumber

string

None.

MarkCustomerInactive

boolean

None.

PurgeFromDataStore

boolean

None.

StartDate

date

None.

EndDate

date

None.

TicketNumber

globally unique identifier

None.

RequestedBy

string

None.

RequestedFrom

string

None.

RequestedDate

date

None.

ExecutedDate

date

None.

ExecutedBy

string

None.

ErrorInfo

string

None.

Status

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerNumber": "sample string 1",
  "MarkCustomerInactive": true,
  "PurgeFromDataStore": true,
  "StartDate": "2025-12-16T00:51:32.3762406+00:00",
  "EndDate": "2025-12-16T00:51:32.3762406+00:00",
  "TicketNumber": "332bf521-7293-4b1d-b52a-236d8199752c",
  "RequestedBy": "sample string 7",
  "RequestedFrom": "sample string 8",
  "RequestedDate": "2025-12-16T00:51:32.3762406+00:00",
  "ExecutedDate": "2025-12-16T00:51:32.3762406+00:00",
  "ExecutedBy": "sample string 11",
  "ErrorInfo": "sample string 12",
  "Status": "sample string 13"
}

application/xml, text/xml

Sample:
<CustomerPurge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScheduledJobModels">
  <CustomerNumber>sample string 1</CustomerNumber>
  <EndDate>2025-12-16T00:51:32.3762406+00:00</EndDate>
  <ErrorInfo>sample string 12</ErrorInfo>
  <ExecutedBy>sample string 11</ExecutedBy>
  <ExecutedDate>2025-12-16T00:51:32.3762406+00:00</ExecutedDate>
  <MarkCustomerInactive>true</MarkCustomerInactive>
  <PurgeFromDataStore>true</PurgeFromDataStore>
  <RequestedBy>sample string 7</RequestedBy>
  <RequestedDate>2025-12-16T00:51:32.3762406+00:00</RequestedDate>
  <RequestedFrom>sample string 8</RequestedFrom>
  <StartDate>2025-12-16T00:51:32.3762406+00:00</StartDate>
  <Status>sample string 13</Status>
  <TicketNumber>332bf521-7293-4b1d-b52a-236d8199752c</TicketNumber>
</CustomerPurge>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerPurge'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.