POST api/Contact/ContactList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
KeyNum	integer	None.
KeyType	string	None.
DispayExpiredFlag	boolean	None.
SearchName	string	None.
StartOrderNum	integer	None.
SearchPIN	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:

{
  "KeyNum": 1,
  "KeyType": "sample string 1",
  "DispayExpiredFlag": true,
  "SearchName": "sample string 2",
  "StartOrderNum": 1,
  "SearchPIN": "sample string 3",
  "ContactNum": 1,
  "SessionNum": 4,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 5",
  "StagesURL": "sample string 6"
}

application/xml, text/xml

Sample:

<ContactListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 6</StagesURL>
  <ApplicationCode>sample string 5</ApplicationCode>
  <SessionNum>4</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <ContactNum>1</ContactNum>
  <DispayExpiredFlag>true</DispayExpiredFlag>
  <KeyNum>1</KeyNum>
  <KeyType>sample string 1</KeyType>
  <SearchName>sample string 2</SearchName>
  <SearchPIN>sample string 3</SearchPIN>
  <StartOrderNum>1</StartOrderNum>
</ContactListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ContactListQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of ContactListResult	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": [
    {
      "AddWebUserFlag": true,
      "Authority": "sample string 1",
      "AuthorityDescription": "sample string 2",
      "ContactInfoXml": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "ContactNum": 1,
      "DisplayExpiredFlag": true,
      "DocumentNum": 1,
      "DocumentSeqNum": 1,
      "ECVFlag": true,
      "ExpireDate": "2025-05-03T23:02:51.0059573-07:00",
      "ExpiredFlag": true,
      "FirstName": "sample string 3",
      "HighlightContactNum": 1,
      "HighlightFlag": true,
      "KeyNum": 1,
      "KeysFlag": true,
      "KeyType": "sample string 4",
      "LastName": "sample string 5",
      "MiddleName": "sample string 6",
      "Name": "sample string 7",
      "PatientFlag": true,
      "PIN": "sample string 8",
      "Relation": "sample string 9",
      "RelationDescription": "sample string 10",
      "SearchName": "sample string 11",
      "SearchPIN": "sample string 12",
      "SeqNum": 1,
      "StartOrderNum": 1,
      "Suffix": "sample string 13",
      "Title": "sample string 14",
      "UserID": "sample string 15",
      "XtApplicationName": "sample string 16",
      "PhoneList": "sample string 17",
      "SiteGroupName": "sample string 18",
      "SiteName": "sample string 19"
    },
    {
      "AddWebUserFlag": true,
      "Authority": "sample string 1",
      "AuthorityDescription": "sample string 2",
      "ContactInfoXml": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "ContactNum": 1,
      "DisplayExpiredFlag": true,
      "DocumentNum": 1,
      "DocumentSeqNum": 1,
      "ECVFlag": true,
      "ExpireDate": "2025-05-03T23:02:51.0059573-07:00",
      "ExpiredFlag": true,
      "FirstName": "sample string 3",
      "HighlightContactNum": 1,
      "HighlightFlag": true,
      "KeyNum": 1,
      "KeysFlag": true,
      "KeyType": "sample string 4",
      "LastName": "sample string 5",
      "MiddleName": "sample string 6",
      "Name": "sample string 7",
      "PatientFlag": true,
      "PIN": "sample string 8",
      "Relation": "sample string 9",
      "RelationDescription": "sample string 10",
      "SearchName": "sample string 11",
      "SearchPIN": "sample string 12",
      "SeqNum": 1,
      "StartOrderNum": 1,
      "Suffix": "sample string 13",
      "Title": "sample string 14",
      "UserID": "sample string 15",
      "XtApplicationName": "sample string 16",
      "PhoneList": "sample string 17",
      "SiteGroupName": "sample string 18",
      "SiteName": "sample string 19"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<ContactListQueryResult 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>
    <ContactListResult>
      <AddWebUserFlag>true</AddWebUserFlag>
      <Authority>sample string 1</Authority>
      <AuthorityDescription>sample string 2</AuthorityDescription>
      <ContactInfoXml>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </ContactInfoXml>
      <ContactNum>1</ContactNum>
      <DisplayExpiredFlag>true</DisplayExpiredFlag>
      <DocumentNum>1</DocumentNum>
      <DocumentSeqNum>1</DocumentSeqNum>
      <ECVFlag>true</ECVFlag>
      <ExpireDate>2025-05-03T23:02:51.0059573-07:00</ExpireDate>
      <ExpiredFlag>true</ExpiredFlag>
      <FirstName>sample string 3</FirstName>
      <HighlightContactNum>1</HighlightContactNum>
      <HighlightFlag>true</HighlightFlag>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 4</KeyType>
      <KeysFlag>true</KeysFlag>
      <LastName>sample string 5</LastName>
      <MiddleName>sample string 6</MiddleName>
      <Name>sample string 7</Name>
      <PIN>sample string 8</PIN>
      <PatientFlag>true</PatientFlag>
      <PhoneList>sample string 17</PhoneList>
      <Relation>sample string 9</Relation>
      <RelationDescription>sample string 10</RelationDescription>
      <SearchName>sample string 11</SearchName>
      <SearchPIN>sample string 12</SearchPIN>
      <SeqNum>1</SeqNum>
      <SiteGroupName>sample string 18</SiteGroupName>
      <SiteName>sample string 19</SiteName>
      <StartOrderNum>1</StartOrderNum>
      <Suffix>sample string 13</Suffix>
      <Title>sample string 14</Title>
      <UserID>sample string 15</UserID>
      <XtApplicationName>sample string 16</XtApplicationName>
    </ContactListResult>
    <ContactListResult>
      <AddWebUserFlag>true</AddWebUserFlag>
      <Authority>sample string 1</Authority>
      <AuthorityDescription>sample string 2</AuthorityDescription>
      <ContactInfoXml>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </ContactInfoXml>
      <ContactNum>1</ContactNum>
      <DisplayExpiredFlag>true</DisplayExpiredFlag>
      <DocumentNum>1</DocumentNum>
      <DocumentSeqNum>1</DocumentSeqNum>
      <ECVFlag>true</ECVFlag>
      <ExpireDate>2025-05-03T23:02:51.0059573-07:00</ExpireDate>
      <ExpiredFlag>true</ExpiredFlag>
      <FirstName>sample string 3</FirstName>
      <HighlightContactNum>1</HighlightContactNum>
      <HighlightFlag>true</HighlightFlag>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 4</KeyType>
      <KeysFlag>true</KeysFlag>
      <LastName>sample string 5</LastName>
      <MiddleName>sample string 6</MiddleName>
      <Name>sample string 7</Name>
      <PIN>sample string 8</PIN>
      <PatientFlag>true</PatientFlag>
      <PhoneList>sample string 17</PhoneList>
      <Relation>sample string 9</Relation>
      <RelationDescription>sample string 10</RelationDescription>
      <SearchName>sample string 11</SearchName>
      <SearchPIN>sample string 12</SearchPIN>
      <SeqNum>1</SeqNum>
      <SiteGroupName>sample string 18</SiteGroupName>
      <SiteName>sample string 19</SiteName>
      <StartOrderNum>1</StartOrderNum>
      <Suffix>sample string 13</Suffix>
      <Title>sample string 14</Title>
      <UserID>sample string 15</UserID>
      <XtApplicationName>sample string 16</XtApplicationName>
    </ContactListResult>
  </ResultSet>
</ContactListQueryResult>