POST api/Zone/DeviceConfigList
Request Information
URI Parameters
None.
Body Parameters
DeviceConfigListRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Point | string |
None. |
|
| SignalStatus | string |
None. |
|
| SignalCode | string |
None. |
|
| SignalRuleNum | integer |
None. |
|
| Option | string |
None. |
|
| DevNum | integer |
None. |
|
| SiteFlag | boolean |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Point": "sample string 1",
"SignalStatus": "sample string 2",
"SignalCode": "sample string 3",
"SignalRuleNum": 1,
"Option": "sample string 4",
"DevNum": 1,
"SiteFlag": true,
"SessionNum": 5,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 6",
"StagesURL": "sample string 7"
}
application/xml, text/xml
Sample:
<DeviceConfigListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 7</StagesURL> <ApplicationCode>sample string 6</ApplicationCode> <SessionNum>5</SessionNum> <SessionPassword>QEA=</SessionPassword> <DevNum>1</DevNum> <SiteFlag>true</SiteFlag> <Option>sample string 4</Option> <Point>sample string 1</Point> <SignalCode>sample string 3</SignalCode> <SignalRuleNum>1</SignalRuleNum> <SignalStatus>sample string 2</SignalStatus> </DeviceConfigListRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DeviceConfigListQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of DeviceConfigListResult |
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": [
{
"ActionPlanNotesXml": {
"SectionList": [
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
]
},
"ActionPlanType": "sample string 1",
"ActionPlanVersionNum": 1,
"AlarmConfirmation": "sample string 2",
"AlarmConfirmationDescription": "sample string 3",
"AlternateTransmitterCode": "sample string 4",
"AreaDescription": "sample string 5",
"AreaNum": 1,
"Category": "sample string 6",
"CommentBig": "sample string 7",
"DeviceTypeDescription": "sample string 8",
"DevNum": 1,
"DisplaySignalRuleNum": 1,
"EffectiveActionPlanDescription": "sample string 9",
"EffectiveActionPlanNum": 1,
"EventCodeWithDescr": "sample string 10",
"From": "sample string 11",
"HighlightFlag": true,
"OrderNum": 1,
"Point": "sample string 12",
"PointDescription": "sample string 13",
"PointFlag": true,
"ReportsRestoreFlag": true,
"SchedNum": 1,
"ServType": "sample string 14",
"SignalCode": "sample string 15",
"SignalFormatDescription": "sample string 16",
"SignalRuleNum": 1,
"SignalStatus": "sample string 17",
"SiteGroupName": "sample string 18",
"SiteTypeDescription": "sample string 19",
"StyleCode": "sample string 20",
"TitleSiteName": "sample string 21",
"TransmitterCode": "sample string 22",
"DeviceType": "sample string 23"
},
{
"ActionPlanNotesXml": {
"SectionList": [
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
]
},
"ActionPlanType": "sample string 1",
"ActionPlanVersionNum": 1,
"AlarmConfirmation": "sample string 2",
"AlarmConfirmationDescription": "sample string 3",
"AlternateTransmitterCode": "sample string 4",
"AreaDescription": "sample string 5",
"AreaNum": 1,
"Category": "sample string 6",
"CommentBig": "sample string 7",
"DeviceTypeDescription": "sample string 8",
"DevNum": 1,
"DisplaySignalRuleNum": 1,
"EffectiveActionPlanDescription": "sample string 9",
"EffectiveActionPlanNum": 1,
"EventCodeWithDescr": "sample string 10",
"From": "sample string 11",
"HighlightFlag": true,
"OrderNum": 1,
"Point": "sample string 12",
"PointDescription": "sample string 13",
"PointFlag": true,
"ReportsRestoreFlag": true,
"SchedNum": 1,
"ServType": "sample string 14",
"SignalCode": "sample string 15",
"SignalFormatDescription": "sample string 16",
"SignalRuleNum": 1,
"SignalStatus": "sample string 17",
"SiteGroupName": "sample string 18",
"SiteTypeDescription": "sample string 19",
"StyleCode": "sample string 20",
"TitleSiteName": "sample string 21",
"TransmitterCode": "sample string 22",
"DeviceType": "sample string 23"
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<DeviceConfigListQueryResult 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>
<DeviceConfigListResult>
<ActionPlanNotesXml>
<SectionList>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
</SectionList>
</ActionPlanNotesXml>
<ActionPlanType>sample string 1</ActionPlanType>
<ActionPlanVersionNum>1</ActionPlanVersionNum>
<AlarmConfirmation>sample string 2</AlarmConfirmation>
<AlarmConfirmationDescription>sample string 3</AlarmConfirmationDescription>
<AlternateTransmitterCode>sample string 4</AlternateTransmitterCode>
<AreaDescription>sample string 5</AreaDescription>
<AreaNum>1</AreaNum>
<Category>sample string 6</Category>
<CommentBig>sample string 7</CommentBig>
<DevNum>1</DevNum>
<DeviceType>sample string 23</DeviceType>
<DeviceTypeDescription>sample string 8</DeviceTypeDescription>
<DisplaySignalRuleNum>1</DisplaySignalRuleNum>
<EffectiveActionPlanDescription>sample string 9</EffectiveActionPlanDescription>
<EffectiveActionPlanNum>1</EffectiveActionPlanNum>
<EventCodeWithDescr>sample string 10</EventCodeWithDescr>
<From>sample string 11</From>
<HighlightFlag>true</HighlightFlag>
<OrderNum>1</OrderNum>
<Point>sample string 12</Point>
<PointDescription>sample string 13</PointDescription>
<PointFlag>true</PointFlag>
<ReportsRestoreFlag>true</ReportsRestoreFlag>
<SchedNum>1</SchedNum>
<ServType>sample string 14</ServType>
<SignalCode>sample string 15</SignalCode>
<SignalFormatDescription>sample string 16</SignalFormatDescription>
<SignalRuleNum>1</SignalRuleNum>
<SignalStatus>sample string 17</SignalStatus>
<SiteGroupName>sample string 18</SiteGroupName>
<SiteTypeDescription>sample string 19</SiteTypeDescription>
<StyleCode>sample string 20</StyleCode>
<TitleSiteName>sample string 21</TitleSiteName>
<TransmitterCode>sample string 22</TransmitterCode>
</DeviceConfigListResult>
<DeviceConfigListResult>
<ActionPlanNotesXml>
<SectionList>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
</SectionList>
</ActionPlanNotesXml>
<ActionPlanType>sample string 1</ActionPlanType>
<ActionPlanVersionNum>1</ActionPlanVersionNum>
<AlarmConfirmation>sample string 2</AlarmConfirmation>
<AlarmConfirmationDescription>sample string 3</AlarmConfirmationDescription>
<AlternateTransmitterCode>sample string 4</AlternateTransmitterCode>
<AreaDescription>sample string 5</AreaDescription>
<AreaNum>1</AreaNum>
<Category>sample string 6</Category>
<CommentBig>sample string 7</CommentBig>
<DevNum>1</DevNum>
<DeviceType>sample string 23</DeviceType>
<DeviceTypeDescription>sample string 8</DeviceTypeDescription>
<DisplaySignalRuleNum>1</DisplaySignalRuleNum>
<EffectiveActionPlanDescription>sample string 9</EffectiveActionPlanDescription>
<EffectiveActionPlanNum>1</EffectiveActionPlanNum>
<EventCodeWithDescr>sample string 10</EventCodeWithDescr>
<From>sample string 11</From>
<HighlightFlag>true</HighlightFlag>
<OrderNum>1</OrderNum>
<Point>sample string 12</Point>
<PointDescription>sample string 13</PointDescription>
<PointFlag>true</PointFlag>
<ReportsRestoreFlag>true</ReportsRestoreFlag>
<SchedNum>1</SchedNum>
<ServType>sample string 14</ServType>
<SignalCode>sample string 15</SignalCode>
<SignalFormatDescription>sample string 16</SignalFormatDescription>
<SignalRuleNum>1</SignalRuleNum>
<SignalStatus>sample string 17</SignalStatus>
<SiteGroupName>sample string 18</SiteGroupName>
<SiteTypeDescription>sample string 19</SiteTypeDescription>
<StyleCode>sample string 20</StyleCode>
<TitleSiteName>sample string 21</TitleSiteName>
<TransmitterCode>sample string 22</TransmitterCode>
</DeviceConfigListResult>
</ResultSet>
</DeviceConfigListQueryResult>