POST api/Phone/PhoneFullUpdate

Request Information

URI Parameters

None.

Body Parameters

PhoneFullDetailRequest
NameDescriptionTypeAdditional information
ChangeFlagSeqNum

boolean

None.

ChangeFlagPhone

boolean

None.

AutoNotifyFlag

boolean

None.

ChangeFlagPhoneType

boolean

None.

ChangeFlagComment

boolean

None.

ChangeFlagAutoNotifyFlag

boolean

None.

ChangeFlagExtension

boolean

None.

ChangeFlagDataChangeNotifyFlag

boolean

None.

ChangeFlagBadNumberFlag

boolean

None.

ChangeFlagBadNumberComment

boolean

None.

ChangeFlagOverrideStartDate

boolean

None.

ChangeFlagOverrideStartTime

boolean

None.

ChangeFlagOverrideEndDate

boolean

None.

ChangeFlagOverrideEndTime

boolean

None.

ChangeFlagOverridePhone

boolean

None.

ChangeFlagSitePhoneFlag

boolean

None.

ChangeFlagEffectiveDate

boolean

None.

ChangeFlagEffectiveTime

boolean

None.

ChangeFlagExpireDate

boolean

None.

ChangeFlagExpireTime

boolean

None.

ChangeFlagPhoneCarrier

boolean

None.

BadNumberComment

string

None.

BadNumberDate

date

None.

BadNumberFlag

boolean

None.

Comment

string

None.

DataChangeNotifyFlag

boolean

None.

DayTimeNum

integer

None.

Extension

string

None.

KeyNum

integer

None.

KeyType

string

None.

OverrideEndDate

date

None.

OverrideEndTime

string

None.

OverridePhone

string

None.

OverrideStartDate

date

None.

OverrideStartTime

string

None.

Phone

string

None.

PhoneType

string

None.

SeqNum

integer

None.

SitePhoneFlag

boolean

None.

EffectiveDate

date

None.

ExpireDate

date

None.

EffectiveTime

string

None.

ExpireTime

string

None.

PhoneCarrier

string

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ChangeFlagSeqNum": true,
  "ChangeFlagPhone": true,
  "AutoNotifyFlag": true,
  "ChangeFlagPhoneType": true,
  "ChangeFlagComment": true,
  "ChangeFlagAutoNotifyFlag": true,
  "ChangeFlagExtension": true,
  "ChangeFlagDataChangeNotifyFlag": true,
  "ChangeFlagBadNumberFlag": true,
  "ChangeFlagBadNumberComment": true,
  "ChangeFlagOverrideStartDate": true,
  "ChangeFlagOverrideStartTime": true,
  "ChangeFlagOverrideEndDate": true,
  "ChangeFlagOverrideEndTime": true,
  "ChangeFlagOverridePhone": true,
  "ChangeFlagSitePhoneFlag": true,
  "ChangeFlagEffectiveDate": true,
  "ChangeFlagEffectiveTime": true,
  "ChangeFlagExpireDate": true,
  "ChangeFlagExpireTime": true,
  "ChangeFlagPhoneCarrier": true,
  "BadNumberComment": "sample string 1",
  "BadNumberDate": "2024-05-01T18:54:19.5330338-04:00",
  "BadNumberFlag": true,
  "Comment": "sample string 2",
  "DataChangeNotifyFlag": true,
  "DayTimeNum": 1,
  "Extension": "sample string 3",
  "KeyNum": 1,
  "KeyType": "sample string 4",
  "OverrideEndDate": "2024-05-01T18:54:19.5330338-04:00",
  "OverrideEndTime": "sample string 5",
  "OverridePhone": "sample string 6",
  "OverrideStartDate": "2024-05-01T18:54:19.5330338-04:00",
  "OverrideStartTime": "sample string 7",
  "Phone": "sample string 8",
  "PhoneType": "sample string 9",
  "SeqNum": 1,
  "SitePhoneFlag": true,
  "EffectiveDate": "2024-05-01T18:54:19.5330338-04:00",
  "ExpireDate": "2024-05-01T18:54:19.5330338-04:00",
  "EffectiveTime": "sample string 10",
  "ExpireTime": "sample string 11",
  "PhoneCarrier": "sample string 12",
  "SessionNum": 13,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 14",
  "StagesURL": "sample string 15"
}

application/xml, text/xml

