POST api/Search/BadPhoneNumberList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
StartDate	date	None.
StartTime	string	None.
EndDate	date	None.
EndTime	string	None.
ExcludeExpiredContactsFlag	boolean	None.
ExcludeOOSFlag	boolean	None.
SiteGroupNum	integer	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2025-05-03T22:24:06.2104382-07:00",
  "StartTime": "sample string 2",
  "EndDate": "2025-05-03T22:24:06.2104382-07:00",
  "EndTime": "sample string 4",
  "ExcludeExpiredContactsFlag": true,
  "ExcludeOOSFlag": true,
  "SiteGroupNum": 1,
  "SessionNum": 5,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 6",
  "StagesURL": "sample string 7"
}

application/xml, text/xml

Sample:

<BadPhoneNumberRequest 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>
  <SiteGroupNum>1</SiteGroupNum>
  <EndDate>2025-05-03T22:24:06.2104382-07:00</EndDate>
  <EndTime>sample string 4</EndTime>
  <ExcludeExpiredContactsFlag>true</ExcludeExpiredContactsFlag>
  <ExcludeOOSFlag>true</ExcludeOOSFlag>
  <StartDate>2025-05-03T22:24:06.2104382-07:00</StartDate>
  <StartTime>sample string 2</StartTime>
</BadPhoneNumberRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BadPhoneNumberListQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of BadPhoneNumberListResult	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "AgencyNum": 1,
      "BadNumberComment": "sample string 1",
      "BadNumberDate": "2025-05-03T22:24:06.2104382-07:00",
      "CallDisposition": "sample string 2",
      "CallDispositionDescription": "sample string 3",
      "DevNum": 1,
      "EndDate": "2025-05-03T22:24:06.2104382-07:00",
      "EndTime": "sample string 4",
      "ExcludeExpiredContactsFlag": true,
      "ExcludeOOSFlag": true,
      "FunctionName": "sample string 5",
      "KeyID": "sample string 6",
      "Option": "sample string 7",
      "ParameterName": "sample string 8",
      "ParameterValue": "sample string 9",
      "Phone": "sample string 10",
      "SiteGroupNum": 1,
      "SiteGroupSearch": "sample string 11",
      "SiteNum": 1,
      "StartDate": "2025-05-03T22:24:06.2104382-07:00",
      "StartTime": "sample string 12",
      "XmitList": "sample string 13"
    },
    {
      "AgencyNum": 1,
      "BadNumberComment": "sample string 1",
      "BadNumberDate": "2025-05-03T22:24:06.2104382-07:00",
      "CallDisposition": "sample string 2",
      "CallDispositionDescription": "sample string 3",
      "DevNum": 1,
      "EndDate": "2025-05-03T22:24:06.2104382-07:00",
      "EndTime": "sample string 4",
      "ExcludeExpiredContactsFlag": true,
      "ExcludeOOSFlag": true,
      "FunctionName": "sample string 5",
      "KeyID": "sample string 6",
      "Option": "sample string 7",
      "ParameterName": "sample string 8",
      "ParameterValue": "sample string 9",
      "Phone": "sample string 10",
      "SiteGroupNum": 1,
      "SiteGroupSearch": "sample string 11",
      "SiteNum": 1,
      "StartDate": "2025-05-03T22:24:06.2104382-07:00",
      "StartTime": "sample string 12",
      "XmitList": "sample string 13"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<BadPhoneNumberListQueryResult 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>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <BadPhoneNumberListResult>
      <AgencyNum>1</AgencyNum>
      <BadNumberComment>sample string 1</BadNumberComment>
      <BadNumberDate>2025-05-03T22:24:06.2104382-07:00</BadNumberDate>
      <CallDisposition>sample string 2</CallDisposition>
      <CallDispositionDescription>sample string 3</CallDispositionDescription>
      <DevNum>1</DevNum>
      <EndDate>2025-05-03T22:24:06.2104382-07:00</EndDate>
      <EndTime>sample string 4</EndTime>
      <ExcludeExpiredContactsFlag>true</ExcludeExpiredContactsFlag>
      <ExcludeOOSFlag>true</ExcludeOOSFlag>
      <FunctionName>sample string 5</FunctionName>
      <KeyID>sample string 6</KeyID>
      <Option>sample string 7</Option>
      <ParameterName>sample string 8</ParameterName>
      <ParameterValue>sample string 9</ParameterValue>
      <Phone>sample string 10</Phone>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteGroupSearch>sample string 11</SiteGroupSearch>
      <SiteNum>1</SiteNum>
      <StartDate>2025-05-03T22:24:06.2104382-07:00</StartDate>
      <StartTime>sample string 12</StartTime>
      <XmitList>sample string 13</XmitList>
    </BadPhoneNumberListResult>
    <BadPhoneNumberListResult>
      <AgencyNum>1</AgencyNum>
      <BadNumberComment>sample string 1</BadNumberComment>
      <BadNumberDate>2025-05-03T22:24:06.2104382-07:00</BadNumberDate>
      <CallDisposition>sample string 2</CallDisposition>
      <CallDispositionDescription>sample string 3</CallDispositionDescription>
      <DevNum>1</DevNum>
      <EndDate>2025-05-03T22:24:06.2104382-07:00</EndDate>
      <EndTime>sample string 4</EndTime>
      <ExcludeExpiredContactsFlag>true</ExcludeExpiredContactsFlag>
      <ExcludeOOSFlag>true</ExcludeOOSFlag>
      <FunctionName>sample string 5</FunctionName>
      <KeyID>sample string 6</KeyID>
      <Option>sample string 7</Option>
      <ParameterName>sample string 8</ParameterName>
      <ParameterValue>sample string 9</ParameterValue>
      <Phone>sample string 10</Phone>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteGroupSearch>sample string 11</SiteGroupSearch>
      <SiteNum>1</SiteNum>
      <StartDate>2025-05-03T22:24:06.2104382-07:00</StartDate>
      <StartTime>sample string 12</StartTime>
      <XmitList>sample string 13</XmitList>
    </BadPhoneNumberListResult>
  </ResultSet>
</BadPhoneNumberListQueryResult>