POST api/DataExport/DeviceList

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

ExportDevicesQueryResult
NameDescriptionTypeAdditional information
Success

boolean

None.

ErrorMessage

string

None.

DeviceList

Collection of ExportDevicesResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "DeviceList": [
    {
      "DevNum": 1,
      "TransmitterCode": "sample string 2",
      "DeviceType": "sample string 3",
      "SiteNum": 4,
      "TimerTestNum": 1,
      "TimerTestHours": 1,
      "TimerTestMinutes": 1,
      "FailTimerTestEvent": "sample string 5",
      "IPAddress": "sample string 6",
      "FirstSignalDate": "2024-05-01T18:22:50.6693305-04:00",
      "Info": "sample string 7",
      "OOSCat": "sample string 8",
      "SiteType": "sample string 9",
      "IVRNum": "sample string 10",
      "PrimaryDevNum": 1,
      "LineSecurity": "sample string 11",
      "SigForm": "sample string 12",
      "Location": "sample string 13",
      "OOSStartDate": "2024-05-01T18:22:50.6693305-04:00",
      "CommunicationType": "sample string 14",
      "AltDeviceID": "sample string 15",
      "ListenInDeviceType": "sample string 16",
      "OOSEndDate": "2024-05-01T18:22:50.6693305-04:00",
      "URLText": "sample string 17",
      "URLTarget": "sample string 18",
      "InServiceDate": "2024-05-01T18:22:50.6693305-04:00",
      "BillingID": "sample string 19",
      "Port": 1
    },
    {
      "DevNum": 1,
      "TransmitterCode": "sample string 2",
      "DeviceType": "sample string 3",
      "SiteNum": 4,
      "TimerTestNum": 1,
      "TimerTestHours": 1,
      "TimerTestMinutes": 1,
      "FailTimerTestEvent": "sample string 5",
      "IPAddress": "sample string 6",
      "FirstSignalDate": "2024-05-01T18:22:50.6693305-04:00",
      "Info": "sample string 7",
      "OOSCat": "sample string 8",
      "SiteType": "sample string 9",
      "IVRNum": "sample string 10",
      "PrimaryDevNum": 1,
      "LineSecurity": "sample string 11",
      "SigForm": "sample string 12",
      "Location": "sample string 13",
      "OOSStartDate": "2024-05-01T18:22:50.6693305-04:00",
      "CommunicationType": "sample string 14",
      "AltDeviceID": "sample string 15",
      "ListenInDeviceType": "sample string 16",
      "OOSEndDate": "2024-05-01T18:22:50.6693305-04:00",
      "URLText": "sample string 17",
      "URLTarget": "sample string 18",
      "InServiceDate": "2024-05-01T18:22:50.6693305-04:00",
      "BillingID": "sample string 19",
      "Port": 1
    }
  ]
}

application/xml, text/xml

Sample:
<ExportDevicesQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <DeviceList>
    <ExportDevicesResult>
      <AltDeviceID>sample string 15</AltDeviceID>
      <BillingID>sample string 19</BillingID>
      <CommunicationType>sample string 14</CommunicationType>
      <DevNum>1</DevNum>
      <DeviceType>sample string 3</DeviceType>
      <FailTimerTestEvent>sample string 5</FailTimerTestEvent>
      <FirstSignalDate>2024-05-01T18:22:50.6693305-04:00</FirstSignalDate>
      <IPAddress>sample string 6</IPAddress>
      <IVRNum>sample string 10</IVRNum>
      <InServiceDate>2024-05-01T18:22:50.6693305-04:00</InServiceDate>
      <Info>sample string 7</Info>
      <LineSecurity>sample string 11</LineSecurity>
      <ListenInDeviceType>sample string 16</ListenInDeviceType>
      <Location>sample string 13</Location>
      <OOSCat>sample string 8</OOSCat>
      <OOSEndDate>2024-05-01T18:22:50.6693305-04:00</OOSEndDate>
      <OOSStartDate>2024-05-01T18:22:50.6693305-04:00</OOSStartDate>
      <Port>1</Port>
      <PrimaryDevNum>1</PrimaryDevNum>
      <SigForm>sample string 12</SigForm>
      <SiteNum>4</SiteNum>
      <SiteType>sample string 9</SiteType>
      <TimerTestHours>1</TimerTestHours>
      <TimerTestMinutes>1</TimerTestMinutes>
      <TimerTestNum>1</TimerTestNum>
      <TransmitterCode>sample string 2</TransmitterCode>
      <URLTarget>sample string 18</URLTarget>
      <URLText>sample string 17</URLText>
    </ExportDevicesResult>
    <ExportDevicesResult>
      <AltDeviceID>sample string 15</AltDeviceID>
      <BillingID>sample string 19</BillingID>
      <CommunicationType>sample string 14</CommunicationType>
      <DevNum>1</DevNum>
      <DeviceType>sample string 3</DeviceType>
      <FailTimerTestEvent>sample string 5</FailTimerTestEvent>
      <FirstSignalDate>2024-05-01T18:22:50.6693305-04:00</FirstSignalDate>
      <IPAddress>sample string 6</IPAddress>
      <IVRNum>sample string 10</IVRNum>
      <InServiceDate>2024-05-01T18:22:50.6693305-04:00</InServiceDate>
      <Info>sample string 7</Info>
      <LineSecurity>sample string 11</LineSecurity>
      <ListenInDeviceType>sample string 16</ListenInDeviceType>
      <Location>sample string 13</Location>
      <OOSCat>sample string 8</OOSCat>
      <OOSEndDate>2024-05-01T18:22:50.6693305-04:00</OOSEndDate>
      <OOSStartDate>2024-05-01T18:22:50.6693305-04:00</OOSStartDate>
      <Port>1</Port>
      <PrimaryDevNum>1</PrimaryDevNum>
      <SigForm>sample string 12</SigForm>
      <SiteNum>4</SiteNum>
      <SiteType>sample string 9</SiteType>
      <TimerTestHours>1</TimerTestHours>
      <TimerTestMinutes>1</TimerTestMinutes>
      <TimerTestNum>1</TimerTestNum>
      <TransmitterCode>sample string 2</TransmitterCode>
      <URLTarget>sample string 18</URLTarget>
      <URLText>sample string 17</URLText>
    </ExportDevicesResult>
  </DeviceList>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Success>true</Success>
</ExportDevicesQueryResult>