Sample:
<PhoneFullDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 15</StagesURL>
  <ApplicationCode>sample string 14</ApplicationCode>
  <SessionNum>13</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <AutoNotifyFlag i:nil="true" />
  <BadNumberComment>sample string 1</BadNumberComment>
  <BadNumberDate>2024-05-01T18:54:19.5330338-04:00</BadNumberDate>
  <BadNumberFlag>true</BadNumberFlag>
  <Comment>sample string 2</Comment>
  <DataChangeNotifyFlag>true</DataChangeNotifyFlag>
  <DayTimeNum>1</DayTimeNum>
  <EffectiveDate>2024-05-01T18:54:19.5330338-04:00</EffectiveDate>
  <EffectiveTime>sample string 10</EffectiveTime>
  <ExpireDate>2024-05-01T18:54:19.5330338-04:00</ExpireDate>
  <ExpireTime>sample string 11</ExpireTime>
  <Extension>sample string 3</Extension>
  <KeyNum>1</KeyNum>
  <KeyType>sample string 4</KeyType>
  <OverrideEndDate>2024-05-01T18:54:19.5330338-04:00</OverrideEndDate>
  <OverrideEndTime>sample string 5</OverrideEndTime>
  <OverridePhone>sample string 6</OverridePhone>
  <OverrideStartDate>2024-05-01T18:54:19.5330338-04:00</OverrideStartDate>
  <OverrideStartTime>sample string 7</OverrideStartTime>
  <Phone>sample string 8</Phone>
  <PhoneCarrier>sample string 12</PhoneCarrier>
  <PhoneType>sample string 9</PhoneType>
  <SeqNum>1</SeqNum>
  <SitePhoneFlag>true</SitePhoneFlag>
  <AutoNotifyFlag>true</AutoNotifyFlag>
  <ChangeFlagAutoNotifyFlag>true</ChangeFlagAutoNotifyFlag>
  <ChangeFlagBadNumberComment>true</ChangeFlagBadNumberComment>
  <ChangeFlagBadNumberFlag>true</ChangeFlagBadNumberFlag>
  <ChangeFlagComment>true</ChangeFlagComment>
  <ChangeFlagDataChangeNotifyFlag>true</ChangeFlagDataChangeNotifyFlag>
  <ChangeFlagEffectiveDate>true</ChangeFlagEffectiveDate>
  <ChangeFlagEffectiveTime>true</ChangeFlagEffectiveTime>
  <ChangeFlagExpireDate>true</ChangeFlagExpireDate>
  <ChangeFlagExpireTime>true</ChangeFlagExpireTime>
  <ChangeFlagExtension>true</ChangeFlagExtension>
  <ChangeFlagOverrideEndDate>true</ChangeFlagOverrideEndDate>
  <ChangeFlagOverrideEndTime>true</ChangeFlagOverrideEndTime>
  <ChangeFlagOverridePhone>true</ChangeFlagOverridePhone>
  <ChangeFlagOverrideStartDate>true</ChangeFlagOverrideStartDate>
  <ChangeFlagOverrideStartTime>true</ChangeFlagOverrideStartTime>
  <ChangeFlagPhone>true</ChangeFlagPhone>
  <ChangeFlagPhoneCarrier>true</ChangeFlagPhoneCarrier>
  <ChangeFlagPhoneType>true</ChangeFlagPhoneType>
  <ChangeFlagSeqNum>true</ChangeFlagSeqNum>
  <ChangeFlagSitePhoneFlag>true</ChangeFlagSitePhoneFlag>
</PhoneFullDetailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PhoneUpdateQueryResult
NameDescriptionTypeAdditional information
ExcludeColumnList

Collection of string

None.

ResultSet

