POST api/Device/EventRuleList
Request Information
URI Parameters
None.
Body Parameters
EventRuleRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| EventRuleNum | integer |
None. |
|
| DevNum | integer |
None. |
|
| SiteGroupNum | integer |
None. |
|
| SiteType | string |
None. |
|
| DispatchType | string |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"EventRuleNum": 1,
"DevNum": 1,
"SiteGroupNum": 1,
"SiteType": "sample string 1",
"DispatchType": "sample string 2",
"SessionNum": 3,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 4",
"StagesURL": "sample string 5"
}
application/xml, text/xml
Sample:
<EventRuleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 5</StagesURL> <ApplicationCode>sample string 4</ApplicationCode> <SessionNum>3</SessionNum> <SessionPassword>QEA=</SessionPassword> <DevNum>1</DevNum> <DispatchType>sample string 2</DispatchType> <EventRuleNum>1</EventRuleNum> <SiteGroupNum>1</SiteGroupNum> <SiteType>sample string 1</SiteType> </EventRuleRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
EventRuleListQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of EventRuleListResult |
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": [
{
"Description": "sample string 1",
"DevNum": 1,
"DispatchType": "sample string 2",
"DispatchTypeDescription": "sample string 3",
"EventCode": "sample string 4",
"EventCodeDescription": "sample string 5",
"EventRuleNum": 1,
"HighlightFlag": true,
"HighlightNum": 1,
"Point": "sample string 6",
"ServiceTypeDescription": "sample string 7",
"ServType": "sample string 8",
"SigForm": "sample string 9",
"SignalCode": "sample string 10",
"SignalCodeDescription": "sample string 11",
"SignalFormatDescription": "sample string 12",
"SignalStatus": "sample string 13",
"SignalStatusDescription": "sample string 14",
"SiteGroupNum": 1,
"SiteType": "sample string 15",
"SiteTypeDescription": "sample string 16",
"Category": "sample string 17",
"ReadOnlyFlag": true,
"StyleCode": "sample string 18"
},
{
"Description": "sample string 1",
"DevNum": 1,
"DispatchType": "sample string 2",
"DispatchTypeDescription": "sample string 3",
"EventCode": "sample string 4",
"EventCodeDescription": "sample string 5",
"EventRuleNum": 1,
"HighlightFlag": true,
"HighlightNum": 1,
"Point": "sample string 6",
"ServiceTypeDescription": "sample string 7",
"ServType": "sample string 8",
"SigForm": "sample string 9",
"SignalCode": "sample string 10",
"SignalCodeDescription": "sample string 11",
"SignalFormatDescription": "sample string 12",
"SignalStatus": "sample string 13",
"SignalStatusDescription": "sample string 14",
"SiteGroupNum": 1,
"SiteType": "sample string 15",
"SiteTypeDescription": "sample string 16",
"Category": "sample string 17",
"ReadOnlyFlag": true,
"StyleCode": "sample string 18"
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<EventRuleListQueryResult 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>
<EventRuleListResult>
<Category>sample string 17</Category>
<Description>sample string 1</Description>
<DevNum>1</DevNum>
<DispatchType>sample string 2</DispatchType>
<DispatchTypeDescription>sample string 3</DispatchTypeDescription>
<EventCode>sample string 4</EventCode>
<EventCodeDescription>sample string 5</EventCodeDescription>
<EventRuleNum>1</EventRuleNum>
<HighlightFlag>true</HighlightFlag>
<HighlightNum>1</HighlightNum>
<Point>sample string 6</Point>
<ReadOnlyFlag>true</ReadOnlyFlag>
<ServType>sample string 8</ServType>
<ServiceTypeDescription>sample string 7</ServiceTypeDescription>
<SigForm>sample string 9</SigForm>
<SignalCode>sample string 10</SignalCode>
<SignalCodeDescription>sample string 11</SignalCodeDescription>
<SignalFormatDescription>sample string 12</SignalFormatDescription>
<SignalStatus>sample string 13</SignalStatus>
<SignalStatusDescription>sample string 14</SignalStatusDescription>
<SiteGroupNum>1</SiteGroupNum>
<SiteType>sample string 15</SiteType>
<SiteTypeDescription>sample string 16</SiteTypeDescription>
<StyleCode>sample string 18</StyleCode>
</EventRuleListResult>
<EventRuleListResult>
<Category>sample string 17</Category>
<Description>sample string 1</Description>
<DevNum>1</DevNum>
<DispatchType>sample string 2</DispatchType>
<DispatchTypeDescription>sample string 3</DispatchTypeDescription>
<EventCode>sample string 4</EventCode>
<EventCodeDescription>sample string 5</EventCodeDescription>
<EventRuleNum>1</EventRuleNum>
<HighlightFlag>true</HighlightFlag>
<HighlightNum>1</HighlightNum>
<Point>sample string 6</Point>
<ReadOnlyFlag>true</ReadOnlyFlag>
<ServType>sample string 8</ServType>
<ServiceTypeDescription>sample string 7</ServiceTypeDescription>
<SigForm>sample string 9</SigForm>
<SignalCode>sample string 10</SignalCode>
<SignalCodeDescription>sample string 11</SignalCodeDescription>
<SignalFormatDescription>sample string 12</SignalFormatDescription>
<SignalStatus>sample string 13</SignalStatus>
<SignalStatusDescription>sample string 14</SignalStatusDescription>
<SiteGroupNum>1</SiteGroupNum>
<SiteType>sample string 15</SiteType>
<SiteTypeDescription>sample string 16</SiteTypeDescription>
<StyleCode>sample string 18</StyleCode>
</EventRuleListResult>
</ResultSet>
</EventRuleListQueryResult>