POST api/Site/SiteCodeWordDelete
Request Information
URI Parameters
None.
Body Parameters
CodeWordRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SeqNum | integer |
None. |
|
| Authority | string |
None. |
|
| CodeWord | string |
None. |
|
| CodeWordQuestion | string |
None. |
|
| EffectiveDate | date |
None. |
|
| ExpireDate | date |
None. |
|
| SiteNum | integer |
None. |
|
| DevNum | integer |
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:
{
"SeqNum": 1,
"Authority": "sample string 1",
"CodeWord": "sample string 2",
"CodeWordQuestion": "sample string 3",
"EffectiveDate": "2025-12-14T17:37:42.3002526-05:00",
"ExpireDate": "2025-12-14T17:37:42.3002526-05:00",
"SiteNum": 1,
"DevNum": 1,
"TransmitterCode": "sample string 4",
"SessionNum": 5,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 6",
"StagesURL": "sample string 7"
}
application/xml, text/xml
Sample:
<CodeWordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 7</StagesURL> <ApplicationCode>sample string 6</ApplicationCode> <SessionNum>5</SessionNum> <SessionPassword>QEA=</SessionPassword> <DevNum>1</DevNum> <SiteNum>1</SiteNum> <TransmitterCode>sample string 4</TransmitterCode> <Authority>sample string 1</Authority> <CodeWord>sample string 2</CodeWord> <CodeWordQuestion>sample string 3</CodeWordQuestion> <EffectiveDate>2025-12-14T17:37:42.3002526-05:00</EffectiveDate> <ExpireDate>2025-12-14T17:37:42.3002526-05:00</ExpireDate> <SeqNum>1</SeqNum> </CodeWordRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteCodeWordDeleteQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| 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"
}
application/xml, text/xml
Sample:
<SiteCodeWordDeleteQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages"> <ClientVersion>sample string 5</ClientVersion> <ErrorTypeNum>3</ErrorTypeNum> <SqlConnectionLost>true</SqlConnectionLost> <Success>true</Success> <UserErrorMessage>sample string 2</UserErrorMessage> </SiteCodeWordDeleteQueryResult>