POST api/CCPA/CCPAStatusList

Request Information

URI Parameters

None.

Body Parameters

CCPAStatusListRequest
NameDescriptionTypeAdditional 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:
<CCPAStatusListRequest 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>
</CCPAStatusListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CCPAStatusListQueryResult
NameDescriptionTypeAdditional information
ResultSet

Collection of CCPAStatusListResult

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",
      "Date": "2024-05-01T18:57:38.4087212-04:00",
      "DERNum": 1,
      "SiteGroupNum": 1,
      "ContactNum": 1,
      "ContactName": "sample string 2",
      "ClientRefenceNumber": "sample string 3",
      "StagesDataDate": "2024-05-01T18:57:38.4087212-04:00",
      "VoiceRecordingDate": "2024-05-01T18:57:38.4087212-04:00",
      "S3UploadDate": "2024-05-01T18:57:38.4087212-04:00",
      "S3ExpireDate": "2024-05-01T18:57:38.4087212-04:00",
      "S3URL": "sample string 4",
      "CallbackQueueDate": "2024-05-01T18:57:38.4087212-04:00",
      "CallbackProcessDate": "2024-05-01T18:57:38.4087212-04:00",
      "StagesDataStartDate": "2024-05-01T18:57:38.4087212-04:00"
    },
    {
      "SeqNum": 1,
      "SiteNum": 1,
      "Xmit": "sample string 1",
      "Date": "2024-05-01T18:57:38.4087212-04:00",
      "DERNum": 1,
      "SiteGroupNum": 1,
      "ContactNum": 1,
      "ContactName": "sample string 2",
      "ClientRefenceNumber": "sample string 3",
      "StagesDataDate": "2024-05-01T18:57:38.4087212-04:00",
      "VoiceRecordingDate": "2024-05-01T18:57:38.4087212-04:00",
      "S3UploadDate": "2024-05-01T18:57:38.4087212-04:00",
      "S3ExpireDate": "2024-05-01T18:57:38.4087212-04:00",
      "S3URL": "sample string 4",
      "CallbackQueueDate": "2024-05-01T18:57:38.4087212-04:00",
      "CallbackProcessDate": "2024-05-01T18:57:38.4087212-04:00",
      "StagesDataStartDate": "2024-05-01T18:57:38.4087212-04:00"
    }
  ]
}

application/xml, text/xml

Sample:
<CCPAStatusListQueryResult 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>
    <CCPAStatusListResult>
      <CallbackProcessDate>2024-05-01T18:57:38.4087212-04:00</CallbackProcessDate>
      <CallbackQueueDate>2024-05-01T18:57:38.4087212-04:00</CallbackQueueDate>
      <ClientRefenceNumber>sample string 3</ClientRefenceNumber>
      <ContactName>sample string 2</ContactName>
      <ContactNum>1</ContactNum>
      <DERNum>1</DERNum>
      <Date>2024-05-01T18:57:38.4087212-04:00</Date>
      <S3ExpireDate>2024-05-01T18:57:38.4087212-04:00</S3ExpireDate>
      <S3URL>sample string 4</S3URL>
      <S3UploadDate>2024-05-01T18:57:38.4087212-04:00</S3UploadDate>
      <SeqNum>1</SeqNum>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteNum>1</SiteNum>
      <StagesDataDate>2024-05-01T18:57:38.4087212-04:00</StagesDataDate>
      <StagesDataStartDate>2024-05-01T18:57:38.4087212-04:00</StagesDataStartDate>
      <VoiceRecordingDate>2024-05-01T18:57:38.4087212-04:00</VoiceRecordingDate>
      <Xmit>sample string 1</Xmit>
    </CCPAStatusListResult>
    <CCPAStatusListResult>
      <CallbackProcessDate>2024-05-01T18:57:38.4087212-04:00</CallbackProcessDate>
      <CallbackQueueDate>2024-05-01T18:57:38.4087212-04:00</CallbackQueueDate>
      <ClientRefenceNumber>sample string 3</ClientRefenceNumber>
      <ContactName>sample string 2</ContactName>
      <ContactNum>1</ContactNum>
      <DERNum>1</DERNum>
      <Date>2024-05-01T18:57:38.4087212-04:00</Date>
      <S3ExpireDate>2024-05-01T18:57:38.4087212-04:00</S3ExpireDate>
      <S3URL>sample string 4</S3URL>
      <S3UploadDate>2024-05-01T18:57:38.4087212-04:00</S3UploadDate>
      <SeqNum>1</SeqNum>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteNum>1</SiteNum>
      <StagesDataDate>2024-05-01T18:57:38.4087212-04:00</StagesDataDate>
      <StagesDataStartDate>2024-05-01T18:57:38.4087212-04:00</StagesDataStartDate>
      <VoiceRecordingDate>2024-05-01T18:57:38.4087212-04:00</VoiceRecordingDate>
      <Xmit>sample string 1</Xmit>
    </CCPAStatusListResult>
  </ResultSet>
</CCPAStatusListQueryResult>