POST api/Device/DeviceListWithDetail

Request Information

URI Parameters

None.

Body Parameters

DeviceRequest
NameDescriptionTypeAdditional information
DevNum

integer

None.
SiteNum

integer

None.
SessionNum

integer

None.
SessionPassword

Collection of byte

None.
ApplicationCode

string

None.
StagesURL

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<DeviceRequest 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>
  <DevNum>1</DevNum>
</DeviceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DeviceListWithDetailQueryResult
NameDescriptionTypeAdditional information
ResultSet

Collection of DeviceDetailResult

None.
ExcludeColumnList

Collection of string

None.
Success

boolean

None.
UserErrorMessage

string

None.
ErrorTypeNum

integer

None.
SqlConnectionLost

boolean

None.
ClientVersion

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5",
  "ResultSet": [
    {
      "ActionPlanSearch": "sample string 1",
      "ActPlanDescription": "sample string 2",
      "AltDeviceID": "sample string 3",
      "AlternateTimerTestInterval": "sample string 4",
      "AlternateTimerTestWhenDisarmFlag": true,
      "ApplicationNum": 1,
      "BillingID": "sample string 5",
      "CommunicationType": "sample string 6",
      "CommunicationTypeDescription": "sample string 7",
      "CustomOption": "sample string 8",
      "DefaultFailTimerTestEvent": "sample string 9",
      "DefaultTimerTestDescription": "sample string 10",
      "DeviceConfigOnlyFlag": true,
      "DeviceInfo": "sample string 11",
      "DeviceIPAddress": "sample string 12",
      "DeviceLocation": "sample string 13",
      "DeviceType": "sample string 14",
      "DeviceTypeDescription": "sample string 15",
      "DevNum": 1,
      "EntryExitPeriod": "sample string 16",
      "EventCodeDescription": "sample string 17",
      "FailTTEventCode": "sample string 18",
      "FirstSignalDate": "2025-05-03T23:02:51.4134561-07:00",
      "FirstSignalTime": "sample string 19",
      "FunctionOption": "sample string 20",
      "HasDeviceFlag": true,
      "InServiceDate": "2025-05-03T23:02:51.4134561-07:00",
      "IntegrationPlatform": "sample string 21",
      "IntegrationPlatformDescription": "sample string 22",
      "IVRNum": "sample string 23",
      "LastSignalDate": "2025-05-03T23:02:51.4134561-07:00",
      "LineSecurity": "sample string 24",
      "ListenInDeviceType": "sample string 25",
      "ListenInDeviceTypeDescription": "sample string 26",
      "OOSCat": "sample string 27",
      "OOSCatDescription": "sample string 28",
      "OOSEndDate": "2025-05-03T23:02:51.4134561-07:00",
      "OOSStartDate": "2025-05-03T23:02:51.4134561-07:00",
      "Password": "sample string 29",
      "Port": 1,
      "PrimaryDevNum": 1,
      "PrimaryTransmitterCode": "sample string 30",
      "ProcessSignalsOnPrimaryFlag": true,
      "ProgramArgument": "sample string 31",
      "ProgramLabel": "sample string 32",
      "ProgramPath": "sample string 33",
      "SigForm": "sample string 34",
      "SignalFormatDescription": "sample string 35",
      "SignalForwardCode": "sample string 36",
      "SilentFlag": true,
      "SiteName": "sample string 37",
      "SiteNum": 1,
      "TimerTestAltHours": 1,
      "TimerTestAltMinutes": 1,
      "TimerTestDays": 1,
      "TimerTestDefaultInterval": "sample string 38",
      "TimerTestDescription": "sample string 39",
      "TimerTestHours": 1,
      "TimerTestMinutes": 1,
      "TimerTestNum": 1,
      "TitleSiteName": "sample string 40",
      "TransmitterCode": "sample string 41",
      "URLTarget": "sample string 42",
      "URLText": "sample string 43",
      "UserName": "sample string 44",
      "XmitOk": "sample string 45",
      "Option": "sample string 46",
      "SiteGroupNum": 1,
      "SiteType": "sample string 47",
      "SiteTypeDescription": "sample string 48"
    },
    {
      "ActionPlanSearch": "sample string 1",
      "ActPlanDescription": "sample string 2",
      "AltDeviceID": "sample string 3",
      "AlternateTimerTestInterval": "sample string 4",
      "AlternateTimerTestWhenDisarmFlag": true,
      "ApplicationNum": 1,
      "BillingID": "sample string 5",
      "CommunicationType": "sample string 6",
      "CommunicationTypeDescription": "sample string 7",
      "CustomOption": "sample string 8",
      "DefaultFailTimerTestEvent": "sample string 9",
      "DefaultTimerTestDescription": "sample string 10",
      "DeviceConfigOnlyFlag": true,
      "DeviceInfo": "sample string 11",
      "DeviceIPAddress": "sample string 12",
      "DeviceLocation": "sample string 13",
      "DeviceType": "sample string 14",
      "DeviceTypeDescription": "sample string 15",
      "DevNum": 1,
      "EntryExitPeriod": "sample string 16",
      "EventCodeDescription": "sample string 17",
      "FailTTEventCode": "sample string 18",
      "FirstSignalDate": "2025-05-03T23:02:51.4134561-07:00",
      "FirstSignalTime": "sample string 19",
      "FunctionOption": "sample string 20",
      "HasDeviceFlag": true,
      "InServiceDate": "2025-05-03T23:02:51.4134561-07:00",
      "IntegrationPlatform": "sample string 21",
      "IntegrationPlatformDescription": "sample string 22",
      "IVRNum": "sample string 23",
      "LastSignalDate": "2025-05-03T23:02:51.4134561-07:00",
      "LineSecurity": "sample string 24",
      "ListenInDeviceType": "sample string 25",
      "ListenInDeviceTypeDescription": "sample string 26",
      "OOSCat": "sample string 27",
      "OOSCatDescription": "sample string 28",
      "OOSEndDate": "2025-05-03T23:02:51.4134561-07:00",
      "OOSStartDate": "2025-05-03T23:02:51.4134561-07:00",
      "Password": "sample string 29",
      "Port": 1,
      "PrimaryDevNum": 1,
      "PrimaryTransmitterCode": "sample string 30",
      "ProcessSignalsOnPrimaryFlag": true,
      "ProgramArgument": "sample string 31",
      "ProgramLabel": "sample string 32",
      "ProgramPath": "sample string 33",
      "SigForm": "sample string 34",
      "SignalFormatDescription": "sample string 35",
      "SignalForwardCode": "sample string 36",
      "SilentFlag": true,
      "SiteName": "sample string 37",
      "SiteNum": 1,
      "TimerTestAltHours": 1,
      "TimerTestAltMinutes": 1,
      "TimerTestDays": 1,
      "TimerTestDefaultInterval": "sample string 38",
      "TimerTestDescription": "sample string 39",
      "TimerTestHours": 1,
      "TimerTestMinutes": 1,
      "TimerTestNum": 1,
      "TitleSiteName": "sample string 40",
      "TransmitterCode": "sample string 41",
      "URLTarget": "sample string 42",
      "URLText": "sample string 43",
      "UserName": "sample string 44",
      "XmitOk": "sample string 45",
      "Option": "sample string 46",
      "SiteGroupNum": 1,
      "SiteType": "sample string 47",
      "SiteTypeDescription": "sample string 48"
    }
  ],
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<DeviceListWithDetailQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <ClientVersion xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</ClientVersion>
  <ErrorTypeNum xmlns="http://schemas.datacontract.org/2004/07/Stages">3</ErrorTypeNum>
  <SqlConnectionLost xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SqlConnectionLost>
  <Success xmlns="http://schemas.datacontract.org/2004/07/Stages">true</Success>
  <UserErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Stages">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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/Stages">
    <d2p1:DeviceDetailResult>
      <d2p1:ActPlanDescription>sample string 2</d2p1:ActPlanDescription>
      <d2p1:ActionPlanSearch>sample string 1</d2p1:ActionPlanSearch>
      <d2p1:AltDeviceID>sample string 3</d2p1:AltDeviceID>
      <d2p1:AlternateTimerTestInterval>sample string 4</d2p1:AlternateTimerTestInterval>
      <d2p1:AlternateTimerTestWhenDisarmFlag>true</d2p1:AlternateTimerTestWhenDisarmFlag>
      <d2p1:ApplicationNum>1</d2p1:ApplicationNum>
      <d2p1:BillingID>sample string 5</d2p1:BillingID>
      <d2p1:CommunicationType>sample string 6</d2p1:CommunicationType>
      <d2p1:CommunicationTypeDescription>sample string 7</d2p1:CommunicationTypeDescription>
      <d2p1:CustomOption>sample string 8</d2p1:CustomOption>
      <d2p1:DefaultFailTimerTestEvent>sample string 9</d2p1:DefaultFailTimerTestEvent>
      <d2p1:DefaultTimerTestDescription>sample string 10</d2p1:DefaultTimerTestDescription>
      <d2p1:DevNum>1</d2p1:DevNum>
      <d2p1:DeviceConfigOnlyFlag>true</d2p1:DeviceConfigOnlyFlag>
      <d2p1:DeviceIPAddress>sample string 12</d2p1:DeviceIPAddress>
      <d2p1:DeviceInfo>sample string 11</d2p1:DeviceInfo>
      <d2p1:DeviceLocation>sample string 13</d2p1:DeviceLocation>
      <d2p1:DeviceType>sample string 14</d2p1:DeviceType>
      <d2p1:DeviceTypeDescription>sample string 15</d2p1:DeviceTypeDescription>
      <d2p1:EntryExitPeriod>sample string 16</d2p1:EntryExitPeriod>
      <d2p1:EventCodeDescription>sample string 17</d2p1:EventCodeDescription>
      <d2p1:FailTTEventCode>sample string 18</d2p1:FailTTEventCode>
      <d2p1:FirstSignalDate>2025-05-03T23:02:51.4134561-07:00</d2p1:FirstSignalDate>
      <d2p1:FirstSignalTime>sample string 19</d2p1:FirstSignalTime>
      <d2p1:FunctionOption>sample string 20</d2p1:FunctionOption>
      <d2p1:HasDeviceFlag>true</d2p1:HasDeviceFlag>
      <d2p1:IVRNum>sample string 23</d2p1:IVRNum>
      <d2p1:InServiceDate>2025-05-03T23:02:51.4134561-07:00</d2p1:InServiceDate>
      <d2p1:IntegrationPlatform>sample string 21</d2p1:IntegrationPlatform>
      <d2p1:IntegrationPlatformDescription>sample string 22</d2p1:IntegrationPlatformDescription>
      <d2p1:LastSignalDate>2025-05-03T23:02:51.4134561-07:00</d2p1:LastSignalDate>
      <d2p1:LineSecurity>sample string 24</d2p1:LineSecurity>
      <d2p1:ListenInDeviceType>sample string 25</d2p1:ListenInDeviceType>
      <d2p1:ListenInDeviceTypeDescription>sample string 26</d2p1:ListenInDeviceTypeDescription>
      <d2p1:OOSCat>sample string 27</d2p1:OOSCat>
      <d2p1:OOSCatDescription>sample string 28</d2p1:OOSCatDescription>
      <d2p1:OOSEndDate>2025-05-03T23:02:51.4134561-07:00</d2p1:OOSEndDate>
      <d2p1:OOSStartDate>2025-05-03T23:02:51.4134561-07:00</d2p1:OOSStartDate>
      <d2p1:Option>sample string 46</d2p1:Option>
      <d2p1:Password>sample string 29</d2p1:Password>
      <d2p1:Port>1</d2p1:Port>
      <d2p1:PrimaryDevNum>1</d2p1:PrimaryDevNum>
      <d2p1:PrimaryTransmitterCode>sample string 30</d2p1:PrimaryTransmitterCode>
      <d2p1:ProcessSignalsOnPrimaryFlag>true</d2p1:ProcessSignalsOnPrimaryFlag>
      <d2p1:ProgramArgument>sample string 31</d2p1:ProgramArgument>
      <d2p1:ProgramLabel>sample string 32</d2p1:ProgramLabel>
      <d2p1:ProgramPath>sample string 33</d2p1:ProgramPath>
      <d2p1:SigForm>sample string 34</d2p1:SigForm>
      <d2p1:SignalFormatDescription>sample string 35</d2p1:SignalFormatDescription>
      <d2p1:SignalForwardCode>sample string 36</d2p1:SignalForwardCode>
      <d2p1:SilentFlag>true</d2p1:SilentFlag>
      <d2p1:SiteGroupNum>1</d2p1:SiteGroupNum>
      <d2p1:SiteName>sample string 37</d2p1:SiteName>
      <d2p1:SiteNum>1</d2p1:SiteNum>
      <d2p1:SiteType>sample string 47</d2p1:SiteType>
      <d2p1:SiteTypeDescription>sample string 48</d2p1:SiteTypeDescription>
      <d2p1:TimerTestAltHours>1</d2p1:TimerTestAltHours>
      <d2p1:TimerTestAltMinutes>1</d2p1:TimerTestAltMinutes>
      <d2p1:TimerTestDays>1</d2p1:TimerTestDays>
      <d2p1:TimerTestDefaultInterval>sample string 38</d2p1:TimerTestDefaultInterval>
      <d2p1:TimerTestDescription>sample string 39</d2p1:TimerTestDescription>
      <d2p1:TimerTestHours>1</d2p1:TimerTestHours>
      <d2p1:TimerTestMinutes>1</d2p1:TimerTestMinutes>
      <d2p1:TimerTestNum>1</d2p1:TimerTestNum>
      <d2p1:TitleSiteName>sample string 40</d2p1:TitleSiteName>
      <d2p1:TransmitterCode>sample string 41</d2p1:TransmitterCode>
      <d2p1:URLTarget>sample string 42</d2p1:URLTarget>
      <d2p1:URLText>sample string 43</d2p1:URLText>
      <d2p1:UserName>sample string 44</d2p1:UserName>
      <d2p1:XmitOk>sample string 45</d2p1:XmitOk>
    </d2p1:DeviceDetailResult>
    <d2p1:DeviceDetailResult>
      <d2p1:ActPlanDescription>sample string 2</d2p1:ActPlanDescription>
      <d2p1:ActionPlanSearch>sample string 1</d2p1:ActionPlanSearch>
      <d2p1:AltDeviceID>sample string 3</d2p1:AltDeviceID>
      <d2p1:AlternateTimerTestInterval>sample string 4</d2p1:AlternateTimerTestInterval>
      <d2p1:AlternateTimerTestWhenDisarmFlag>true</d2p1:AlternateTimerTestWhenDisarmFlag>
      <d2p1:ApplicationNum>1</d2p1:ApplicationNum>
      <d2p1:BillingID>sample string 5</d2p1:BillingID>
      <d2p1:CommunicationType>sample string 6</d2p1:CommunicationType>
      <d2p1:CommunicationTypeDescription>sample string 7</d2p1:CommunicationTypeDescription>
      <d2p1:CustomOption>sample string 8</d2p1:CustomOption>
      <d2p1:DefaultFailTimerTestEvent>sample string 9</d2p1:DefaultFailTimerTestEvent>
      <d2p1:DefaultTimerTestDescription>sample string 10</d2p1:DefaultTimerTestDescription>
      <d2p1:DevNum>1</d2p1:DevNum>
      <d2p1:DeviceConfigOnlyFlag>true</d2p1:DeviceConfigOnlyFlag>
      <d2p1:DeviceIPAddress>sample string 12</d2p1:DeviceIPAddress>
      <d2p1:DeviceInfo>sample string 11</d2p1:DeviceInfo>
      <d2p1:DeviceLocation>sample string 13</d2p1:DeviceLocation>
      <d2p1:DeviceType>sample string 14</d2p1:DeviceType>
      <d2p1:DeviceTypeDescription>sample string 15</d2p1:DeviceTypeDescription>
      <d2p1:EntryExitPeriod>sample string 16</d2p1:EntryExitPeriod>
      <d2p1:EventCodeDescription>sample string 17</d2p1:EventCodeDescription>
      <d2p1:FailTTEventCode>sample string 18</d2p1:FailTTEventCode>
      <d2p1:FirstSignalDate>2025-05-03T23:02:51.4134561-07:00</d2p1:FirstSignalDate>
      <d2p1:FirstSignalTime>sample string 19</d2p1:FirstSignalTime>
      <d2p1:FunctionOption>sample string 20</d2p1:FunctionOption>
      <d2p1:HasDeviceFlag>true</d2p1:HasDeviceFlag>
      <d2p1:IVRNum>sample string 23</d2p1:IVRNum>
      <d2p1:InServiceDate>2025-05-03T23:02:51.4134561-07:00</d2p1:InServiceDate>
      <d2p1:IntegrationPlatform>sample string 21</d2p1:IntegrationPlatform>
      <d2p1:IntegrationPlatformDescription>sample string 22</d2p1:IntegrationPlatformDescription>
      <d2p1:LastSignalDate>2025-05-03T23:02:51.4134561-07:00</d2p1:LastSignalDate>
      <d2p1:LineSecurity>sample string 24</d2p1:LineSecurity>
      <d2p1:ListenInDeviceType>sample string 25</d2p1:ListenInDeviceType>
      <d2p1:ListenInDeviceTypeDescription>sample string 26</d2p1:ListenInDeviceTypeDescription>
      <d2p1:OOSCat>sample string 27</d2p1:OOSCat>
      <d2p1:OOSCatDescription>sample string 28</d2p1:OOSCatDescription>
      <d2p1:OOSEndDate>2025-05-03T23:02:51.4134561-07:00</d2p1:OOSEndDate>
      <d2p1:OOSStartDate>2025-05-03T23:02:51.4134561-07:00</d2p1:OOSStartDate>
      <d2p1:Option>sample string 46</d2p1:Option>
      <d2p1:Password>sample string 29</d2p1:Password>
      <d2p1:Port>1</d2p1:Port>
      <d2p1:PrimaryDevNum>1</d2p1:PrimaryDevNum>
      <d2p1:PrimaryTransmitterCode>sample string 30</d2p1:PrimaryTransmitterCode>
      <d2p1:ProcessSignalsOnPrimaryFlag>true</d2p1:ProcessSignalsOnPrimaryFlag>
      <d2p1:ProgramArgument>sample string 31</d2p1:ProgramArgument>
      <d2p1:ProgramLabel>sample string 32</d2p1:ProgramLabel>
      <d2p1:ProgramPath>sample string 33</d2p1:ProgramPath>
      <d2p1:SigForm>sample string 34</d2p1:SigForm>
      <d2p1:SignalFormatDescription>sample string 35</d2p1:SignalFormatDescription>
      <d2p1:SignalForwardCode>sample string 36</d2p1:SignalForwardCode>
      <d2p1:SilentFlag>true</d2p1:SilentFlag>
      <d2p1:SiteGroupNum>1</d2p1:SiteGroupNum>
      <d2p1:SiteName>sample string 37</d2p1:SiteName>
      <d2p1:SiteNum>1</d2p1:SiteNum>
      <d2p1:SiteType>sample string 47</d2p1:SiteType>
      <d2p1:SiteTypeDescription>sample string 48</d2p1:SiteTypeDescription>
      <d2p1:TimerTestAltHours>1</d2p1:TimerTestAltHours>
      <d2p1:TimerTestAltMinutes>1</d2p1:TimerTestAltMinutes>
      <d2p1:TimerTestDays>1</d2p1:TimerTestDays>
      <d2p1:TimerTestDefaultInterval>sample string 38</d2p1:TimerTestDefaultInterval>
      <d2p1:TimerTestDescription>sample string 39</d2p1:TimerTestDescription>
      <d2p1:TimerTestHours>1</d2p1:TimerTestHours>
      <d2p1:TimerTestMinutes>1</d2p1:TimerTestMinutes>
      <d2p1:TimerTestNum>1</d2p1:TimerTestNum>
      <d2p1:TitleSiteName>sample string 40</d2p1:TitleSiteName>
      <d2p1:TransmitterCode>sample string 41</d2p1:TransmitterCode>
      <d2p1:URLTarget>sample string 42</d2p1:URLTarget>
      <d2p1:URLText>sample string 43</d2p1:URLText>
      <d2p1:UserName>sample string 44</d2p1:UserName>
      <d2p1:XmitOk>sample string 45</d2p1:XmitOk>
    </d2p1:DeviceDetailResult>
  </ResultSet>
</DeviceListWithDetailQueryResult>