POST api/Phone/PhoneListWithDetail

Request Information

URI Parameters

None.

Body Parameters

PhoneListRequest
NameDescriptionTypeAdditional information
KeyNum

integer

None.
KeyType

string

None.
SeqNum

integer

None.
DisplayExpiredFlag

boolean

None.
SessionNum

integer

None.
SessionPassword

Collection of byte

None.
ApplicationCode

string

None.
StagesURL

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "KeyNum": 1,
  "KeyType": "sample string 1",
  "SeqNum": 1,
  "DisplayExpiredFlag": true,
  "SessionNum": 2,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 3",
  "StagesURL": "sample string 4"
}

application/xml, text/xml

Sample: 
<PhoneListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 4</StagesURL>
  <ApplicationCode>sample string 3</ApplicationCode>
  <SessionNum>2</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <DisplayExpiredFlag>true</DisplayExpiredFlag>
  <KeyNum>1</KeyNum>
  <KeyType>sample string 1</KeyType>
  <SeqNum>1</SeqNum>
</PhoneListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PhoneListWithDetailQueryResult
NameDescriptionTypeAdditional information
ResultSet

Collection of PhoneListWithDetailResult

None.
ExcludeColumnList

Collection of string

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": [
    {
      "AdditionalDataFlag": true,
      "AutoDialFlag": true,
      "AutoDialMethod": "sample string 1",
      "AutoNotifyFlag": true,
      "Comment": "sample string 2",
      "DataChangeNotifyFlag": true,
      "DayTimeFlag": true,
      "DayTimeNum": 1,
      "Extension": "sample string 3",
      "KeyNum": 1,
      "KeyType": "sample string 4",
      "Phone": "sample string 5",
      "PhoneType": "sample string 6",
      "PhoneTypeDescription": "sample string 7",
      "RefreshContactListsFlag": true,
      "SeqNum": 1,
      "SitePhoneFlag": true,
      "Title": "sample string 8",
      "WorkStationExtension": "sample string 9",
      "ExpiredFlag": true,
      "PhoneStatus": "sample string 10",
      "ActionAutoEvalDescription": "sample string 11",
      "ActionAutoEvalNum": 1,
      "ConfirmedAlarmFlag": true,
      "BadNumberComment": "sample string 12",
      "BadNumberDate": "2025-05-03T23:36:03.1614582-07:00",
      "BadNumberFlag": true,
      "CallDisposition": "sample string 13",
      "CallDispositionDescription": "sample string 14",
      "OverrideEndDate": "2025-05-03T23:36:03.1614582-07:00",
      "OverrideEndTime": "sample string 15",
      "OverridePhone": "sample string 16",
      "OverrideStartDate": "2025-05-03T23:36:03.1614582-07:00",
      "OverrideStartTime": "sample string 17",
      "EffectiveDate": "2025-05-03T23:36:03.1614582-07:00",
      "EffectiveTime": "sample string 18",
      "ExpireDate": "2025-05-03T23:36:03.1614582-07:00",
      "ExpireTime": "sample string 19",
      "PhoneCarrier": "sample string 20",
      "PhoneCarrierDescription": "sample string 21"
    },
    {
      "AdditionalDataFlag": true,
      "AutoDialFlag": true,
      "AutoDialMethod": "sample string 1",
      "AutoNotifyFlag": true,
      "Comment": "sample string 2",
      "DataChangeNotifyFlag": true,
      "DayTimeFlag": true,
      "DayTimeNum": 1,
      "Extension": "sample string 3",
      "KeyNum": 1,
      "KeyType": "sample string 4",
      "Phone": "sample string 5",
      "PhoneType": "sample string 6",
      "PhoneTypeDescription": "sample string 7",
      "RefreshContactListsFlag": true,
      "SeqNum": 1,
      "SitePhoneFlag": true,
      "Title": "sample string 8",
      "WorkStationExtension": "sample string 9",
      "ExpiredFlag": true,
      "PhoneStatus": "sample string 10",
      "ActionAutoEvalDescription": "sample string 11",
      "ActionAutoEvalNum": 1,
      "ConfirmedAlarmFlag": true,
      "BadNumberComment": "sample string 12",
      "BadNumberDate": "2025-05-03T23:36:03.1614582-07:00",
      "BadNumberFlag": true,
      "CallDisposition": "sample string 13",
      "CallDispositionDescription": "sample string 14",
      "OverrideEndDate": "2025-05-03T23:36:03.1614582-07:00",
      "OverrideEndTime": "sample string 15",
      "OverridePhone": "sample string 16",
      "OverrideStartDate": "2025-05-03T23:36:03.1614582-07:00",
      "OverrideStartTime": "sample string 17",
      "EffectiveDate": "2025-05-03T23:36:03.1614582-07:00",
      "EffectiveTime": "sample string 18",
      "ExpireDate": "2025-05-03T23:36:03.1614582-07:00",
      "ExpireTime": "sample string 19",
      "PhoneCarrier": "sample string 20",
      "PhoneCarrierDescription": "sample string 21"
    }
  ],
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<PhoneListWithDetailQueryResult 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>
  <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>
    <PhoneListWithDetailResult>
      <ActionAutoEvalDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 11</ActionAutoEvalDescription>
      <ActionAutoEvalNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</ActionAutoEvalNum>
      <AdditionalDataFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AdditionalDataFlag>
      <AutoDialFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AutoDialFlag>
      <AutoDialMethod xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 1</AutoDialMethod>
      <AutoNotifyFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AutoNotifyFlag>
      <BadNumberComment xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 12</BadNumberComment>
      <BadNumberDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</BadNumberDate>
      <BadNumberFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</BadNumberFlag>
      <CallDisposition xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 13</CallDisposition>
      <CallDispositionDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 14</CallDispositionDescription>
      <Comment xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 2</Comment>
      <ConfirmedAlarmFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</ConfirmedAlarmFlag>
      <DataChangeNotifyFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</DataChangeNotifyFlag>
      <DayTimeFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</DayTimeFlag>
      <DayTimeNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</DayTimeNum>
      <EffectiveDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</EffectiveDate>
      <EffectiveTime xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 18</EffectiveTime>
      <ExpireDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</ExpireDate>
      <ExpireTime xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 19</ExpireTime>
      <ExpiredFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</ExpiredFlag>
      <Extension xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 3</Extension>
      <KeyNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</KeyNum>
      <KeyType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 4</KeyType>
      <OverrideEndDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</OverrideEndDate>
      <OverrideEndTime xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 15</OverrideEndTime>
      <OverridePhone xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 16</OverridePhone>
      <OverrideStartDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</OverrideStartDate>
      <OverrideStartTime xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 17</OverrideStartTime>
      <Phone xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</Phone>
      <PhoneCarrier xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 20</PhoneCarrier>
      <PhoneCarrierDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 21</PhoneCarrierDescription>
      <PhoneStatus xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 10</PhoneStatus>
      <PhoneType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 6</PhoneType>
      <PhoneTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 7</PhoneTypeDescription>
      <RefreshContactListsFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</RefreshContactListsFlag>
      <SeqNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</SeqNum>
      <SitePhoneFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SitePhoneFlag>
      <Title xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 8</Title>
      <WorkStationExtension xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 9</WorkStationExtension>
    </PhoneListWithDetailResult>
    <PhoneListWithDetailResult>
      <ActionAutoEvalDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 11</ActionAutoEvalDescription>
      <ActionAutoEvalNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</ActionAutoEvalNum>
      <AdditionalDataFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AdditionalDataFlag>
      <AutoDialFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AutoDialFlag>
      <AutoDialMethod xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 1</AutoDialMethod>
      <AutoNotifyFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AutoNotifyFlag>
      <BadNumberComment xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 12</BadNumberComment>
      <BadNumberDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</BadNumberDate>
      <BadNumberFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</BadNumberFlag>
      <CallDisposition xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 13</CallDisposition>
      <CallDispositionDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 14</CallDispositionDescription>
      <Comment xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 2</Comment>
      <ConfirmedAlarmFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</ConfirmedAlarmFlag>
      <DataChangeNotifyFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</DataChangeNotifyFlag>
      <DayTimeFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</DayTimeFlag>
      <DayTimeNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</DayTimeNum>
      <EffectiveDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</EffectiveDate>
      <EffectiveTime xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 18</EffectiveTime>
      <ExpireDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</ExpireDate>
      <ExpireTime xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 19</ExpireTime>
      <ExpiredFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</ExpiredFlag>
      <Extension xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 3</Extension>
      <KeyNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</KeyNum>
      <KeyType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 4</KeyType>
      <OverrideEndDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</OverrideEndDate>
      <OverrideEndTime xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 15</OverrideEndTime>
      <OverridePhone xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 16</OverridePhone>
      <OverrideStartDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2025-05-03T23:36:03.1614582-07:00</OverrideStartDate>
      <OverrideStartTime xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 17</OverrideStartTime>
      <Phone xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</Phone>
      <PhoneCarrier xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 20</PhoneCarrier>
      <PhoneCarrierDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 21</PhoneCarrierDescription>
      <PhoneStatus xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 10</PhoneStatus>
      <PhoneType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 6</PhoneType>
      <PhoneTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 7</PhoneTypeDescription>
      <RefreshContactListsFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</RefreshContactListsFlag>
      <SeqNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</SeqNum>
      <SitePhoneFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SitePhoneFlag>
      <Title xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 8</Title>
      <WorkStationExtension xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 9</WorkStationExtension>
    </PhoneListWithDetailResult>
  </ResultSet>
</PhoneListWithDetailQueryResult>