POST api/Device/EventRuleListWithDetail
Request Information
URI Parameters
None.
Body Parameters
EventRuleRequestName | 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
EventRuleListWithDetailQueryResultName | Description | Type | Additional information |
---|---|---|---|
ResultSet | Collection of EventRuleListWithDetailResult |
None. |
|
ExcludeColumnList | Collection of string |
None. |
|
Success | boolean |
None. |
|
UserErrorMessage | string |
None. |
|
ErrorTypeNum | integer |
None. |
|
SqlConnectionLost | boolean |
None. |
|
ClientVersion | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5", "ResultSet": [ { "AbortByPointFlag": true, "AbortBySignalCodeFlag": true, "AbortLogEventCode": "sample string 1", "AbortLogEventCodeDescription": "sample string 2", "AbortOptionDescription": "sample string 3", "AbortOptionNum": 1, "AbortSuppressionPeriod": "sample string 4", "AlarmFlag": true, "AlarmOption": "sample string 5", "AlarmOptionDescription": "sample string 6", "DayTimeFlag": true, "DayTimeNum": 1, "Delay": "sample string 7", "Description": "sample string 8", "DevNum": 1, "DispatchType": "sample string 9", "EventCode": "sample string 10", "EventCodeDescription": "sample string 11", "EventRuleNum": 1, "FailToAbortEventCode": "sample string 12", "FailToAbortEventDescr": "sample string 13", "LogOnlyFlag": true, "OverrideEventCode": "sample string 14", "OverrideEventCodeDescription": "sample string 15", "Point": "sample string 16", "PrimarySecondaryAbortFlag": true, "Priority": 1, "PriorityDescription": "sample string 17", "RestoreWaitCount": 1, "RestoreWaitPeriod": "sample string 18", "ScheduleOption": "sample string 19", "ScheduleOptionDescription": "sample string 20", "ServiceTypeDescription": "sample string 21", "ServType": "sample string 22", "SigForm": "sample string 23", "SignalCode": "sample string 24", "SignalCodeDescription": "sample string 25", "SignalFormatDescription": "sample string 26", "SignalStatus": "sample string 27", "SignalStatusDescription": "sample string 28", "SiteGroupNum": 1, "SiteType": "sample string 29", "SuppressionByPointFlag": true, "SuppressionDuringAlarmOnlyFlag": true, "SuppressionEndServType": "sample string 30", "SuppressionEndServTypeDescription": "sample string 31", "SuppressionPeriod": "sample string 32", "AbortableSeconds": 1, "ActionAutoEvalDescription": "sample string 33", "ActionAutoEvalNum": 1, "AbortNewPriority": 1, "AbortNewPriorityDescription": "sample string 34", "HoursType": "sample string 35", "HoursTypeDescription": "sample string 36", "DispatchTypeDescription": "sample string 37", "SiteTypeDescription": "sample string 38", "InternalNotes": "sample string 39" }, { "AbortByPointFlag": true, "AbortBySignalCodeFlag": true, "AbortLogEventCode": "sample string 1", "AbortLogEventCodeDescription": "sample string 2", "AbortOptionDescription": "sample string 3", "AbortOptionNum": 1, "AbortSuppressionPeriod": "sample string 4", "AlarmFlag": true, "AlarmOption": "sample string 5", "AlarmOptionDescription": "sample string 6", "DayTimeFlag": true, "DayTimeNum": 1, "Delay": "sample string 7", "Description": "sample string 8", "DevNum": 1, "DispatchType": "sample string 9", "EventCode": "sample string 10", "EventCodeDescription": "sample string 11", "EventRuleNum": 1, "FailToAbortEventCode": "sample string 12", "FailToAbortEventDescr": "sample string 13", "LogOnlyFlag": true, "OverrideEventCode": "sample string 14", "OverrideEventCodeDescription": "sample string 15", "Point": "sample string 16", "PrimarySecondaryAbortFlag": true, "Priority": 1, "PriorityDescription": "sample string 17", "RestoreWaitCount": 1, "RestoreWaitPeriod": "sample string 18", "ScheduleOption": "sample string 19", "ScheduleOptionDescription": "sample string 20", "ServiceTypeDescription": "sample string 21", "ServType": "sample string 22", "SigForm": "sample string 23", "SignalCode": "sample string 24", "SignalCodeDescription": "sample string 25", "SignalFormatDescription": "sample string 26", "SignalStatus": "sample string 27", "SignalStatusDescription": "sample string 28", "SiteGroupNum": 1, "SiteType": "sample string 29", "SuppressionByPointFlag": true, "SuppressionDuringAlarmOnlyFlag": true, "SuppressionEndServType": "sample string 30", "SuppressionEndServTypeDescription": "sample string 31", "SuppressionPeriod": "sample string 32", "AbortableSeconds": 1, "ActionAutoEvalDescription": "sample string 33", "ActionAutoEvalNum": 1, "AbortNewPriority": 1, "AbortNewPriorityDescription": "sample string 34", "HoursType": "sample string 35", "HoursTypeDescription": "sample string 36", "DispatchTypeDescription": "sample string 37", "SiteTypeDescription": "sample string 38", "InternalNotes": "sample string 39" } ], "ExcludeColumnList": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<EventRuleListWithDetailQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <ClientVersion xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</ClientVersion> <ErrorTypeNum xmlns="http://schemas.datacontract.org/2004/07/Stages">3</ErrorTypeNum> <SqlConnectionLost xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SqlConnectionLost> <Success xmlns="http://schemas.datacontract.org/2004/07/Stages">true</Success> <UserErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Stages">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> <EventRuleListWithDetailResult> <AbortByPointFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AbortByPointFlag> <AbortBySignalCodeFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AbortBySignalCodeFlag> <AbortLogEventCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 1</AbortLogEventCode> <AbortLogEventCodeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 2</AbortLogEventCodeDescription> <AbortNewPriority xmlns="http://schemas.datacontract.org/2004/07/Stages">1</AbortNewPriority> <AbortNewPriorityDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 34</AbortNewPriorityDescription> <AbortOptionDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 3</AbortOptionDescription> <AbortOptionNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</AbortOptionNum> <AbortSuppressionPeriod xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 4</AbortSuppressionPeriod> <AbortableSeconds xmlns="http://schemas.datacontract.org/2004/07/Stages">1</AbortableSeconds> <ActionAutoEvalDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 33</ActionAutoEvalDescription> <ActionAutoEvalNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</ActionAutoEvalNum> <AlarmFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AlarmFlag> <AlarmOption xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</AlarmOption> <AlarmOptionDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 6</AlarmOptionDescription> <DayTimeFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</DayTimeFlag> <DayTimeNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</DayTimeNum> <Delay xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 7</Delay> <Description xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 8</Description> <DevNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</DevNum> <DispatchType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 9</DispatchType> <DispatchTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 37</DispatchTypeDescription> <EventCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 10</EventCode> <EventCodeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 11</EventCodeDescription> <EventRuleNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</EventRuleNum> <FailToAbortEventCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 12</FailToAbortEventCode> <FailToAbortEventDescr xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 13</FailToAbortEventDescr> <HoursType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 35</HoursType> <HoursTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 36</HoursTypeDescription> <InternalNotes xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 39</InternalNotes> <LogOnlyFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</LogOnlyFlag> <OverrideEventCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 14</OverrideEventCode> <OverrideEventCodeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 15</OverrideEventCodeDescription> <Point xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 16</Point> <PrimarySecondaryAbortFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</PrimarySecondaryAbortFlag> <Priority xmlns="http://schemas.datacontract.org/2004/07/Stages">1</Priority> <PriorityDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 17</PriorityDescription> <RestoreWaitCount xmlns="http://schemas.datacontract.org/2004/07/Stages">1</RestoreWaitCount> <RestoreWaitPeriod xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 18</RestoreWaitPeriod> <ScheduleOption xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 19</ScheduleOption> <ScheduleOptionDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 20</ScheduleOptionDescription> <ServType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 22</ServType> <ServiceTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 21</ServiceTypeDescription> <SigForm xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 23</SigForm> <SignalCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 24</SignalCode> <SignalCodeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 25</SignalCodeDescription> <SignalFormatDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 26</SignalFormatDescription> <SignalStatus xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 27</SignalStatus> <SignalStatusDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 28</SignalStatusDescription> <SiteGroupNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</SiteGroupNum> <SiteType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 29</SiteType> <SiteTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 38</SiteTypeDescription> <SuppressionByPointFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SuppressionByPointFlag> <SuppressionDuringAlarmOnlyFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SuppressionDuringAlarmOnlyFlag> <SuppressionEndServType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 30</SuppressionEndServType> <SuppressionEndServTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 31</SuppressionEndServTypeDescription> <SuppressionPeriod xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 32</SuppressionPeriod> </EventRuleListWithDetailResult> <EventRuleListWithDetailResult> <AbortByPointFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AbortByPointFlag> <AbortBySignalCodeFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AbortBySignalCodeFlag> <AbortLogEventCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 1</AbortLogEventCode> <AbortLogEventCodeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 2</AbortLogEventCodeDescription> <AbortNewPriority xmlns="http://schemas.datacontract.org/2004/07/Stages">1</AbortNewPriority> <AbortNewPriorityDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 34</AbortNewPriorityDescription> <AbortOptionDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 3</AbortOptionDescription> <AbortOptionNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</AbortOptionNum> <AbortSuppressionPeriod xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 4</AbortSuppressionPeriod> <AbortableSeconds xmlns="http://schemas.datacontract.org/2004/07/Stages">1</AbortableSeconds> <ActionAutoEvalDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 33</ActionAutoEvalDescription> <ActionAutoEvalNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</ActionAutoEvalNum> <AlarmFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</AlarmFlag> <AlarmOption xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</AlarmOption> <AlarmOptionDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 6</AlarmOptionDescription> <DayTimeFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</DayTimeFlag> <DayTimeNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</DayTimeNum> <Delay xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 7</Delay> <Description xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 8</Description> <DevNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</DevNum> <DispatchType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 9</DispatchType> <DispatchTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 37</DispatchTypeDescription> <EventCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 10</EventCode> <EventCodeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 11</EventCodeDescription> <EventRuleNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</EventRuleNum> <FailToAbortEventCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 12</FailToAbortEventCode> <FailToAbortEventDescr xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 13</FailToAbortEventDescr> <HoursType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 35</HoursType> <HoursTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 36</HoursTypeDescription> <InternalNotes xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 39</InternalNotes> <LogOnlyFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</LogOnlyFlag> <OverrideEventCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 14</OverrideEventCode> <OverrideEventCodeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 15</OverrideEventCodeDescription> <Point xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 16</Point> <PrimarySecondaryAbortFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</PrimarySecondaryAbortFlag> <Priority xmlns="http://schemas.datacontract.org/2004/07/Stages">1</Priority> <PriorityDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 17</PriorityDescription> <RestoreWaitCount xmlns="http://schemas.datacontract.org/2004/07/Stages">1</RestoreWaitCount> <RestoreWaitPeriod xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 18</RestoreWaitPeriod> <ScheduleOption xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 19</ScheduleOption> <ScheduleOptionDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 20</ScheduleOptionDescription> <ServType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 22</ServType> <ServiceTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 21</ServiceTypeDescription> <SigForm xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 23</SigForm> <SignalCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 24</SignalCode> <SignalCodeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 25</SignalCodeDescription> <SignalFormatDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 26</SignalFormatDescription> <SignalStatus xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 27</SignalStatus> <SignalStatusDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 28</SignalStatusDescription> <SiteGroupNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</SiteGroupNum> <SiteType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 29</SiteType> <SiteTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 38</SiteTypeDescription> <SuppressionByPointFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SuppressionByPointFlag> <SuppressionDuringAlarmOnlyFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SuppressionDuringAlarmOnlyFlag> <SuppressionEndServType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 30</SuppressionEndServType> <SuppressionEndServTypeDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 31</SuppressionEndServTypeDescription> <SuppressionPeriod xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 32</SuppressionPeriod> </EventRuleListWithDetailResult> </ResultSet> </EventRuleListWithDetailQueryResult>