POST api/Device/DeviceDetail
Request Information
URI Parameters
None.
Body Parameters
DeviceRequest| Name | Description | Type | Additional 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
DeviceDetailQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of DeviceDetailResult |
None. |
|
| Success | boolean |
None. |
|
| UserErrorMessage | string |
None. |
|
| ErrorTypeNum | integer |
None. |
|
| SqlConnectionLost | boolean |
None. |
|
| ClientVersion | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ExcludeColumnList": [
"sample string 1",
"sample string 2"
],
"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-03T22:36:15.8332883-07:00",
"FirstSignalTime": "sample string 19",
"FunctionOption": "sample string 20",
"HasDeviceFlag": true,
"InServiceDate": "2025-05-03T22:36:15.8332883-07:00",
"IntegrationPlatform": "sample string 21",
"IntegrationPlatformDescription": "sample string 22",
"IVRNum": "sample string 23",
"LastSignalDate": "2025-05-03T22:36:15.8332883-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-03T22:36:15.8332883-07:00",
"OOSStartDate": "2025-05-03T22:36:15.8332883-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-03T22:36:15.8332883-07:00",
"FirstSignalTime": "sample string 19",
"FunctionOption": "sample string 20",
"HasDeviceFlag": true,
"InServiceDate": "2025-05-03T22:36:15.8332883-07:00",
"IntegrationPlatform": "sample string 21",
"IntegrationPlatformDescription": "sample string 22",
"IVRNum": "sample string 23",
"LastSignalDate": "2025-05-03T22:36:15.8332883-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-03T22:36:15.8332883-07:00",
"OOSStartDate": "2025-05-03T22:36:15.8332883-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"
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<DeviceDetailQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
<ClientVersion>sample string 5</ClientVersion>
<ErrorTypeNum>3</ErrorTypeNum>
<SqlConnectionLost>true</SqlConnectionLost>
<Success>true</Success>
<UserErrorMessage>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>
<DeviceDetailResult>
<ActPlanDescription>sample string 2</ActPlanDescription>
<ActionPlanSearch>sample string 1</ActionPlanSearch>
<AltDeviceID>sample string 3</AltDeviceID>
<AlternateTimerTestInterval>sample string 4</AlternateTimerTestInterval>
<AlternateTimerTestWhenDisarmFlag>true</AlternateTimerTestWhenDisarmFlag>
<ApplicationNum>1</ApplicationNum>
<BillingID>sample string 5</BillingID>
<CommunicationType>sample string 6</CommunicationType>
<CommunicationTypeDescription>sample string 7</CommunicationTypeDescription>
<CustomOption>sample string 8</CustomOption>
<DefaultFailTimerTestEvent>sample string 9</DefaultFailTimerTestEvent>
<DefaultTimerTestDescription>sample string 10</DefaultTimerTestDescription>
<DevNum>1</DevNum>
<DeviceConfigOnlyFlag>true</DeviceConfigOnlyFlag>
<DeviceIPAddress>sample string 12</DeviceIPAddress>
<DeviceInfo>sample string 11</DeviceInfo>
<DeviceLocation>sample string 13</DeviceLocation>
<DeviceType>sample string 14</DeviceType>
<DeviceTypeDescription>sample string 15</DeviceTypeDescription>
<EntryExitPeriod>sample string 16</EntryExitPeriod>
<EventCodeDescription>sample string 17</EventCodeDescription>
<FailTTEventCode>sample string 18</FailTTEventCode>
<FirstSignalDate>2025-05-03T22:36:15.8332883-07:00</FirstSignalDate>
<FirstSignalTime>sample string 19</FirstSignalTime>
<FunctionOption>sample string 20</FunctionOption>
<HasDeviceFlag>true</HasDeviceFlag>
<IVRNum>sample string 23</IVRNum>
<InServiceDate>2025-05-03T22:36:15.8332883-07:00</InServiceDate>
<IntegrationPlatform>sample string 21</IntegrationPlatform>
<IntegrationPlatformDescription>sample string 22</IntegrationPlatformDescription>
<LastSignalDate>2025-05-03T22:36:15.8332883-07:00</LastSignalDate>
<LineSecurity>sample string 24</LineSecurity>
<ListenInDeviceType>sample string 25</ListenInDeviceType>
<ListenInDeviceTypeDescription>sample string 26</ListenInDeviceTypeDescription>
<OOSCat>sample string 27</OOSCat>
<OOSCatDescription>sample string 28</OOSCatDescription>
<OOSEndDate>2025-05-03T22:36:15.8332883-07:00</OOSEndDate>
<OOSStartDate>2025-05-03T22:36:15.8332883-07:00</OOSStartDate>
<Option>sample string 46</Option>
<Password>sample string 29</Password>
<Port>1</Port>
<PrimaryDevNum>1</PrimaryDevNum>
<PrimaryTransmitterCode>sample string 30</PrimaryTransmitterCode>
<ProcessSignalsOnPrimaryFlag>true</ProcessSignalsOnPrimaryFlag>
<ProgramArgument>sample string 31</ProgramArgument>
<ProgramLabel>sample string 32</ProgramLabel>
<ProgramPath>sample string 33</ProgramPath>
<SigForm>sample string 34</SigForm>
<SignalFormatDescription>sample string 35</SignalFormatDescription>
<SignalForwardCode>sample string 36</SignalForwardCode>
<SilentFlag>true</SilentFlag>
<SiteGroupNum>1</SiteGroupNum>
<SiteName>sample string 37</SiteName>
<SiteNum>1</SiteNum>
<SiteType>sample string 47</SiteType>
<SiteTypeDescription>sample string 48</SiteTypeDescription>
<TimerTestAltHours>1</TimerTestAltHours>
<TimerTestAltMinutes>1</TimerTestAltMinutes>
<TimerTestDays>1</TimerTestDays>
<TimerTestDefaultInterval>sample string 38</TimerTestDefaultInterval>
<TimerTestDescription>sample string 39</TimerTestDescription>
<TimerTestHours>1</TimerTestHours>
<TimerTestMinutes>1</TimerTestMinutes>
<TimerTestNum>1</TimerTestNum>
<TitleSiteName>sample string 40</TitleSiteName>
<TransmitterCode>sample string 41</TransmitterCode>
<URLTarget>sample string 42</URLTarget>
<URLText>sample string 43</URLText>
<UserName>sample string 44</UserName>
<XmitOk>sample string 45</XmitOk>
</DeviceDetailResult>
<DeviceDetailResult>
<ActPlanDescription>sample string 2</ActPlanDescription>
<ActionPlanSearch>sample string 1</ActionPlanSearch>
<AltDeviceID>sample string 3</AltDeviceID>
<AlternateTimerTestInterval>sample string 4</AlternateTimerTestInterval>
<AlternateTimerTestWhenDisarmFlag>true</AlternateTimerTestWhenDisarmFlag>
<ApplicationNum>1</ApplicationNum>
<BillingID>sample string 5</BillingID>
<CommunicationType>sample string 6</CommunicationType>
<CommunicationTypeDescription>sample string 7</CommunicationTypeDescription>
<CustomOption>sample string 8</CustomOption>
<DefaultFailTimerTestEvent>sample string 9</DefaultFailTimerTestEvent>
<DefaultTimerTestDescription>sample string 10</DefaultTimerTestDescription>
<DevNum>1</DevNum>
<DeviceConfigOnlyFlag>true</DeviceConfigOnlyFlag>
<DeviceIPAddress>sample string 12</DeviceIPAddress>
<DeviceInfo>sample string 11</DeviceInfo>
<DeviceLocation>sample string 13</DeviceLocation>
<DeviceType>sample string 14</DeviceType>
<DeviceTypeDescription>sample string 15</DeviceTypeDescription>
<EntryExitPeriod>sample string 16</EntryExitPeriod>
<EventCodeDescription>sample string 17</EventCodeDescription>
<FailTTEventCode>sample string 18</FailTTEventCode>
<FirstSignalDate>2025-05-03T22:36:15.8332883-07:00</FirstSignalDate>
<FirstSignalTime>sample string 19</FirstSignalTime>
<FunctionOption>sample string 20</FunctionOption>
<HasDeviceFlag>true</HasDeviceFlag>
<IVRNum>sample string 23</IVRNum>
<InServiceDate>2025-05-03T22:36:15.8332883-07:00</InServiceDate>
<IntegrationPlatform>sample string 21</IntegrationPlatform>
<IntegrationPlatformDescription>sample string 22</IntegrationPlatformDescription>
<LastSignalDate>2025-05-03T22:36:15.8332883-07:00</LastSignalDate>
<LineSecurity>sample string 24</LineSecurity>
<ListenInDeviceType>sample string 25</ListenInDeviceType>
<ListenInDeviceTypeDescription>sample string 26</ListenInDeviceTypeDescription>
<OOSCat>sample string 27</OOSCat>
<OOSCatDescription>sample string 28</OOSCatDescription>
<OOSEndDate>2025-05-03T22:36:15.8332883-07:00</OOSEndDate>
<OOSStartDate>2025-05-03T22:36:15.8332883-07:00</OOSStartDate>
<Option>sample string 46</Option>
<Password>sample string 29</Password>
<Port>1</Port>
<PrimaryDevNum>1</PrimaryDevNum>
<PrimaryTransmitterCode>sample string 30</PrimaryTransmitterCode>
<ProcessSignalsOnPrimaryFlag>true</ProcessSignalsOnPrimaryFlag>
<ProgramArgument>sample string 31</ProgramArgument>
<ProgramLabel>sample string 32</ProgramLabel>
<ProgramPath>sample string 33</ProgramPath>
<SigForm>sample string 34</SigForm>
<SignalFormatDescription>sample string 35</SignalFormatDescription>
<SignalForwardCode>sample string 36</SignalForwardCode>
<SilentFlag>true</SilentFlag>
<SiteGroupNum>1</SiteGroupNum>
<SiteName>sample string 37</SiteName>
<SiteNum>1</SiteNum>
<SiteType>sample string 47</SiteType>
<SiteTypeDescription>sample string 48</SiteTypeDescription>
<TimerTestAltHours>1</TimerTestAltHours>
<TimerTestAltMinutes>1</TimerTestAltMinutes>
<TimerTestDays>1</TimerTestDays>
<TimerTestDefaultInterval>sample string 38</TimerTestDefaultInterval>
<TimerTestDescription>sample string 39</TimerTestDescription>
<TimerTestHours>1</TimerTestHours>
<TimerTestMinutes>1</TimerTestMinutes>
<TimerTestNum>1</TimerTestNum>
<TitleSiteName>sample string 40</TitleSiteName>
<TransmitterCode>sample string 41</TransmitterCode>
<URLTarget>sample string 42</URLTarget>
<URLText>sample string 43</URLText>
<UserName>sample string 44</UserName>
<XmitOk>sample string 45</XmitOk>
</DeviceDetailResult>
</ResultSet>
</DeviceDetailQueryResult>