POST api/DataExport/ContactList

Request Information

URI Parameters

None.

Body Parameters

DataExportRequest
NameDescriptionTypeAdditional information
SiteNum

integer

None.

TargetSiteGroup

integer

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteNum": 1,
  "TargetSiteGroup": 1,
  "SessionNum": 1,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 2",
  "StagesURL": "sample string 3"
}

application/xml, text/xml

Sample:
<DataExportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 3</StagesURL>
  <ApplicationCode>sample string 2</ApplicationCode>
  <SessionNum>1</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <SiteNum>1</SiteNum>
  <TargetSiteGroup>1</TargetSiteGroup>
</DataExportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ExportContactInfoQueryResult
NameDescriptionTypeAdditional information
Success

boolean

None.

ErrorMessage

string

None.

ContactList

Collection of ExportContactInfoResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ContactList": [
    {
      "PIN": "sample string 1",
      "ECVFlag": true,
      "KeysFlag": true,
      "Gender": "sample string 2",
      "DateOfBirth": "2024-05-01T16:39:10.7199602-04:00",
      "ContactNum": 3,
      "LastName": "sample string 4",
      "FirstName": "sample string 5",
      "Title": "sample string 6",
      "MiddleName": "sample string 7",
      "Suffix": "sample string 8",
      "ExpireDate": "2024-05-01T16:39:10.7199602-04:00",
      "Authority": "sample string 9",
      "Relation": "sample string 10",
      "SeqNum": 1,
      "EffectiveDate": "2024-05-01T16:39:10.7199602-04:00",
      "ContactType": "sample string 11",
      "ContactListMemberOnlyFlag": "A",
      "KeyNum": 12,
      "KeyType": "sample string 13"
    },
    {
      "PIN": "sample string 1",
      "ECVFlag": true,
      "KeysFlag": true,
      "Gender": "sample string 2",
      "DateOfBirth": "2024-05-01T16:39:10.7199602-04:00",
      "ContactNum": 3,
      "LastName": "sample string 4",
      "FirstName": "sample string 5",
      "Title": "sample string 6",
      "MiddleName": "sample string 7",
      "Suffix": "sample string 8",
      "ExpireDate": "2024-05-01T16:39:10.7199602-04:00",
      "Authority": "sample string 9",
      "Relation": "sample string 10",
      "SeqNum": 1,
      "EffectiveDate": "2024-05-01T16:39:10.7199602-04:00",
      "ContactType": "sample string 11",
      "ContactListMemberOnlyFlag": "A",
      "KeyNum": 12,
      "KeyType": "sample string 13"
    }
  ]
}

application/xml, text/xml

Sample:
<ExportContactInfoQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <ContactList>
    <ExportContactInfoResult>
      <Authority>sample string 9</Authority>
      <ContactListMemberOnlyFlag>65</ContactListMemberOnlyFlag>
      <ContactNum>3</ContactNum>
      <ContactType>sample string 11</ContactType>
      <DateOfBirth>2024-05-01T16:39:10.7199602-04:00</DateOfBirth>
      <ECVFlag>true</ECVFlag>
      <EffectiveDate>2024-05-01T16:39:10.7199602-04:00</EffectiveDate>
      <ExpireDate>2024-05-01T16:39:10.7199602-04:00</ExpireDate>
      <FirstName>sample string 5</FirstName>
      <Gender>sample string 2</Gender>
      <KeyNum>12</KeyNum>
      <KeyType>sample string 13</KeyType>
      <KeysFlag>true</KeysFlag>
      <LastName>sample string 4</LastName>
      <MiddleName>sample string 7</MiddleName>
      <PIN>sample string 1</PIN>
      <Relation>sample string 10</Relation>
      <SeqNum>1</SeqNum>
      <Suffix>sample string 8</Suffix>
      <Title>sample string 6</Title>
    </ExportContactInfoResult>
    <ExportContactInfoResult>
      <Authority>sample string 9</Authority>
      <ContactListMemberOnlyFlag>65</ContactListMemberOnlyFlag>
      <ContactNum>3</ContactNum>
      <ContactType>sample string 11</ContactType>
      <DateOfBirth>2024-05-01T16:39:10.7199602-04:00</DateOfBirth>
      <ECVFlag>true</ECVFlag>
      <EffectiveDate>2024-05-01T16:39:10.7199602-04:00</EffectiveDate>
      <ExpireDate>2024-05-01T16:39:10.7199602-04:00</ExpireDate>
      <FirstName>sample string 5</FirstName>
      <Gender>sample string 2</Gender>
      <KeyNum>12</KeyNum>
      <KeyType>sample string 13</KeyType>
      <KeysFlag>true</KeysFlag>
      <LastName>sample string 4</LastName>
      <MiddleName>sample string 7</MiddleName>
      <PIN>sample string 1</PIN>
      <Relation>sample string 10</Relation>
      <SeqNum>1</SeqNum>
      <Suffix>sample string 8</Suffix>
      <Title>sample string 6</Title>
    </ExportContactInfoResult>
  </ContactList>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Success>true</Success>
</ExportContactInfoQueryResult>