POST api/Device/QuickConfigList
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
QuickConfigListQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of QuickConfigListResult |
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"
}
]
}
]
},
"ActionPlanSearch": "sample string 1",
"ActPlanDescription": "sample string 2",
"AreaDescription": "sample string 3",
"AreaNum": 1,
"AutoProcess": "sample string 4",
"AutoProcessDescription": "sample string 5",
"DevNum": 1,
"EqLoc": "sample string 6",
"EqLocDescription": "sample string 7",
"EqType": "sample string 8",
"EqTypeDescription": "sample string 9",
"EventCode": "sample string 10",
"EventCodeDescription": "sample string 11",
"Point": "sample string 12",
"PointDescription": "sample string 13",
"ReportsRestoreFlag": true,
"ServType": "sample string 14",
"SignalCode": "sample string 15",
"SignalRuleNum": 1,
"SignalStatus": "sample string 16",
"SignalStatusDescription": "sample string 17",
"SiteNum": 1,
"TransmitterCode": "sample string 18",
"Comment": "sample string 19"
},
{
"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"
}
]
}
]
},
"ActionPlanSearch": "sample string 1",
"ActPlanDescription": "sample string 2",
"AreaDescription": "sample string 3",
"AreaNum": 1,
"AutoProcess": "sample string 4",
"AutoProcessDescription": "sample string 5",
"DevNum": 1,
"EqLoc": "sample string 6",
"EqLocDescription": "sample string 7",
"EqType": "sample string 8",
"EqTypeDescription": "sample string 9",
"EventCode": "sample string 10",
"EventCodeDescription": "sample string 11",
"Point": "sample string 12",
"PointDescription": "sample string 13",
"ReportsRestoreFlag": true,
"ServType": "sample string 14",
"SignalCode": "sample string 15",
"SignalRuleNum": 1,
"SignalStatus": "sample string 16",
"SignalStatusDescription": "sample string 17",
"SiteNum": 1,
"TransmitterCode": "sample string 18",
"Comment": "sample string 19"
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<QuickConfigListQueryResult 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>
<QuickConfigListResult>
<ActPlanDescription>sample string 2</ActPlanDescription>
<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>
<ActionPlanSearch>sample string 1</ActionPlanSearch>
<AreaDescription>sample string 3</AreaDescription>
<AreaNum>1</AreaNum>
<AutoProcess>sample string 4</AutoProcess>
<AutoProcessDescription>sample string 5</AutoProcessDescription>
<Comment>sample string 19</Comment>
<DevNum>1</DevNum>
<EqLoc>sample string 6</EqLoc>
<EqLocDescription>sample string 7</EqLocDescription>
<EqType>sample string 8</EqType>
<EqTypeDescription>sample string 9</EqTypeDescription>
<EventCode>sample string 10</EventCode>
<EventCodeDescription>sample string 11</EventCodeDescription>
<Point>sample string 12</Point>
<PointDescription>sample string 13</PointDescription>
<ReportsRestoreFlag>true</ReportsRestoreFlag>
<ServType>sample string 14</ServType>
<SignalCode>sample string 15</SignalCode>
<SignalRuleNum>1</SignalRuleNum>
<SignalStatus>sample string 16</SignalStatus>
<SignalStatusDescription>sample string 17</SignalStatusDescription>
<SiteNum>1</SiteNum>
<TransmitterCode>sample string 18</TransmitterCode>
</QuickConfigListResult>
<QuickConfigListResult>
<ActPlanDescription>sample string 2</ActPlanDescription>
<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>
<ActionPlanSearch>sample string 1</ActionPlanSearch>
<AreaDescription>sample string 3</AreaDescription>
<AreaNum>1</AreaNum>
<AutoProcess>sample string 4</AutoProcess>
<AutoProcessDescription>sample string 5</AutoProcessDescription>
<Comment>sample string 19</Comment>
<DevNum>1</DevNum>
<EqLoc>sample string 6</EqLoc>
<EqLocDescription>sample string 7</EqLocDescription>
<EqType>sample string 8</EqType>
<EqTypeDescription>sample string 9</EqTypeDescription>
<EventCode>sample string 10</EventCode>
<EventCodeDescription>sample string 11</EventCodeDescription>
<Point>sample string 12</Point>
<PointDescription>sample string 13</PointDescription>
<ReportsRestoreFlag>true</ReportsRestoreFlag>
<ServType>sample string 14</ServType>
<SignalCode>sample string 15</SignalCode>
<SignalRuleNum>1</SignalRuleNum>
<SignalStatus>sample string 16</SignalStatus>
<SignalStatusDescription>sample string 17</SignalStatusDescription>
<SiteNum>1</SiteNum>
<TransmitterCode>sample string 18</TransmitterCode>
</QuickConfigListResult>
</ResultSet>
</QuickConfigListQueryResult>