POST api/CCPA/SubmitCCPARequest
Request Information
URI Parameters
None.
Body Parameters
CCPARequestName | Description | Type | Additional information |
---|---|---|---|
Description | string |
None. |
|
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:
{ "Description": "sample string 1", "SiteNum": 1, "ReferenceNumber": "sample string 2", "TransmitterCode": "sample string 3", "SessionNum": 4, "SessionPassword": "QEA=", "ApplicationCode": "sample string 5", "StagesURL": "sample string 6" }
application/xml, text/xml
Sample:
<CCPARequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 6</StagesURL> <ApplicationCode>sample string 5</ApplicationCode> <SessionNum>4</SessionNum> <SessionPassword>QEA=</SessionPassword> <ReferenceNumber>sample string 2</ReferenceNumber> <SiteNum>1</SiteNum> <TransmitterCode>sample string 3</TransmitterCode> <Description>sample string 1</Description> </CCPARequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SubmitCCPARequestQueryResultName | 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:
<SubmitCCPARequestQueryResult 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> </SubmitCCPARequestQueryResult>