Areas
Table Name: GXT_AREAS_TBL
List
Request a list of areas.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_AREAS_TBL -
Response:
Copy0=System Area&16=Area 1&17=Area 2
Detail
Request the details of a specific area.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_AREAS_TBL&RecId=<RecId> -
Response:
CopyAreaId=16&Name=Area 1&EntryTimeSeconds=30&AlternateEntryTime=60&ExitTimeSeconds=45&Alarm1TimeMinutes=4&SmartZoneTimer=20&SmartZoneCount=0&ChildArea=2147483647&RearmAreaTimeMinutes=15&MaximumBypassZoneCount=0&MaxUserCount=0&BellPGMOutput=112&BellPulseOnTime=0&BellPulseOffTime=0&ExitDelayPGMOutput=2147483647&ExitDelayPulseOnTime=0&ExitDelayPulseOffTime=0&EntryDelayPGMOutput=2147483647&EntryDelayPulseOnTime=0&EntryDelayPulseOffTime=0&DisarmedPGMOutput=2147483647&DisarmedPulseOnTime=0&DisarmedPulseOffTime=0&ArmedPGMOutput=2147483647&ArmedPulseOnTime=0&ArmedPulseOffTime=0&ReadyPGMOutput=2147483647&ReadyPGMOutputGroup=2147483647&BypassedZonesPGMOutput=2147483647&BypassedZonesPulseOnTime=0&BypassedZonesPulseOffTime=0&TamperAlarmPGMOutput=2147483647&TamperAlarmPulseOnTime=0&TamperAlarmPulseOffTime=0&AlarmMemoryPGMOutput=2147483647&AlarmMemoryPulseOnTime=0&AlarmMemoryPulseOffTime=0&UserCountReachedPGMOutput=2147483647&UserCountReachedPulseOnTime=0&UserCountReachedPulseOffTime=0&ClientCode=65535&ReportingId=2&ZoneRestoreOnBellCutOff=false&ReArmEnabled=false&ArmChildArea=false&ArmChildIfAllOtherAreasAreArmed=false&DisarmChildArea=false&DisarmChildIfAllOtherAreasAreaDisarmed=false&UseUnattendedBruteForceArming=false&AreaEnabledInLoiterMode=false&ReportArming=true&ReportDisarming=true&Report24HRAreaDisarming=true&ReportUserBypass=true&EnableUserCounting=false&ArmOnUserCountAt0=false&ReportEntryAlarmImmediately=false&ClearUserCountWhenArmed=true&EnableStayArming=true&EnableForceArming=true&EnableInstantArming=true&DoNotArmIfTroubleCondition=false&VaultControlArea=false&DualCodeVaultControl=false&PreventArmingOnCountNotZero=false&AlwaysVerifyAreaSchedule=false&UserRearmInStayMode=false&DisarmAreaWhenScheduleStarts=false&ArmAreaWhenScheduleStarts=false&EnableSmartInput=false&AreaCanBeReset=false&RecentClosingTime=0&LoiterTimerInMinutesDefault=0&LoiterResetArea=2147483647&InterlockAreaGroup=2147483647&VaultDisarmDelaySeconds=0&VaultDualCodeDelaySeconds=0&ArmDisarmSchedule=2147483647&DeferAutomaticArming=false&AlwaysForceArmUsingCardReader=false&DisableExitPGMonStayArming=false&ClearAlarmMemoryafterArming=false&EnableLateArmReport=false&EnableEarlyDisarmReport=false&DisableReArmOnSchedule=false&AreaDeferArmingStartedPGMOutput=2147483647&DeferArmingStartedPulseOnTime=0&DeferArmingStartedPulseOffTime=0&DeferWarningKeypadGroup=2147483647&DeferWarningTimeMinutes=60&FailToArmPGM=2147483647&BellSquawkOnArmingStart=false&BellSquawkOnArmingComplete=false&BellSquawkOnlyWhenUnattended=false&BellSquawkOnDisarm=false&BellSquawkOnSuccessfulReport=false&NormalDisarmSchedule=2147483647&NormalArmSchedule=2147483647&LockDoorGroupOnArming=2147483647&BellPGMOutputGroup=2147483647&ExitDelayPGMOutputGroup=2147483647&EntryDelayPGMOutputGroup=2147483647&DisarmedPGMOutputGroup=2147483647&ArmedPGMOutputGroup=2147483647&BypassedZonesPGMOutputGroup=2147483647&TamperAlarmPGMOutputGroup=2147483647&AlarmMemoryPGMOutputGroup=2147483647&UserCountReachedPGMOutputGroup=2147483647&AreaDeferArmingStartedPGMOutputGroup=2147483647&FailToArmPGMGroup=2147483647&Commands=&ServiceId0=1
Update
Update a specific area.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_AREAS_TBL&AreaId=17&Name=Reception -
Response:
CopyOK
Create
Create an area. To create an area, use the same parameters as update but leave the AreaId empty.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_AREAS_TBL&AreaId=&Name=Area 1&EntryTimeSeconds=30&AlternateEntryTime=60&ExitTimeSeconds=45&Alarm1TimeMinutes=4&SmartZoneTimer=20&SmartZoneCount=0&ChildArea=2147483647&RearmAreaTimeMinutes=15&MaximumBypassZoneCount=0&MaxUserCount=0&BellPGMOutput=112&BellPulseOnTime=0&BellPulseOffTime=0&ExitDelayPGMOutput=2147483647&ExitDelayPulseOnTime=0&ExitDelayPulseOffTime=0&EntryDelayPGMOutput=2147483647&EntryDelayPulseOnTime=0&EntryDelayPulseOffTime=0&DisarmedPGMOutput=2147483647&DisarmedPulseOnTime=0&DisarmedPulseOffTime=0&ArmedPGMOutput=2147483647&ArmedPulseOnTime=0&ArmedPulseOffTime=0&ReadyPGMOutput=2147483647&ReadyPGMOutputGroup=2147483647&BypassedZonesPGMOutput=2147483647&BypassedZonesPulseOnTime=0&BypassedZonesPulseOffTime=0&TamperAlarmPGMOutput=2147483647&TamperAlarmPulseOnTime=0&TamperAlarmPulseOffTime=0&AlarmMemoryPGMOutput=2147483647&AlarmMemoryPulseOnTime=0&AlarmMemoryPulseOffTime=0&UserCountReachedPGMOutput=2147483647&UserCountReachedPulseOnTime=0&UserCountReachedPulseOffTime=0&ClientCode=65535&ReportingId=2&ZoneRestoreOnBellCutOff=false&ReArmEnabled=false&ArmChildArea=false&ArmChildIfAllOtherAreasAreArmed=false&DisarmChildArea=false&DisarmChildIfAllOtherAreasAreaDisarmed=false&UseUnattendedBruteForceArming=false&AreaEnabledInLoiterMode=false&ReportArming=true&ReportDisarming=true&Report24HRAreaDisarming=true&ReportUserBypass=true&EnableUserCounting=false&ArmOnUserCountAt0=false&ReportEntryAlarmImmediately=false&ClearUserCountWhenArmed=true&EnableStayArming=true&EnableForceArming=true&EnableInstantArming=true&DoNotArmIfTroubleCondition=false&VaultControlArea=false&DualCodeVaultControl=false&PreventArmingOnCountNotZero=false&AlwaysVerifyAreaSchedule=false&UserRearmInStayMode=false&DisarmAreaWhenScheduleStarts=false&ArmAreaWhenScheduleStarts=false&EnableSmartInput=false&AreaCanBeReset=false&RecentClosingTime=0&LoiterTimerInMinutesDefault=0&LoiterResetArea=2147483647&InterlockAreaGroup=2147483647&VaultDisarmDelaySeconds=0&VaultDualCodeDelaySeconds=0&ArmDisarmSchedule=2147483647&DeferAutomaticArming=false&AlwaysForceArmUsingCardReader=false&DisableExitPGMonStayArming=false&ClearAlarmMemoryafterArming=false&EnableLateArmReport=false&EnableEarlyDisarmReport=false&DisableReArmOnSchedule=false&AreaDeferArmingStartedPGMOutput=2147483647&DeferArmingStartedPulseOnTime=0&DeferArmingStartedPulseOffTime=0&DeferWarningKeypadGroup=2147483647&DeferWarningTimeMinutes=60&FailToArmPGM=2147483647&BellSquawkOnArmingStart=false&BellSquawkOnArmingComplete=false&BellSquawkOnlyWhenUnattended=false&BellSquawkOnDisarm=false&BellSquawkOnSuccessfulReport=false&NormalDisarmSchedule=2147483647&NormalArmSchedule=2147483647&LockAreaGroupOnArming=2147483647&BellPGMOutputGroup=2147483647&ExitDelayPGMOutputGroup=2147483647&EntryDelayPGMOutputGroup=2147483647&DisarmedPGMOutputGroup=2147483647&ArmedPGMOutputGroup=2147483647&BypassedZonesPGMOutputGroup=2147483647&TamperAlarmPGMOutputGroup=2147483647&AlarmMemoryPGMOutputGroup=2147483647&UserCountReachedPGMOutputGroup=2147483647&AreaDeferArmingStartedPGMOutputGroup=2147483647&FailToArmPGMGroup=2147483647&Commands=&ServiceId0=1 -
Response:
CopyOK
When using the API to directly add records, please ensure the number of records added does not exceed the license limit for this record type, as this will result in undefined behavior. The license limit can be determined using the LicenseLimit request (see System).
Delete
Delete a specific area.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Delete&SubType=GXT_AREAS_TBL&RecId=<RecId> -
Response:
CopyOK
Parameters
|
Parameter |
Display Name |
Default Value |
Notes |
|---|---|---|---|
|
AreaId |
Database ID |
16 |
The Detail, Control and Delete APIs use this value as the RecId. |
|
Name |
Name |
Area 1 |
|
|
EntryTimeSeconds |
Entry Time (seconds) |
30 |
|
|
AlternateEntryTime |
Alternate Entry Time (seconds) |
60 |
|
|
ExitTimeSeconds |
Exit Time (seconds) |
45 |
|
|
Alarm1TimeMinutes |
Alarm Time (minutes) |
4 |
|
|
SmartZoneTimer |
Smart Input Timer |
20 |
|
|
SmartZoneCount |
Smart Input Count |
0 |
|
|
ChildArea |
Child Area |
2147483647 |
|
|
RearmAreaTimeMinutes |
Rearm Area Time (minutes) |
15 |
|
|
MaximumBypassZoneCount |
Maximum Bypass Input Count |
0 |
|
|
MaxUserCount |
Max User Count |
0 |
|
|
BellPGMOutput |
Bell Output |
112 |
|
|
BellPulseOnTime |
Bell Pulse On Time |
0 |
|
|
BellPulseOffTime |
Bell Pulse Off Time |
0 |
|
|
ExitDelayPGMOutput |
Exit Delay Output |
2147483647 |
|
|
ExitDelayPulseOnTime |
Exit Delay Pulse On Time |
0 |
|
|
ExitDelayPulseOffTime |
Exit Delay Pulse Off Time |
0 |
|
|
EntryDelayPGMOutput |
Entry Delay Output |
2147483647 |
|
|
EntryDelayPulseOnTime |
Entry Delay Pulse On Time |
0 |
|
|
EntryDelayPulseOffTime |
Entry Delay Pulse Off Time |
0 |
|
|
DisarmedPGMOutput |
Disarmed Output |
2147483647 |
|
|
DisarmedPulseOnTime |
Disarmed Pulse On Time |
0 |
|
|
DisarmedPulseOffTime |
Disarmed Pulse Off Time |
0 |
|
|
ArmedPGMOutput |
Armed Output |
2147483647 |
|
|
ArmedPulseOnTime |
Armed Pulse On Time |
0 |
|
|
ArmedPulseOffTime |
Armed Pulse Off Time |
0 |
|
|
ReadyPGMOutput |
Ready Output |
2147483647 |
|
|
ReadyPGMOutputGroup |
Ready |
2147483647 |
|
|
BypassedZonesPGMOutput |
Bypassed Inputs Output |
2147483647 |
|
|
BypassedZonesPulseOnTime |
Bypassed Inputs Pulse On Time |
0 |
|
|
BypassedZonesPulseOffTime |
Bypassed Inputs Pulse Off Time |
0 |
|
|
TamperAlarmPGMOutput |
Tamper Alarm Output |
2147483647 |
|
|
TamperAlarmPulseOnTime |
Tamper Alarm Pulse On Time |
0 |
|
|
TamperAlarmPulseOffTime |
Tamper Alarm Pulse Off Time |
0 |
|
|
AlarmMemoryPGMOutput |
Alarm Memory Output |
2147483647 |
|
|
AlarmMemoryPulseOnTime |
Alarm Memory Pulse On Time |
0 |
|
|
AlarmMemoryPulseOffTime |
Alarm Memory Pulse Off Time |
0 |
|
|
UserCountReachedPGMOutput |
User Count Reached Output |
2147483647 |
|
|
UserCountReachedPulseOnTime |
User Count Reached Pulse On Time |
0 |
|
|
UserCountReachedPulseOffTime |
User Count Reached Pulse Off Time |
0 |
|
|
ClientCode |
Client Code |
65535 |
|
|
ReportingId |
Reporting ID |
2 |
|
|
ZoneRestoreOnBellCutOff |
Input Restore on Bell Cut-Off |
false |
|
|
ReArmEnabled |
Re-Arm Enabled |
false |
|
|
ArmChildArea |
Arm Child Area |
false |
|
|
ArmChildIfAllOtherAreasAreArmed |
Arm Child If All Other Areas Are Armed |
false |
|
|
DisarmChildArea |
Disarm Child Area |
false |
|
|
DisarmChildIfAllOtherAreasAreaDisarmed |
Disarm Child If All Other Areas Are Disarmed |
false |
|
|
UseUnattendedBruteForceArming |
Use Unattended Brute Force Arming |
false |
|
|
AreaEnabledInLoiterMode |
|
false |
Enables loiter processing for the area. See the Protege GX Operator Reference Manual. |
|
ReportArming |
Report Arming |
true |
|
|
ReportDisarming |
Report Disarming |
true |
|
|
Report24HRAreaDisarming |
Report 24hr Area Disarming |
true |
|
|
ReportUserBypass |
Report User Bypass |
true |
|
|
EnableUserCounting |
Enable User Counting |
false |
|
|
ArmOnUserCountAt0 |
Arm On User Count At 0 |
false |
|
|
ReportEntryAlarmImmediately |
Report Entry Alarm Immediately |
false |
|
|
ClearUserCountWhenArmed |
Clear User Count When Armed |
true |
|
|
EnableStayArming |
Enable Stay Arming |
true |
|
|
EnableForceArming |
Enable Force Arming |
true |
|
|
EnableInstantArming |
Enable Instant Arming |
true |
|
|
DoNotArmIfTroubleCondition |
Do Not Arm If Trouble Condition |
false |
|
|
VaultControlArea |
Vault Control Area |
false |
|
|
DualCodeVaultControl |
Dual Code Vault Control |
false |
|
|
PreventArmingOnCountNotZero |
Prevent Arming On Count Not Zero |
false |
|
|
AlwaysVerifyAreaSchedule |
Always Verify Area Schedule |
false |
|
|
UserRearmInStayMode |
User Rearm In Stay Mode |
false |
|
|
DisarmAreaWhenScheduleStarts |
Disarm Area When Schedule Starts |
false |
|
|
ArmAreaWhenScheduleStarts |
Arm Area When Schedule Ends |
false |
|
|
EnableSmartInput |
Enable Smart Input |
false |
|
|
AreaCanBeReset |
Area Can Be Reset |
false |
|
|
RecentClosingTime |
Recent Closing Time (seconds) |
0 |
|
|
LoiterTimerInMinutesDefault |
Loiter Time (minutes) |
0 |
|
|
LoiterResetArea |
Loiter Reset Area |
2147483647 |
|
|
InterlockAreaGroup |
Interlock Area Group |
2147483647 |
|
|
VaultDisarmDelaySeconds |
Vault Disarm Delay (minutes) |
0 |
|
|
VaultDualCodeDelaySeconds |
Vault Dual Code Delay (seconds) |
0 |
|
|
ArmDisarmSchedule |
Arm / Disarm Schedule |
2147483647 |
Default value is Always. |
|
DeferAutomaticArming |
Defer Automatic Arming |
false |
|
|
AlwaysForceArmUsingCardReader |
Always Force Arm Using Card Reader |
false |
|
|
DisableExitPGMonStayArming |
Disable Exit Output On Stay Arming |
false |
|
|
ClearAlarmMemoryafterArming |
Clear Alarm Memory After Arming |
false |
|
|
EnableLateArmReport |
Enable Late Arm Report |
false |
|
|
EnableEarlyDisarmReport |
Enable Early Disarm Report |
false |
|
|
DisableReArmOnSchedule |
Disable Re-Arm On Schedule |
false |
|
|
AreaDeferArmingStartedPGMOutput |
Area Defer Arming Started Output |
2147483647 |
|
|
DeferArmingStartedPulseOnTime |
Defer Arming Started Pulse On Time |
0 |
|
|
DeferArmingStartedPulseOffTime |
Defer Arming Started Pulse Off Time |
0 |
|
|
DeferWarningKeypadGroup |
Defer Warning Keypad Group |
2147483647 |
|
|
DeferWarningTimeMinutes |
Defer Warning Time (minutes) |
60 |
|
|
FailToArmPGM |
Fail To Arm Output |
2147483647 |
|
|
BellSquawkOnArmingStart |
Bell Squawk On Arming Start |
false |
|
|
BellSquawkOnArmingComplete |
Bell Squawk On Arming Complete |
false |
|
|
BellSquawkOnlyWhenUnattended |
Bell Squawk Only When Unattended |
false |
|
|
BellSquawkOnDisarm |
Bell Squawk On Disarm |
false |
|
|
BellSquawkOnSuccessfulReport |
Bell Squawk On Successful Report |
false |
|
|
NormalDisarmSchedule |
Normal Disarm Schedule |
2147483647 |
|
|
NormalArmSchedule |
Normal Arm Schedule |
2147483647 |
|
|
LockDoorGroupOnArming |
Lock Door Group On Arming |
2147483647 |
|
|
BellPGMOutputGroup |
Bell Output Group |
2147483647 |
|
|
ExitDelayPGMOutputGroup |
Exit Delay Output Group |
2147483647 |
|
|
EntryDelayPGMOutputGroup |
Entry Delay Output Group |
2147483647 |
|
|
DisarmedPGMOutputGroup |
Disarmed Output Group |
2147483647 |
|
|
ArmedPGMOutputGroup |
Armed Output Group |
2147483647 |
|
|
BypassedZonesPGMOutputGroup |
Bypassed Inputs Output Group |
2147483647 |
|
|
TamperAlarmPGMOutputGroup |
Tamper Alarm Output Group |
2147483647 |
|
|
AlarmMemoryPGMOutputGroup |
Alarm Memory Output Group |
2147483647 |
|
|
UserCountReachedPGMOutputGroup |
User Count Reached Output Group |
2147483647 |
|
|
AreaDeferArmingStartedPGMOutputGroup |
Area Defer Arming Started Output Group |
2147483647 |
|
|
FailToArmPGMGroup |
Fail To Arm Output Group |
2147483647 |
|
|
Commands |
Commands |
|
|
|
ServiceId* |
Reporting Services |
1 |
|
Parameters that contain multiple values are documented as <Parameter Name>*, where * is the index of the value. See Programming.