POST api/PurgeSyncSession

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SyncSession	string	None.
CustomerNumber	string	None.
PurgeAllQueues	boolean	None.
PullCodes	Collection of string	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:

{
  "SyncSession": "sample string 1",
  "CustomerNumber": "sample string 2",
  "PurgeAllQueues": true,
  "PullCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "TicketNumber": "4032cca8-5677-4a4b-b569-bd7d4dc93261",
  "RequestedBy": "sample string 5",
  "RequestedFrom": "sample string 6",
  "RequestedDate": "2026-02-09T01:01:16.9967689+00:00",
  "ExecutedDate": "2026-02-09T01:01:17.0123967+00:00",
  "ExecutedBy": "sample string 9",
  "ErrorInfo": "sample string 10",
  "Status": "sample string 11"
}

application/xml, text/xml

Sample:

<SyncSessionPurge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScheduledJobModels">
  <CustomerNumber>sample string 2</CustomerNumber>
  <ErrorInfo>sample string 10</ErrorInfo>
  <ExecutedBy>sample string 9</ExecutedBy>
  <ExecutedDate>2026-02-09T01:01:17.0123967+00:00</ExecutedDate>
  <PullCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PullCodes>
  <PurgeAllQueues>true</PurgeAllQueues>
  <RequestedBy>sample string 5</RequestedBy>
  <RequestedDate>2026-02-09T01:01:16.9967689+00:00</RequestedDate>
  <RequestedFrom>sample string 6</RequestedFrom>
  <Status>sample string 11</Status>
  <SyncSession>sample string 1</SyncSession>
  <TicketNumber>4032cca8-5677-4a4b-b569-bd7d4dc93261</TicketNumber>
</SyncSessionPurge>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.