POST api/CCPA/CCPASiteDelete
Request Information
URI Parameters
None.
Body Parameters
CCPADeleteRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteNum | integer |
None. |
|
| ReferenceNumber | string |
None. |
|
| TransmitterCode | string |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"SiteNum": 1,
"ReferenceNumber": "sample string 1",
"TransmitterCode": "sample string 2",
"SessionNum": 3,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 4",
"StagesURL": "sample string 5"
}
application/xml, text/xml
Sample:
<CCPADeleteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 5</StagesURL> <ApplicationCode>sample string 4</ApplicationCode> <SessionNum>3</SessionNum> <SessionPassword>QEA=</SessionPassword> <ReferenceNumber>sample string 1</ReferenceNumber> <SiteNum>1</SiteNum> <TransmitterCode>sample string 2</TransmitterCode> </CCPADeleteRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CCPASiteDeleteQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ResultSet | Collection of CCPASiteDeleteResult |
None. |
|
| Success | boolean |
None. |
|
| UserErrorMessage | string |
None. |
|
| ErrorTypeNum | integer |
None. |
|
| SqlConnectionLost | boolean |
None. |
|
| ClientVersion | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5",
"ResultSet": [
{
"SeqNum": 1,
"SiteNum": 1,
"Xmit": "sample string 1",
"QueueDate": "2025-12-14T17:41:18.8700772-05:00",
"DERNum": 1,
"SiteGroupNum": 1,
"ContactNum": 1,
"ContactName": "sample string 2",
"ClientRefenceNumber": "sample string 3",
"CompletedDate": "2025-12-14T17:41:18.8700772-05:00",
"StartDate": "2025-12-14T17:41:18.8700772-05:00",
"CompletedFlag": true
},
{
"SeqNum": 1,
"SiteNum": 1,
"Xmit": "sample string 1",
"QueueDate": "2025-12-14T17:41:18.8700772-05:00",
"DERNum": 1,
"SiteGroupNum": 1,
"ContactNum": 1,
"ContactName": "sample string 2",
"ClientRefenceNumber": "sample string 3",
"CompletedDate": "2025-12-14T17:41:18.8700772-05:00",
"StartDate": "2025-12-14T17:41:18.8700772-05:00",
"CompletedFlag": true
}
]
}
application/xml, text/xml
Sample:
<CCPASiteDeleteQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
<ClientVersion xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</ClientVersion>
<ErrorTypeNum xmlns="http://schemas.datacontract.org/2004/07/Stages">3</ErrorTypeNum>
<SqlConnectionLost xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SqlConnectionLost>
<Success xmlns="http://schemas.datacontract.org/2004/07/Stages">true</Success>
<UserErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 2</UserErrorMessage>
<ResultSet>
<CCPASiteDeleteResult>
<ClientRefenceNumber>sample string 3</ClientRefenceNumber>
<CompletedDate>2025-12-14T17:41:18.8700772-05:00</CompletedDate>
<CompletedFlag>true</CompletedFlag>
<ContactName>sample string 2</ContactName>
<ContactNum>1</ContactNum>
<DERNum>1</DERNum>
<QueueDate>2025-12-14T17:41:18.8700772-05:00</QueueDate>
<SeqNum>1</SeqNum>
<SiteGroupNum>1</SiteGroupNum>
<SiteNum>1</SiteNum>
<StartDate>2025-12-14T17:41:18.8700772-05:00</StartDate>
<Xmit>sample string 1</Xmit>
</CCPASiteDeleteResult>
<CCPASiteDeleteResult>
<ClientRefenceNumber>sample string 3</ClientRefenceNumber>
<CompletedDate>2025-12-14T17:41:18.8700772-05:00</CompletedDate>
<CompletedFlag>true</CompletedFlag>
<ContactName>sample string 2</ContactName>
<ContactNum>1</ContactNum>
<DERNum>1</DERNum>
<QueueDate>2025-12-14T17:41:18.8700772-05:00</QueueDate>
<SeqNum>1</SeqNum>
<SiteGroupNum>1</SiteGroupNum>
<SiteNum>1</SiteNum>
<StartDate>2025-12-14T17:41:18.8700772-05:00</StartDate>
<Xmit>sample string 1</Xmit>
</CCPASiteDeleteResult>
</ResultSet>
</CCPASiteDeleteQueryResult>