POST api/Contact/QuickContactList
Request Information
URI Parameters
None.
Body Parameters
ContactRequestName | Description | Type | Additional information |
---|---|---|---|
KeyType | string |
None. |
|
SiteNum | integer |
None. |
|
DevNum | integer |
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:
{ "KeyType": "sample string 1", "SiteNum": 1, "DevNum": 1, "TransmitterCode": "sample string 2", "SessionNum": 3, "SessionPassword": "QEA=", "ApplicationCode": "sample string 4", "StagesURL": "sample string 5" }
application/xml, text/xml
Sample:
<ContactRequest 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> <DevNum>1</DevNum> <SiteNum>1</SiteNum> <TransmitterCode>sample string 2</TransmitterCode> <KeyType>sample string 1</KeyType> </ContactRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
QuickContactListQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of QuickContactListResult |
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": [ { "Authority": "sample string 1", "AuthorityDescription": "sample string 2", "ContactNum": 1, "ECVFlag": true, "ExpiredFlag": true, "FirstName": "sample string 3", "KeyNum": 1, "KeyType": "sample string 4", "LastName": "sample string 5", "Phone": "sample string 6", "Phone2": "sample string 7", "Phone2SeqNum": 1, "PhoneSeqNum": 1, "PhoneType": "sample string 8", "PhoneType2": "sample string 9", "PhoneType2Description": "sample string 10", "PhoneTypeDescription": "sample string 11", "PIN": "sample string 12", "SeqNum": 1, "Suffix": "sample string 13", "Title": "sample string 14" }, { "Authority": "sample string 1", "AuthorityDescription": "sample string 2", "ContactNum": 1, "ECVFlag": true, "ExpiredFlag": true, "FirstName": "sample string 3", "KeyNum": 1, "KeyType": "sample string 4", "LastName": "sample string 5", "Phone": "sample string 6", "Phone2": "sample string 7", "Phone2SeqNum": 1, "PhoneSeqNum": 1, "PhoneType": "sample string 8", "PhoneType2": "sample string 9", "PhoneType2Description": "sample string 10", "PhoneTypeDescription": "sample string 11", "PIN": "sample string 12", "SeqNum": 1, "Suffix": "sample string 13", "Title": "sample string 14" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<QuickContactListQueryResult 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> <QuickContactListResult> <Authority>sample string 1</Authority> <AuthorityDescription>sample string 2</AuthorityDescription> <ContactNum>1</ContactNum> <ECVFlag>true</ECVFlag> <ExpiredFlag>true</ExpiredFlag> <FirstName>sample string 3</FirstName> <KeyNum>1</KeyNum> <KeyType>sample string 4</KeyType> <LastName>sample string 5</LastName> <PIN>sample string 12</PIN> <Phone>sample string 6</Phone> <Phone2>sample string 7</Phone2> <Phone2SeqNum>1</Phone2SeqNum> <PhoneSeqNum>1</PhoneSeqNum> <PhoneType>sample string 8</PhoneType> <PhoneType2>sample string 9</PhoneType2> <PhoneType2Description>sample string 10</PhoneType2Description> <PhoneTypeDescription>sample string 11</PhoneTypeDescription> <SeqNum>1</SeqNum> <Suffix>sample string 13</Suffix> <Title>sample string 14</Title> </QuickContactListResult> <QuickContactListResult> <Authority>sample string 1</Authority> <AuthorityDescription>sample string 2</AuthorityDescription> <ContactNum>1</ContactNum> <ECVFlag>true</ECVFlag> <ExpiredFlag>true</ExpiredFlag> <FirstName>sample string 3</FirstName> <KeyNum>1</KeyNum> <KeyType>sample string 4</KeyType> <LastName>sample string 5</LastName> <PIN>sample string 12</PIN> <Phone>sample string 6</Phone> <Phone2>sample string 7</Phone2> <Phone2SeqNum>1</Phone2SeqNum> <PhoneSeqNum>1</PhoneSeqNum> <PhoneType>sample string 8</PhoneType> <PhoneType2>sample string 9</PhoneType2> <PhoneType2Description>sample string 10</PhoneType2Description> <PhoneTypeDescription>sample string 11</PhoneTypeDescription> <SeqNum>1</SeqNum> <Suffix>sample string 13</Suffix> <Title>sample string 14</Title> </QuickContactListResult> </ResultSet> </QuickContactListQueryResult>