POST api/SiteGroup/SiteGroupDeviceList
Request Information
URI Parameters
None.
Body Parameters
SiteGroupDeviceRequestName | Description | Type | Additional information |
---|---|---|---|
DevNum | integer |
None. |
|
SiteNum | integer |
None. |
|
SiteGroupName | string |
None. |
|
SiteGroupNum | 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, "SiteGroupName": "sample string 1", "SiteGroupNum": 1, "SessionNum": 2, "SessionPassword": "QEA=", "ApplicationCode": "sample string 3", "StagesURL": "sample string 4" }
application/xml, text/xml
Sample:
<SiteGroupDeviceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 4</StagesURL> <ApplicationCode>sample string 3</ApplicationCode> <SessionNum>2</SessionNum> <SessionPassword>QEA=</SessionPassword> <SiteGroupNum>1</SiteGroupNum> <DevNum>1</DevNum> <SiteGroupName>sample string 1</SiteGroupName> <SiteNum>1</SiteNum> </SiteGroupDeviceRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteGroupDeviceListQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of SiteGroupDeviceListResult |
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": [ { "DeviceType": "sample string 1", "DeviceTypeDescription": "sample string 2", "DevNum": 1, "EventCodeDescription": "sample string 3", "FailTTEventCode": "sample string 4", "HighlightFlag": true, "HighlightNum": 1, "SigForm": "sample string 5", "SignalFormatDescription": "sample string 6", "SignalForwardCode": "sample string 7", "SiteGroupNum": 1, "SiteNum": 1, "SiteType": "sample string 8", "SiteTypeDescription": "sample string 9", "TimerTestAltHours": 1, "TimerTestAltMinutes": 1, "TimerTestDays": 1, "TimerTestDescription": "sample string 10", "TimerTestHours": 1, "TimerTestMinutes": 1, "TimerTestNum": 1 }, { "DeviceType": "sample string 1", "DeviceTypeDescription": "sample string 2", "DevNum": 1, "EventCodeDescription": "sample string 3", "FailTTEventCode": "sample string 4", "HighlightFlag": true, "HighlightNum": 1, "SigForm": "sample string 5", "SignalFormatDescription": "sample string 6", "SignalForwardCode": "sample string 7", "SiteGroupNum": 1, "SiteNum": 1, "SiteType": "sample string 8", "SiteTypeDescription": "sample string 9", "TimerTestAltHours": 1, "TimerTestAltMinutes": 1, "TimerTestDays": 1, "TimerTestDescription": "sample string 10", "TimerTestHours": 1, "TimerTestMinutes": 1, "TimerTestNum": 1 } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<SiteGroupDeviceListQueryResult 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> <SiteGroupDeviceListResult> <DevNum>1</DevNum> <DeviceType>sample string 1</DeviceType> <DeviceTypeDescription>sample string 2</DeviceTypeDescription> <EventCodeDescription>sample string 3</EventCodeDescription> <FailTTEventCode>sample string 4</FailTTEventCode> <HighlightFlag>true</HighlightFlag> <HighlightNum>1</HighlightNum> <SigForm>sample string 5</SigForm> <SignalFormatDescription>sample string 6</SignalFormatDescription> <SignalForwardCode>sample string 7</SignalForwardCode> <SiteGroupNum>1</SiteGroupNum> <SiteNum>1</SiteNum> <SiteType>sample string 8</SiteType> <SiteTypeDescription>sample string 9</SiteTypeDescription> <TimerTestAltHours>1</TimerTestAltHours> <TimerTestAltMinutes>1</TimerTestAltMinutes> <TimerTestDays>1</TimerTestDays> <TimerTestDescription>sample string 10</TimerTestDescription> <TimerTestHours>1</TimerTestHours> <TimerTestMinutes>1</TimerTestMinutes> <TimerTestNum>1</TimerTestNum> </SiteGroupDeviceListResult> <SiteGroupDeviceListResult> <DevNum>1</DevNum> <DeviceType>sample string 1</DeviceType> <DeviceTypeDescription>sample string 2</DeviceTypeDescription> <EventCodeDescription>sample string 3</EventCodeDescription> <FailTTEventCode>sample string 4</FailTTEventCode> <HighlightFlag>true</HighlightFlag> <HighlightNum>1</HighlightNum> <SigForm>sample string 5</SigForm> <SignalFormatDescription>sample string 6</SignalFormatDescription> <SignalForwardCode>sample string 7</SignalForwardCode> <SiteGroupNum>1</SiteGroupNum> <SiteNum>1</SiteNum> <SiteType>sample string 8</SiteType> <SiteTypeDescription>sample string 9</SiteTypeDescription> <TimerTestAltHours>1</TimerTestAltHours> <TimerTestAltMinutes>1</TimerTestAltMinutes> <TimerTestDays>1</TimerTestDays> <TimerTestDescription>sample string 10</TimerTestDescription> <TimerTestHours>1</TimerTestHours> <TimerTestMinutes>1</TimerTestMinutes> <TimerTestNum>1</TimerTestNum> </SiteGroupDeviceListResult> </ResultSet> </SiteGroupDeviceListQueryResult>