POST api/Contact/ContactPickList

Request Information

URI Parameters

None.

Body Parameters

ContactPickListRequest
NameDescriptionTypeAdditional information
OnCallScheduleNum

integer

None.

KeyNum

integer

None.

KeyType

string

None.

ContactNum

integer

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<ContactPickListRequest 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>
  <ContactNum>1</ContactNum>
  <KeyNum>1</KeyNum>
  <KeyType>sample string 1</KeyType>
  <OnCallScheduleNum>1</OnCallScheduleNum>
</ContactPickListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ContactPickListQueryResult
NameDescriptionTypeAdditional information
ExcludeColumnList

Collection of string

None.

ResultSet

Collection of ContactPickListResult

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",
      "ContactNum": 1,
      "ECVFlag": true,
      "ExpireDate": "2024-05-01T12:23:34.0393941-04:00",
      "KeyNum": 1,
      "KeysFlag": true,
      "KeyType": "sample string 2",
      "Name": "sample string 3",
      "PIN": "sample string 4",
      "Relation": "sample string 5",
      "SeqNum": 1
    },
    {
      "Authority": "sample string 1",
      "ContactNum": 1,
      "ECVFlag": true,
      "ExpireDate": "2024-05-01T12:23:34.0393941-04:00",
      "KeyNum": 1,
      "KeysFlag": true,
      "KeyType": "sample string 2",
      "Name": "sample string 3",
      "PIN": "sample string 4",
      "Relation": "sample string 5",
      "SeqNum": 1
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:
<ContactPickListQueryResult 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>
    <ContactPickListResult>
      <Authority>sample string 1</Authority>
      <ContactNum>1</ContactNum>
      <ECVFlag>true</ECVFlag>
      <ExpireDate>2024-05-01T12:23:34.0393941-04:00</ExpireDate>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 2</KeyType>
      <KeysFlag>true</KeysFlag>
      <Name>sample string 3</Name>
      <PIN>sample string 4</PIN>
      <Relation>sample string 5</Relation>
      <SeqNum>1</SeqNum>
    </ContactPickListResult>
    <ContactPickListResult>
      <Authority>sample string 1</Authority>
      <ContactNum>1</ContactNum>
      <ECVFlag>true</ECVFlag>
      <ExpireDate>2024-05-01T12:23:34.0393941-04:00</ExpireDate>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 2</KeyType>
      <KeysFlag>true</KeysFlag>
      <Name>sample string 3</Name>
      <PIN>sample string 4</PIN>
      <Relation>sample string 5</Relation>
      <SeqNum>1</SeqNum>
    </ContactPickListResult>
  </ResultSet>
</ContactPickListQueryResult>