POST api/Zone/BulkZoneUpdate
Request Information
URI Parameters
None.
Body Parameters
ExGwyZoneUpdateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Zones | Collection of ExtGatewayZone |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Zones": [
{
"ActionPlanSearch": "sample string 1",
"AlarmConfirmation": "sample string 2",
"AlternateTransmitterCode": "sample string 3",
"AlarmFlag": true,
"AreaNum": 1,
"AutoProcess": "sample string 4",
"AutoRescheduleFlag": true,
"DelaySeconds": 1,
"DeviceStatus": "sample string 5",
"EqLoc": "sample string 6",
"EqType": "sample string 7",
"EventCode": "sample string 8",
"FailTTEventCode": "sample string 9",
"Point": "sample string 10",
"PointDescription": "sample string 11",
"Description": "sample string 12",
"Priority": 1,
"ReportsRestoreFlag": true,
"RestoreWaitCount": 1,
"RestoreWaitSeconds": 1,
"SchedNum": 1,
"SeparateAlarmFlag": true,
"ServType": "sample string 13",
"SignalCode": "sample string 14",
"SignalOption": "sample string 15",
"SignalStatus": "sample string 16",
"SiteGroupNum": 1,
"SiteGroupSchedNum": 1,
"TimerTestNum": 1,
"TimerTestDays": 1,
"TimerTestHours": 1,
"TimerTestMinutes": 1,
"UserID": "sample string 17",
"VerifyScheduleFlag": true,
"VerifyUserFlag": true,
"EntryExitSeconds": 1,
"SignalRuleNum": 1,
"DevNum": 1,
"SiteFlag": true,
"TransmitterCode": "sample string 18"
},
{
"ActionPlanSearch": "sample string 1",
"AlarmConfirmation": "sample string 2",
"AlternateTransmitterCode": "sample string 3",
"AlarmFlag": true,
"AreaNum": 1,
"AutoProcess": "sample string 4",
"AutoRescheduleFlag": true,
"DelaySeconds": 1,
"DeviceStatus": "sample string 5",
"EqLoc": "sample string 6",
"EqType": "sample string 7",
"EventCode": "sample string 8",
"FailTTEventCode": "sample string 9",
"Point": "sample string 10",
"PointDescription": "sample string 11",
"Description": "sample string 12",
"Priority": 1,
"ReportsRestoreFlag": true,
"RestoreWaitCount": 1,
"RestoreWaitSeconds": 1,
"SchedNum": 1,
"SeparateAlarmFlag": true,
"ServType": "sample string 13",
"SignalCode": "sample string 14",
"SignalOption": "sample string 15",
"SignalStatus": "sample string 16",
"SiteGroupNum": 1,
"SiteGroupSchedNum": 1,
"TimerTestNum": 1,
"TimerTestDays": 1,
"TimerTestHours": 1,
"TimerTestMinutes": 1,
"UserID": "sample string 17",
"VerifyScheduleFlag": true,
"VerifyUserFlag": true,
"EntryExitSeconds": 1,
"SignalRuleNum": 1,
"DevNum": 1,
"SiteFlag": true,
"TransmitterCode": "sample string 18"
}
],
"SessionNum": 1,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 2",
"StagesURL": "sample string 3"
}
application/xml, text/xml
Sample:
<ExGwyZoneUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Requests">
<StagesURL xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">sample string 3</StagesURL>
<ApplicationCode xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">sample string 2</ApplicationCode>
<SessionNum xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">1</SessionNum>
<SessionPassword xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">QEA=</SessionPassword>
<Zones xmlns:d2p1="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
<d2p1:ExtGatewayZone>
<d2p1:ActionPlanSearch>sample string 1</d2p1:ActionPlanSearch>
<d2p1:AlarmConfirmation>sample string 2</d2p1:AlarmConfirmation>
<d2p1:AlarmFlag>true</d2p1:AlarmFlag>
<d2p1:AlternateTransmitterCode>sample string 3</d2p1:AlternateTransmitterCode>
<d2p1:AreaNum>1</d2p1:AreaNum>
<d2p1:AutoProcess>sample string 4</d2p1:AutoProcess>
<d2p1:AutoRescheduleFlag>true</d2p1:AutoRescheduleFlag>
<d2p1:DelaySeconds>1</d2p1:DelaySeconds>
<d2p1:Description>sample string 12</d2p1:Description>
<d2p1:DevNum>1</d2p1:DevNum>
<d2p1:DeviceStatus>sample string 5</d2p1:DeviceStatus>
<d2p1:EntryExitSeconds>1</d2p1:EntryExitSeconds>
<d2p1:EqLoc>sample string 6</d2p1:EqLoc>
<d2p1:EqType>sample string 7</d2p1:EqType>
<d2p1:EventCode>sample string 8</d2p1:EventCode>
<d2p1:FailTTEventCode>sample string 9</d2p1:FailTTEventCode>
<d2p1:Point>sample string 10</d2p1:Point>
<d2p1:PointDescription>sample string 11</d2p1:PointDescription>
<d2p1:Priority>1</d2p1:Priority>
<d2p1:ReportsRestoreFlag>true</d2p1:ReportsRestoreFlag>
<d2p1:RestoreWaitCount>1</d2p1:RestoreWaitCount>
<d2p1:RestoreWaitSeconds>1</d2p1:RestoreWaitSeconds>
<d2p1:SchedNum>1</d2p1:SchedNum>
<d2p1:SeparateAlarmFlag>true</d2p1:SeparateAlarmFlag>
<d2p1:ServType>sample string 13</d2p1:ServType>
<d2p1:SignalCode>sample string 14</d2p1:SignalCode>
<d2p1:SignalOption>sample string 15</d2p1:SignalOption>
<d2p1:SignalRuleNum>1</d2p1:SignalRuleNum>
<d2p1:SignalStatus>sample string 16</d2p1:SignalStatus>
<d2p1:SiteFlag>true</d2p1:SiteFlag>
<d2p1:SiteGroupNum>1</d2p1:SiteGroupNum>
<d2p1:SiteGroupSchedNum>1</d2p1:SiteGroupSchedNum>
<d2p1:TimerTestDays>1</d2p1:TimerTestDays>
<d2p1:TimerTestHours>1</d2p1:TimerTestHours>
<d2p1:TimerTestMinutes>1</d2p1:TimerTestMinutes>
<d2p1:TimerTestNum>1</d2p1:TimerTestNum>
<d2p1:TransmitterCode>sample string 18</d2p1:TransmitterCode>
<d2p1:UserID>sample string 17</d2p1:UserID>
<d2p1:VerifyScheduleFlag>true</d2p1:VerifyScheduleFlag>
<d2p1:VerifyUserFlag>true</d2p1:VerifyUserFlag>
</d2p1:ExtGatewayZone>
<d2p1:ExtGatewayZone>
<d2p1:ActionPlanSearch>sample string 1</d2p1:ActionPlanSearch>
<d2p1:AlarmConfirmation>sample string 2</d2p1:AlarmConfirmation>
<d2p1:AlarmFlag>true</d2p1:AlarmFlag>
<d2p1:AlternateTransmitterCode>sample string 3</d2p1:AlternateTransmitterCode>
<d2p1:AreaNum>1</d2p1:AreaNum>
<d2p1:AutoProcess>sample string 4</d2p1:AutoProcess>
<d2p1:AutoRescheduleFlag>true</d2p1:AutoRescheduleFlag>
<d2p1:DelaySeconds>1</d2p1:DelaySeconds>
<d2p1:Description>sample string 12</d2p1:Description>
<d2p1:DevNum>1</d2p1:DevNum>
<d2p1:DeviceStatus>sample string 5</d2p1:DeviceStatus>
<d2p1:EntryExitSeconds>1</d2p1:EntryExitSeconds>
<d2p1:EqLoc>sample string 6</d2p1:EqLoc>
<d2p1:EqType>sample string 7</d2p1:EqType>
<d2p1:EventCode>sample string 8</d2p1:EventCode>
<d2p1:FailTTEventCode>sample string 9</d2p1:FailTTEventCode>
<d2p1:Point>sample string 10</d2p1:Point>
<d2p1:PointDescription>sample string 11</d2p1:PointDescription>
<d2p1:Priority>1</d2p1:Priority>
<d2p1:ReportsRestoreFlag>true</d2p1:ReportsRestoreFlag>
<d2p1:RestoreWaitCount>1</d2p1:RestoreWaitCount>
<d2p1:RestoreWaitSeconds>1</d2p1:RestoreWaitSeconds>
<d2p1:SchedNum>1</d2p1:SchedNum>
<d2p1:SeparateAlarmFlag>true</d2p1:SeparateAlarmFlag>
<d2p1:ServType>sample string 13</d2p1:ServType>
<d2p1:SignalCode>sample string 14</d2p1:SignalCode>
<d2p1:SignalOption>sample string 15</d2p1:SignalOption>
<d2p1:SignalRuleNum>1</d2p1:SignalRuleNum>
<d2p1:SignalStatus>sample string 16</d2p1:SignalStatus>
<d2p1:SiteFlag>true</d2p1:SiteFlag>
<d2p1:SiteGroupNum>1</d2p1:SiteGroupNum>
<d2p1:SiteGroupSchedNum>1</d2p1:SiteGroupSchedNum>
<d2p1:TimerTestDays>1</d2p1:TimerTestDays>
<d2p1:TimerTestHours>1</d2p1:TimerTestHours>
<d2p1:TimerTestMinutes>1</d2p1:TimerTestMinutes>
<d2p1:TimerTestNum>1</d2p1:TimerTestNum>
<d2p1:TransmitterCode>sample string 18</d2p1:TransmitterCode>
<d2p1:UserID>sample string 17</d2p1:UserID>
<d2p1:VerifyScheduleFlag>true</d2p1:VerifyScheduleFlag>
<d2p1:VerifyUserFlag>true</d2p1:VerifyUserFlag>
</d2p1:ExtGatewayZone>
</Zones>
</ExGwyZoneUpdateRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BaseQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| 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"
}
application/xml, text/xml
Sample:
<BaseQueryResult 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> </BaseQueryResult>