POST api/DataExport/AreaList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional 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

ExportAreaQueryResult

Name	Type	Additional information
Success	boolean	None.
ErrorMessage	string	None.
AreaList	Collection of ExportAreasResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "AreaList": [
    {
      "SiteNum": 1,
      "DevNum": 2,
      "AreaNum": 3,
      "Description": "sample string 4",
      "OpenEventCode": "sample string 5",
      "CloseEventCode": "sample string 6",
      "SchedNum": 1,
      "AlternateTransmitterCode": "sample string 7",
      "SiteGroupNum": 1,
      "SiteGroupSchedNum": 1
    },
    {
      "SiteNum": 1,
      "DevNum": 2,
      "AreaNum": 3,
      "Description": "sample string 4",
      "OpenEventCode": "sample string 5",
      "CloseEventCode": "sample string 6",
      "SchedNum": 1,
      "AlternateTransmitterCode": "sample string 7",
      "SiteGroupNum": 1,
      "SiteGroupSchedNum": 1
    }
  ]
}

application/xml, text/xml

Sample:

<ExportAreaQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <AreaList>
    <ExportAreasResult>
      <AlternateTransmitterCode>sample string 7</AlternateTransmitterCode>
      <AreaNum>3</AreaNum>
      <CloseEventCode>sample string 6</CloseEventCode>
      <Description>sample string 4</Description>
      <DevNum>2</DevNum>
      <OpenEventCode>sample string 5</OpenEventCode>
      <SchedNum>1</SchedNum>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteGroupSchedNum>1</SiteGroupSchedNum>
      <SiteNum>1</SiteNum>
    </ExportAreasResult>
    <ExportAreasResult>
      <AlternateTransmitterCode>sample string 7</AlternateTransmitterCode>
      <AreaNum>3</AreaNum>
      <CloseEventCode>sample string 6</CloseEventCode>
      <Description>sample string 4</Description>
      <DevNum>2</DevNum>
      <OpenEventCode>sample string 5</OpenEventCode>
      <SchedNum>1</SchedNum>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteGroupSchedNum>1</SiteGroupSchedNum>
      <SiteNum>1</SiteNum>
    </ExportAreasResult>
  </AreaList>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Success>true</Success>
</ExportAreaQueryResult>