Collection of PhoneUpdateResult

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": [
    {
      "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": "2024-05-01T18:54:19.5642939-04:00",
      "BadNumberFlag": true,
      "CallDisposition": "sample string 13",
      "CallDispositionDescription": "sample string 14",
      "OverrideEndDate": "2024-05-01T18:54:19.5642939-04:00",
      "OverrideEndTime": "sample string 15",
      "OverridePhone": "sample string 16",
      "OverrideStartDate": "2024-05-01T18:54:19.5642939-04:00",
      "OverrideStartTime": "sample string 17",
      "EffectiveDate": "2024-05-01T18:54:19.5642939-04:00",
      "EffectiveTime": "sample string 18",
      "ExpireDate": "2024-05-01T18:54:19.5642939-04: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": "2024-05-01T18:54:19.5642939-04:00",
      "BadNumberFlag": true,
      "CallDisposition": "sample string 13",
      "CallDispositionDescription": "sample string 14",
      "OverrideEndDate": "2024-05-01T18:54:19.5642939-04:00",
      "OverrideEndTime": "sample string 15",
      "OverridePhone": "sample string 16",
      "OverrideStartDate": "2024-05-01T18:54:19.5642939-04:00",
      "OverrideStartTime": "sample string 17",
      "EffectiveDate": "2024-05-01T18:54:19.5642939-04:00",
      "EffectiveTime": "sample string 18",
      "ExpireDate": "2024-05-01T18:54:19.5642939-04:00",
      "ExpireTime": "sample string 19",
      "PhoneCarrier": "sample string 20",
      "PhoneCarrierDescription": "sample string 21"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:
<PhoneUpdateQueryResult 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>
    <PhoneUpdateResult>
      <ActionAutoEvalDescription>sample string 11</ActionAutoEvalDescription>
      <ActionAutoEvalNum>1</ActionAutoEvalNum>
      <AdditionalDataFlag>true</AdditionalDataFlag>
      <AutoDialFlag>true</AutoDialFlag>
      <AutoDialMethod>sample string 1</AutoDialMethod>
      <AutoNotifyFlag>true</AutoNotifyFlag>
      <BadNumberComment>sample string 12</BadNumberComment>
      <BadNumberDate>2024-05-01T18:54:19.5642939-04:00</BadNumberDate>
      <BadNumberFlag>true</BadNumberFlag>
      <CallDisposition>sample string 13</CallDisposition>
      <CallDispositionDescription>sample string 14</CallDispositionDescription>
      <Comment>sample string 2</Comment>
      <ConfirmedAlarmFlag>true</ConfirmedAlarmFlag>
      <DataChangeNotifyFlag>true</DataChangeNotifyFlag>
      <DayTimeFlag>true</DayTimeFlag>
      <DayTimeNum>1</DayTimeNum>
      <EffectiveDate>2024-05-01T18:54:19.5642939-04:00</EffectiveDate>
      <EffectiveTime>sample string 18</EffectiveTime>
      <ExpireDate>2024-05-01T18:54:19.5642939-04:00</ExpireDate>
      <ExpireTime>sample string 19</ExpireTime>
      <ExpiredFlag>true</ExpiredFlag>
      <Extension>sample string 3</Extension>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 4</KeyType>
      <OverrideEndDate>2024-05-01T18:54:19.5642939-04:00</OverrideEndDate>
      <OverrideEndTime>sample string 15</OverrideEndTime>
      <OverridePhone>sample string 16</OverridePhone>
      <OverrideStartDate>2024-05-01T18:54:19.5642939-04:00</OverrideStartDate>
      <OverrideStartTime>sample string 17</OverrideStartTime>
      <Phone>sample string 5</Phone>
      <PhoneCarrier>sample string 20</PhoneCarrier>
      <PhoneCarrierDescription>sample string 21</PhoneCarrierDescription>
      <PhoneStatus>sample string 10</PhoneStatus>
      <PhoneType>sample string 6</PhoneType>
      <PhoneTypeDescription>sample string 7</PhoneTypeDescription>
      <RefreshContactListsFlag>true</RefreshContactListsFlag>
      <SeqNum>1</SeqNum>
      <SitePhoneFlag>true</SitePhoneFlag>
      <Title>sample string 8</Title>
      <WorkStationExtension>sample string 9</WorkStationExtension>
    </PhoneUpdateResult>
    <PhoneUpdateResult>
      <ActionAutoEvalDescription>sample string 11</ActionAutoEvalDescription>
      <ActionAutoEvalNum>1</ActionAutoEvalNum>
      <AdditionalDataFlag>true</AdditionalDataFlag>
      <AutoDialFlag>true</AutoDialFlag>
      <AutoDialMethod>sample string 1</AutoDialMethod>
      <AutoNotifyFlag>true</AutoNotifyFlag>
      <BadNumberComment>sample string 12</BadNumberComment>
      <BadNumberDate>2024-05-01T18:54:19.5642939-04:00</BadNumberDate>
      <BadNumberFlag>true</BadNumberFlag>
      <CallDisposition>sample string 13</CallDisposition>
      <CallDispositionDescription>sample string 14</CallDispositionDescription>
      <Comment>sample string 2</Comment>
      <ConfirmedAlarmFlag>true</ConfirmedAlarmFlag>
      <DataChangeNotifyFlag>true</DataChangeNotifyFlag>
      <DayTimeFlag>true</DayTimeFlag>
      <DayTimeNum>1</DayTimeNum>
      <EffectiveDate>2024-05-01T18:54:19.5642939-04:00</EffectiveDate>
      <EffectiveTime>sample string 18</EffectiveTime>
      <ExpireDate>2024-05-01T18:54:19.5642939-04:00</ExpireDate>
      <ExpireTime>sample string 19</ExpireTime>
      <ExpiredFlag>true</ExpiredFlag>
      <Extension>sample string 3</Extension>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 4</KeyType>
      <OverrideEndDate>2024-05-01T18:54:19.5642939-04:00</OverrideEndDate>
      <OverrideEndTime>sample string 15</OverrideEndTime>
      <OverridePhone>sample string 16</OverridePhone>
      <OverrideStartDate>2024-05-01T18:54:19.5642939-04:00</OverrideStartDate>
      <OverrideStartTime>sample string 17</OverrideStartTime>
      <Phone>sample string 5</Phone>
      <PhoneCarrier>sample string 20</PhoneCarrier>
      <PhoneCarrierDescription>sample string 21</PhoneCarrierDescription>
      <PhoneStatus>sample string 10</PhoneStatus>
      <PhoneType>sample string 6</PhoneType>
      <PhoneTypeDescription>sample string 7</PhoneTypeDescription>
      <RefreshContactListsFlag>true</RefreshContactListsFlag>
      <SeqNum>1</SeqNum>
      <SitePhoneFlag>true</SitePhoneFlag>
      <Title>sample string 8</Title>
      <WorkStationExtension>sample string 9</WorkStationExtension>
    </PhoneUpdateResult>
  </ResultSet>
</PhoneUpdateQueryResult>