POST api/Zone/TempDeviceConfigList
Request Information
URI Parameters
None.
Body Parameters
TempDeviceConfigListRequestName | Description | Type | Additional information |
---|---|---|---|
IncludeExpired | boolean |
None. |
|
TempSignalRuleNum | integer |
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:
{ "IncludeExpired": true, "TempSignalRuleNum": 1, "DevNum": 1, "SiteFlag": true, "SessionNum": 1, "SessionPassword": "QEA=", "ApplicationCode": "sample string 2", "StagesURL": "sample string 3" }
application/xml, text/xml
Sample:
<TempDeviceConfigListRequest 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> <DevNum>1</DevNum> <SiteFlag>true</SiteFlag> <TempSignalRuleNum>1</TempSignalRuleNum> <IncludeExpired>true</IncludeExpired> </TempDeviceConfigListRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
TempDeviceConfigListQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of TempDeviceConfigListResult |
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": [ { "ActionPlanSearch": "sample string 1", "ActionPlanType": "sample string 2", "ActionPlanVersionNum": 1, "ActPlanDescription": "sample string 3", "ActPlanMatchBy": "sample string 4", "AlarmConfirmation": "sample string 5", "AlarmConfirmationDescription": "sample string 6", "AlarmFlag": true, "AlternateTransmitterCode": "sample string 7", "AltSiteName": "sample string 8", "AreaDescription": "sample string 9", "AreaNum": 1, "AutoProcess": "sample string 10", "AutoProcessDescription": "sample string 11", "Category": "sample string 12", "DelaySeconds": 1, "DeviceStatus": "sample string 13", "DeviceStatusDescription": "sample string 14", "DeviceType": "sample string 15", "DevNum": 1, "DisplayExpiredFlag": true, "DisplayTempSignalRuleNum": 1, "EffectiveActionPlanDescription": "sample string 16", "EffectiveActionPlanNum": 1, "EffectiveDate": "2025-05-03T22:19:54.7352258-07:00", "EffectiveDateTime": "2025-05-03T22:19:54.7352258-07:00", "EffectiveTime": "sample string 17", "EqLoc": "sample string 18", "EqLocDescription": "sample string 19", "EqType": "sample string 20", "EqTypeDescription": "sample string 21", "EventCode": "sample string 22", "EventCodeDescription": "sample string 23", "EventCodeWithDescr": "sample string 24", "ExpireDate": "2025-05-03T22:19:54.7352258-07:00", "ExpireDateTime": "2025-05-03T22:19:54.7352258-07:00", "ExpiredFlag": true, "ExpireTime": "sample string 25", "HighlightFlag": true, "Point": "sample string 26", "PointDescription": "sample string 27", "PointFlag": true, "Priority": 1, "PriorityDescription": "sample string 28", "ReportsRestoreFlag": true, "RestoreWaitCount": 1, "RestoreWaitPeriod": "sample string 29", "SchedNum": 1, "SeparateAlarmFlag": true, "ServiceTypeDescription": "sample string 30", "ServType": "sample string 31", "SignalCode": "sample string 32", "SignalOption": "sample string 33", "SignalOptionDescription": "sample string 34", "SignalStatus": "sample string 35", "SignalStatusDescription": "sample string 36", "SiteGroupName": "sample string 37", "SiteGroupNum": 1, "SiteGroupSchedDescription": "sample string 38", "SiteGroupSchedNum": 1, "TempSignalRuleNum": 1, "TitleSiteName": "sample string 39", "TransmitterCode": "sample string 40", "UserID": "sample string 41", "VerifyScheduleFlag": true, "VerifyUserFlag": true }, { "ActionPlanSearch": "sample string 1", "ActionPlanType": "sample string 2", "ActionPlanVersionNum": 1, "ActPlanDescription": "sample string 3", "ActPlanMatchBy": "sample string 4", "AlarmConfirmation": "sample string 5", "AlarmConfirmationDescription": "sample string 6", "AlarmFlag": true, "AlternateTransmitterCode": "sample string 7", "AltSiteName": "sample string 8", "AreaDescription": "sample string 9", "AreaNum": 1, "AutoProcess": "sample string 10", "AutoProcessDescription": "sample string 11", "Category": "sample string 12", "DelaySeconds": 1, "DeviceStatus": "sample string 13", "DeviceStatusDescription": "sample string 14", "DeviceType": "sample string 15", "DevNum": 1, "DisplayExpiredFlag": true, "DisplayTempSignalRuleNum": 1, "EffectiveActionPlanDescription": "sample string 16", "EffectiveActionPlanNum": 1, "EffectiveDate": "2025-05-03T22:19:54.7352258-07:00", "EffectiveDateTime": "2025-05-03T22:19:54.7352258-07:00", "EffectiveTime": "sample string 17", "EqLoc": "sample string 18", "EqLocDescription": "sample string 19", "EqType": "sample string 20", "EqTypeDescription": "sample string 21", "EventCode": "sample string 22", "EventCodeDescription": "sample string 23", "EventCodeWithDescr": "sample string 24", "ExpireDate": "2025-05-03T22:19:54.7352258-07:00", "ExpireDateTime": "2025-05-03T22:19:54.7352258-07:00", "ExpiredFlag": true, "ExpireTime": "sample string 25", "HighlightFlag": true, "Point": "sample string 26", "PointDescription": "sample string 27", "PointFlag": true, "Priority": 1, "PriorityDescription": "sample string 28", "ReportsRestoreFlag": true, "RestoreWaitCount": 1, "RestoreWaitPeriod": "sample string 29", "SchedNum": 1, "SeparateAlarmFlag": true, "ServiceTypeDescription": "sample string 30", "ServType": "sample string 31", "SignalCode": "sample string 32", "SignalOption": "sample string 33", "SignalOptionDescription": "sample string 34", "SignalStatus": "sample string 35", "SignalStatusDescription": "sample string 36", "SiteGroupName": "sample string 37", "SiteGroupNum": 1, "SiteGroupSchedDescription": "sample string 38", "SiteGroupSchedNum": 1, "TempSignalRuleNum": 1, "TitleSiteName": "sample string 39", "TransmitterCode": "sample string 40", "UserID": "sample string 41", "VerifyScheduleFlag": true, "VerifyUserFlag": true } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<TempDeviceConfigListQueryResult 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> <TempDeviceConfigListResult> <ActPlanDescription>sample string 3</ActPlanDescription> <ActPlanMatchBy>sample string 4</ActPlanMatchBy> <ActionPlanSearch>sample string 1</ActionPlanSearch> <ActionPlanType>sample string 2</ActionPlanType> <ActionPlanVersionNum>1</ActionPlanVersionNum> <AlarmConfirmation>sample string 5</AlarmConfirmation> <AlarmConfirmationDescription>sample string 6</AlarmConfirmationDescription> <AlarmFlag>true</AlarmFlag> <AltSiteName>sample string 8</AltSiteName> <AlternateTransmitterCode>sample string 7</AlternateTransmitterCode> <AreaDescription>sample string 9</AreaDescription> <AreaNum>1</AreaNum> <AutoProcess>sample string 10</AutoProcess> <AutoProcessDescription>sample string 11</AutoProcessDescription> <Category>sample string 12</Category> <DelaySeconds>1</DelaySeconds> <DevNum>1</DevNum> <DeviceStatus>sample string 13</DeviceStatus> <DeviceStatusDescription>sample string 14</DeviceStatusDescription> <DeviceType>sample string 15</DeviceType> <DisplayExpiredFlag>true</DisplayExpiredFlag> <DisplayTempSignalRuleNum>1</DisplayTempSignalRuleNum> <EffectiveActionPlanDescription>sample string 16</EffectiveActionPlanDescription> <EffectiveActionPlanNum>1</EffectiveActionPlanNum> <EffectiveDate>2025-05-03T22:19:54.7352258-07:00</EffectiveDate> <EffectiveDateTime>2025-05-03T22:19:54.7352258-07:00</EffectiveDateTime> <EffectiveTime>sample string 17</EffectiveTime> <EqLoc>sample string 18</EqLoc> <EqLocDescription>sample string 19</EqLocDescription> <EqType>sample string 20</EqType> <EqTypeDescription>sample string 21</EqTypeDescription> <EventCode>sample string 22</EventCode> <EventCodeDescription>sample string 23</EventCodeDescription> <EventCodeWithDescr>sample string 24</EventCodeWithDescr> <ExpireDate>2025-05-03T22:19:54.7352258-07:00</ExpireDate> <ExpireDateTime>2025-05-03T22:19:54.7352258-07:00</ExpireDateTime> <ExpireTime>sample string 25</ExpireTime> <ExpiredFlag>true</ExpiredFlag> <HighlightFlag>true</HighlightFlag> <Point>sample string 26</Point> <PointDescription>sample string 27</PointDescription> <PointFlag>true</PointFlag> <Priority>1</Priority> <PriorityDescription>sample string 28</PriorityDescription> <ReportsRestoreFlag>true</ReportsRestoreFlag> <RestoreWaitCount>1</RestoreWaitCount> <RestoreWaitPeriod>sample string 29</RestoreWaitPeriod> <SchedNum>1</SchedNum> <SeparateAlarmFlag>true</SeparateAlarmFlag> <ServType>sample string 31</ServType> <ServiceTypeDescription>sample string 30</ServiceTypeDescription> <SignalCode>sample string 32</SignalCode> <SignalOption>sample string 33</SignalOption> <SignalOptionDescription>sample string 34</SignalOptionDescription> <SignalStatus>sample string 35</SignalStatus> <SignalStatusDescription>sample string 36</SignalStatusDescription> <SiteGroupName>sample string 37</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSchedDescription>sample string 38</SiteGroupSchedDescription> <SiteGroupSchedNum>1</SiteGroupSchedNum> <TempSignalRuleNum>1</TempSignalRuleNum> <TitleSiteName>sample string 39</TitleSiteName> <TransmitterCode>sample string 40</TransmitterCode> <UserID>sample string 41</UserID> <VerifyScheduleFlag>true</VerifyScheduleFlag> <VerifyUserFlag>true</VerifyUserFlag> </TempDeviceConfigListResult> <TempDeviceConfigListResult> <ActPlanDescription>sample string 3</ActPlanDescription> <ActPlanMatchBy>sample string 4</ActPlanMatchBy> <ActionPlanSearch>sample string 1</ActionPlanSearch> <ActionPlanType>sample string 2</ActionPlanType> <ActionPlanVersionNum>1</ActionPlanVersionNum> <AlarmConfirmation>sample string 5</AlarmConfirmation> <AlarmConfirmationDescription>sample string 6</AlarmConfirmationDescription> <AlarmFlag>true</AlarmFlag> <AltSiteName>sample string 8</AltSiteName> <AlternateTransmitterCode>sample string 7</AlternateTransmitterCode> <AreaDescription>sample string 9</AreaDescription> <AreaNum>1</AreaNum> <AutoProcess>sample string 10</AutoProcess> <AutoProcessDescription>sample string 11</AutoProcessDescription> <Category>sample string 12</Category> <DelaySeconds>1</DelaySeconds> <DevNum>1</DevNum> <DeviceStatus>sample string 13</DeviceStatus> <DeviceStatusDescription>sample string 14</DeviceStatusDescription> <DeviceType>sample string 15</DeviceType> <DisplayExpiredFlag>true</DisplayExpiredFlag> <DisplayTempSignalRuleNum>1</DisplayTempSignalRuleNum> <EffectiveActionPlanDescription>sample string 16</EffectiveActionPlanDescription> <EffectiveActionPlanNum>1</EffectiveActionPlanNum> <EffectiveDate>2025-05-03T22:19:54.7352258-07:00</EffectiveDate> <EffectiveDateTime>2025-05-03T22:19:54.7352258-07:00</EffectiveDateTime> <EffectiveTime>sample string 17</EffectiveTime> <EqLoc>sample string 18</EqLoc> <EqLocDescription>sample string 19</EqLocDescription> <EqType>sample string 20</EqType> <EqTypeDescription>sample string 21</EqTypeDescription> <EventCode>sample string 22</EventCode> <EventCodeDescription>sample string 23</EventCodeDescription> <EventCodeWithDescr>sample string 24</EventCodeWithDescr> <ExpireDate>2025-05-03T22:19:54.7352258-07:00</ExpireDate> <ExpireDateTime>2025-05-03T22:19:54.7352258-07:00</ExpireDateTime> <ExpireTime>sample string 25</ExpireTime> <ExpiredFlag>true</ExpiredFlag> <HighlightFlag>true</HighlightFlag> <Point>sample string 26</Point> <PointDescription>sample string 27</PointDescription> <PointFlag>true</PointFlag> <Priority>1</Priority> <PriorityDescription>sample string 28</PriorityDescription> <ReportsRestoreFlag>true</ReportsRestoreFlag> <RestoreWaitCount>1</RestoreWaitCount> <RestoreWaitPeriod>sample string 29</RestoreWaitPeriod> <SchedNum>1</SchedNum> <SeparateAlarmFlag>true</SeparateAlarmFlag> <ServType>sample string 31</ServType> <ServiceTypeDescription>sample string 30</ServiceTypeDescription> <SignalCode>sample string 32</SignalCode> <SignalOption>sample string 33</SignalOption> <SignalOptionDescription>sample string 34</SignalOptionDescription> <SignalStatus>sample string 35</SignalStatus> <SignalStatusDescription>sample string 36</SignalStatusDescription> <SiteGroupName>sample string 37</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSchedDescription>sample string 38</SiteGroupSchedDescription> <SiteGroupSchedNum>1</SiteGroupSchedNum> <TempSignalRuleNum>1</TempSignalRuleNum> <TitleSiteName>sample string 39</TitleSiteName> <TransmitterCode>sample string 40</TransmitterCode> <UserID>sample string 41</UserID> <VerifyScheduleFlag>true</VerifyScheduleFlag> <VerifyUserFlag>true</VerifyUserFlag> </TempDeviceConfigListResult> </ResultSet> </TempDeviceConfigListQueryResult>