POST api/DataExport/AgencyList

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

ExportAgenciesQueryResult
NameDescriptionTypeAdditional information
Success

boolean

None.

ErrorMessage

string

None.

AgencyList

Collection of ExportAgenciesResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "AgencyList": [
    {
      "SiteNum": 1,
      "AgencyNum": 2,
      "AgencyType": "sample string 3",
      "AgencyTypeDescription": "sample string 4",
      "AgencyName": "sample string 5",
      "Phone": "sample string 6",
      "PermitRequiredFlag": "sample string 7",
      "AgencyID": "sample string 8",
      "ASAPID": "sample string 9",
      "ASAPName": "sample string 10"
    },
    {
      "SiteNum": 1,
      "AgencyNum": 2,
      "AgencyType": "sample string 3",
      "AgencyTypeDescription": "sample string 4",
      "AgencyName": "sample string 5",
      "Phone": "sample string 6",
      "PermitRequiredFlag": "sample string 7",
      "AgencyID": "sample string 8",
      "ASAPID": "sample string 9",
      "ASAPName": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:
<ExportAgenciesQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <AgencyList>
    <ExportAgenciesResult>
      <ASAPID>sample string 9</ASAPID>
      <ASAPName>sample string 10</ASAPName>
      <AgencyID>sample string 8</AgencyID>
      <AgencyName>sample string 5</AgencyName>
      <AgencyNum>2</AgencyNum>
      <AgencyType>sample string 3</AgencyType>
      <AgencyTypeDescription>sample string 4</AgencyTypeDescription>
      <PermitRequiredFlag>sample string 7</PermitRequiredFlag>
      <Phone>sample string 6</Phone>
      <SiteNum>1</SiteNum>
    </ExportAgenciesResult>
    <ExportAgenciesResult>
      <ASAPID>sample string 9</ASAPID>
      <ASAPName>sample string 10</ASAPName>
      <AgencyID>sample string 8</AgencyID>
      <AgencyName>sample string 5</AgencyName>
      <AgencyNum>2</AgencyNum>
      <AgencyType>sample string 3</AgencyType>
      <AgencyTypeDescription>sample string 4</AgencyTypeDescription>
      <PermitRequiredFlag>sample string 7</PermitRequiredFlag>
      <Phone>sample string 6</Phone>
      <SiteNum>1</SiteNum>
    </ExportAgenciesResult>
  </AgencyList>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Success>true</Success>
</ExportAgenciesQueryResult>