Doors
Table Name: GXT_DOORS_TBL
List
Request a list of doors.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_DOORS_TBL -
Response:
Copy0=Door 1&1=Door 2
Detail
Request the details of a specific door.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_DOORS_TBL&RecId=<RecId> - Response
-
Copy
DoorId=0&Name=Door 1&DoorPreAlarmDelayTime=30&DoorLeftOpenAlarmTime=45&LockActivationTime=5&REXActivationTime=5&PreAlarmPulseOnTime=0&PreAlarmPulseOffTime=0&LeftOpenAlarmPulseOnTime=0&LeftOpenAlarmPulseOffTime=0&ForcedOpenPulseOnTime=0&ForcedOpenPulseOffTime=0&DoorADAAlarmDelayTime=0&EntryUserResetTime=200&ExitUserResetTime=200&Function1ActivationTime=5&Function2ActivationTime=5&Function3ActivationTime=5&DoorType=2147483647&SlaveDoor=2147483647&AreaInsideDoor=2147483647&AreaOutsideDoor=2147483647&UnlockSchedule=2147483647&InterlockDoorGroup=2147483647&CameraEntry=2147483647&CameraExit=2147483647&AutoPopupCamera=2147483647&LockPGM=2147483647&LockPGMGroup=2147483647&PreAlarmPGMOutput=2147483647&PreAlarmPGMOutputGroup=2147483647&LeftOpenAlarmPGMOutput=2147483647&LeftOpenAlarmPGMOutputGroup=2147483647&ForcedOpenPGMOutput=2147483647&ForcedOpenPGMOutputGroup=2147483647&DoorPositionInput=2147483647&BondSenseInput=2147483647&REXInput=2147483647&RENInput=2147483647&BeamInput=2147483647&AntipassbackResetSchedule=2147483647&PrealarmSchedule=2147483647&LeftOpenSchedule=2147483647&ForcedOpenSchedule=2147483647&Function1Pgm=2147483647&Function1PgmGroup=2147483647&Function2Pgm=2147483647&Function2PgmGroup=2147483647&Function3Pgm=2147483647&Function3PgmGroup=2147483647&SupportManualCommands=false&AutoCameraPopupOnDoorEvent=false&AutoCameraPopupOnDoorForcedEvent=false&AlwaysCheckUnlockSchedule=false&EnableOpenCloseEventsOnSchedule=false&RelockOnDoorClose=false&RelockOnDoorOpen=false&UnlockDoorOnREX=true&UnlockDoorOnREN=false&ScheduleOperatesLateToOpen=false&DoorLockFollowsInsideArea=false&DoorLockFollowsOutsideArea=false&PreventSlaveUnlockOnInsideArea=false&PreventUnlockOnScheduleIfInsideAreaArmed=false&PreventUnlockOnScheduleIfOutsideAreaArmed=false&AreaDisarmedANDScheduleValidUnlockDoor=false&AreaDisarmedORScheduleValidUnlockDoor=false&EnableAccessTakenOnREXRENEvents=false&UpdateUserAreaWhenPassbackDisabled=false&LockOutREXWhenInsideAreaArmed=false&DenyEntryIfInsideAreaIsArmed=false&DenyExitIfOutsideAreaIsArmed=false&DisableDoorAlarmsOnScheduleUnlock=false&PromptUserForAccessReasonCode=false&EnableAccessTakenOnDoorUnlockEvents=false&InvertDoorInput=false&InvertBondInput=false&InvertREXInput=false&InvertRENInput=false&InvertBeamInput=false&AlwaysAllowREX=true&RecycleDoorOpenTimeOnREX=false&ForcedDoorSendsDoorOpen=false&RecycleREXTime=false&MaintainREX=false&PulseReaderBeeperOnREX=false&REXTimeDifferentToLockTime=false&EnableTimedUserAntipassbackReset=false&ResetAntipassbackStatusOnSchedule=false&EnablePreAlarmEvents=true&DisablePreAlarmBySchedule=false&DisablePreAlarmByManual=false&DisablePreAlarmByArea=false&DisablePreAlarmByFunction=false&DisablePreAlarmByFire=false&EnableLeftOpenEvents=true&DisableLeftAlarmBySchedule=false&DisableLeftAlarmByManual=false&DisableLeftAlarmByArea=false&DisableLeftAlarmByFunction=false&DisableLeftAlarmByFire=false&EnableForcedOpenEvents=true&Function1ActivateOnAccess=false&Function1ActivateOnRexRen=false&Function1DeactivateOnDoorOpen=false&Function1DeactivateOnDoorClose=false&Function1RecycleTimeOnAccess=false&Function1RecycleTimeOnRexRen=false&Function2ActivateOnAccess=false&Function2ActivateOnRexRen=false&Function2DeactivateOnDoorOpen=false&Function2DeactivateOnDoorClose=false&Function2RecycleTimeOnAccess=false&Function2RecycleTimeOnRexRen=false&Function3ActivateOnAccess=false&Function3ActivateOnRexRen=false&Function3DeactivateOnDoorOpen=false&Function3DeactivateOnDoorClose=false&Function3RecycleTimeOnAccess=false&Function3RecycleTimeOnRexRen=false
Update
Update a specific door.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_DOORS_TBL&DoorId=1&Name=Front Door -
Response:
CopyOK
Create
Create a door. To create a door, use the same parameters as update but leave the DoorId empty.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_DOORS_TBL&DoorId=&Name=Door 1&DoorPreAlarmDelayTime=30&DoorLeftOpenAlarmTime=45&LockActivationTime=5&REXActivationTime=5&PreAlarmPulseOnTime=0&PreAlarmPulseOffTime=0&LeftOpenAlarmPulseOnTime=0&LeftOpenAlarmPulseOffTime=0&ForcedOpenPulseOnTime=0&ForcedOpenPulseOffTime=0&DoorADAAlarmDelayTime=0&EntryUserResetTime=200&ExitUserResetTime=200&Function1ActivationTime=5&Function2ActivationTime=5&Function3ActivationTime=5&DoorType=2147483647&SlaveDoor=2147483647&AreaInsideDoor=2147483647&AreaOutsideDoor=2147483647&UnlockSchedule=2147483647&InterlockDoorGroup=2147483647&CameraEntry=2147483647&CameraExit=2147483647&AutoPopupCamera=2147483647&LockPGM=2147483647&LockPGMGroup=2147483647&PreAlarmPGMOutput=2147483647&PreAlarmPGMOutputGroup=2147483647&LeftOpenAlarmPGMOutput=2147483647&LeftOpenAlarmPGMOutputGroup=2147483647&ForcedOpenPGMOutput=2147483647&ForcedOpenPGMOutputGroup=2147483647&DoorPositionInput=2147483647&BondSenseInput=2147483647&REXInput=2147483647&RENInput=2147483647&BeamInput=2147483647&AntipassbackResetSchedule=2147483647&PrealarmSchedule=2147483647&LeftOpenSchedule=2147483647&ForcedOpenSchedule=2147483647&Function1Pgm=2147483647&Function1PgmGroup=2147483647&Function2Pgm=2147483647&Function2PgmGroup=2147483647&Function3Pgm=2147483647&Function3PgmGroup=2147483647&SupportManualCommands=false&AutoCameraPopupOnDoorEvent=false&AutoCameraPopupOnDoorForcedEvent=false&AlwaysCheckUnlockSchedule=false&EnableOpenCloseEventsOnSchedule=false&RelockOnDoorClose=false&RelockOnDoorOpen=false&UnlockDoorOnREX=true&UnlockDoorOnREN=false&ScheduleOperatesLateToOpen=false&DoorLockFollowsInsideArea=false&DoorLockFollowsOutsideArea=false&PreventSlaveUnlockOnInsideArea=false&PreventUnlockOnScheduleIfInsideAreaArmed=false&PreventUnlockOnScheduleIfOutsideAreaArmed=false&AreaDisarmedANDScheduleValidUnlockDoor=false&AreaDisarmedORScheduleValidUnlockDoor=false&EnableAccessTakenOnREXRENEvents=false&UpdateUserAreaWhenPassbackDisabled=false&LockOutREXWhenInsideAreaArmed=false&DenyEntryIfInsideAreaIsArmed=false&DenyExitIfOutsideAreaIsArmed=false&DisableDoorAlarmsOnScheduleUnlock=false&PromptUserForAccessReasonCode=false&EnableAccessTakenOnDoorUnlockEvents=false&InvertDoorInput=false&InvertBondInput=false&InvertREXInput=false&InvertRENInput=false&InvertBeamInput=false&AlwaysAllowREX=true&RecycleDoorOpenTimeOnREX=false&ForcedDoorSendsDoorOpen=false&RecycleREXTime=false&MaintainREX=false&PulseReaderBeeperOnREX=false&REXTimeDifferentToLockTime=false&EnableTimedUserAntipassbackReset=false&ResetAntipassbackStatusOnSchedule=false&EnablePreAlarmEvents=true&DisablePreAlarmBySchedule=false&DisablePreAlarmByManual=false&DisablePreAlarmByArea=false&DisablePreAlarmByFunction=false&DisablePreAlarmByFire=false&EnableLeftOpenEvents=true&DisableLeftAlarmBySchedule=false&DisableLeftAlarmByManual=false&DisableLeftAlarmByArea=false&DisableLeftAlarmByFunction=false&DisableLeftAlarmByFire=false&EnableForcedOpenEvents=true&Function1ActivateOnAccess=false&Function1ActivateOnRexRen=false&Function1DeactivateOnDoorOpen=false&Function1DeactivateOnDoorClose=false&Function1RecycleTimeOnAccess=false&Function1RecycleTimeOnRexRen=false&Function2ActivateOnAccess=false&Function2ActivateOnRexRen=false&Function2DeactivateOnDoorOpen=false&Function2DeactivateOnDoorClose=false&Function2RecycleTimeOnAccess=false&Function2RecycleTimeOnRexRen=false&Function3ActivateOnAccess=false&Function3ActivateOnRexRen=false&Function3DeactivateOnDoorOpen=false&Function3DeactivateOnDoorClose=false&Function3RecycleTimeOnAccess=false&Function3RecycleTimeOnRexRen=false -
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 door.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Delete&SubType=GXT_DOORS_TBL&RecId=<RecId> -
Response:
CopyOK
Parameters
|
Parameter |
Display Name |
Default Value |
Notes |
|---|---|---|---|
|
DoorId |
Database ID |
0 |
The Detail, Control and Delete APIs use this value as the RecId. |
|
Name |
Name |
Door 1 |
|
|
DoorType |
Door Type |
18 |
|
|
SlaveDoor |
Slave Door |
2147483647 |
|
|
AreaInsideDoor |
Area Inside Door |
2147483647 |
|
|
AreaOutsideDoor |
Area Outside Door |
2147483647 |
|
|
UnlockSchedule |
Unlock Schedule |
2147483647 |
Default value is Never. |
|
LockPGM |
Lock Output |
114 |
|
|
LockActivationTime |
Lock Activation Time (seconds) |
5 |
|
|
DoorPreAlarmDelayTime |
Door Pre-alarm Delay Time (seconds) |
30 |
|
|
DoorLeftOpenAlarmTime |
Door Left Open Alarm Time (seconds) |
45 |
|
|
AlwaysCheckUnlockSchedule |
Always Check Unlock Schedule |
false |
|
|
EnableOpenCloseEventsOnSchedule |
Enable Open/Close Events On Schedule |
false |
|
|
EnablePreAlarmEvents |
Enable Pre-Alarm Alarms |
true |
|
|
EnableLeftOpenEvents |
Enable Left Open Alarms |
true |
|
|
RelockOnDoorClose |
Relock On Door Close |
false |
|
|
RelockOnDoorOpen |
Relock On Door Open |
false |
|
|
UnlockDoorOnREX |
Unlock Door On REX |
true |
|
|
UnlockDoorOnREN |
Unlock Door On REN |
false |
|
|
ScheduleOperatesLateToOpen |
Schedule Operates Late To Open |
false |
|
|
DoorLockFollowsInsideArea |
Door Lock Follows Inside Area |
false |
|
|
DoorLockFollowsOutsideArea |
Door Lock Follows Outside Area |
false |
|
|
PreventSlaveUnlockOnInsideArea |
Prevent Slave Unlock On Inside Area |
false |
|
|
PreventUnlockOnScheduleIfInsideAreaArmed |
Prevent Unlock On Schedule If Inside Area Armed |
false |
|
|
PreventUnlockOnScheduleIfOutsideAreaArmed |
Prevent Unlock On Schedule If Outside Area Armed |
false |
|
|
AreaDisarmedANDScheduleValidUnlockDoor |
Area Disarmed AND Schedule Valid Unlock Door |
false |
|
|
AreaDisarmedORScheduleValidUnlockDoor |
Area Disarmed OR Schedule Valid Unlock Door |
false |
|
|
EnableAccessTakenOnREXRENEvents |
Enable Access Taken on REX/REN Events |
false |
|
|
PreAlarmPGMOutput |
Pre Alarm Output |
117 |
|
|
PreAlarmPulseOnTime |
Pre Alarm Pulse On Time |
2 |
|
|
PreAlarmPulseOffTime |
Pre Alarm Pulse Off Time |
2 |
|
|
LeftOpenAlarmPGMOutput |
Left Open Alarm Output |
117 |
|
|
LeftOpenAlarmPulseOnTime |
Left Open Alarm Pulse On Time |
5 |
|
|
LeftOpenAlarmPulseOffTime |
Left Open Alarm Pulse Off Time |
5 |
|
|
ForcedOpenPGMOutput |
Force Open Output |
117 |
|
|
ForcedOpenPulseOnTime |
Force Open Pulse On Time |
0 |
|
|
ForcedOpenPulseOffTime |
Force Open Pulse Off Time |
0 |
|
|
InterlockDoorGroup |
Interlock Door Group |
2147483647 |
|
|
UpdateUserAreaWhenPassbackDisabled |
Update User Area When Passback Disabled |
false |
|
|
LockOutREXWhenInsideAreaArmed |
Lock Out REX When Inside Area Armed |
false |
|
|
DenyEntryIfInsideAreaIsArmed |
Deny Entry if Inside Area is Armed |
false |
|
|
DenyExitIfOutsideAreaIsArmed |
Deny Exit if Outside Area is Armed |
false |
|
|
DisableDoorAlarmsOnScheduleUnlock |
|
false |
This is a legacy option that has no effect. |
|
PromptUserForAccessReasonCode |
Prompt User For Access Reason Code |
false |
|
|
EnableAccessTakenOnDoorUnlockEvents |
Enable Access Taken on Door Unlock Events |
false |
|
|
DoorADAAlarmDelayTime |
Door Extended Access Time |
10 |
|
|
LockPGMGroup |
Lock Output Group |
2147483647 |
|
|
PreAlarmPGMOutputGroup |
Pre Alarm Output Group |
2147483647 |
|
|
LeftOpenAlarmPGMOutputGroup |
Left Open Alarm Output Group |
2147483647 |
|
|
ForcedOpenPGMOutputGroup |
Forced Open Output Group |
2147483647 |
|
|
EntryUserResetTime |
Antipassback Entry User Reset Time |
200 |
|
|
ExitUserResetTime |
Antipassback Exit User Reset Time |
200 |
|
|
Commands |
Commands |
|
|
|
DoorPositionInput |
Door Position Input |
0 |
|
|
BondSenseInput |
Bond Sense Input |
2147483647 |
|
|
REXInput |
REX Input |
1 |
|
|
RENInput |
REN Input |
2147483647 |
|
|
BeamInput |
Beam Input |
2147483647 |
|
|
InvertDoorInput |
Invert Door Input |
false |
|
|
InvertBondInput |
Invert Bond Input |
false |
|
|
InvertREXInput |
Invert REX Input |
true |
|
|
InvertRENInput |
Invert REN Input |
false |
|
|
InvertBeamInput |
Invert Beam Input |
false |
|
|
AlwaysAllowREX |
Always Allow REX |
true |
|
|
RecycleDoorOpenTimeOnREX |
Recycle Door Open Time On REX |
false |
|
|
ForcedDoorSendsDoorOpen |
Forced Door Sends Door Open |
false |
|
|
RecycleREXTime |
Recycle REX Time |
false |
|
|
EnableTimedUserAntipassbackReset |
Enable Timed User Antipassback Reset |
false |
|
|
ResetAntipassbackStatusOnSchedule |
Reset Antipassback Status On Schedule |
false |
|
|
AntipassbackResetSchedule |
Antipassback Reset Schedule |
2147483647 |
|
|
MaintainREX |
Maintain REX |
false |
|
|
PulseReaderBeeperOnREX |
Pulse Reader Beeper On REX |
false |
|
|
REXTimeDifferentToLockTime |
REX Time Different To Lock Time |
false |
|
|
REXActivationTime |
REX Activation Time |
5 |
|
|
DisablePreAlarmBySchedule |
Disable During Unlock Schedule (Pre Alarm Options) |
false |
|
|
DisablePreAlarmByManual |
Disable During Manual Commands (Pre Alarm Options) |
false |
|
|
DisablePreAlarmByArea |
Disable Whilst Unlocked By Area (Pre Alarm Options) |
false |
|
|
DisablePreAlarmByFunction |
Disable Whilst Unlocked By Programmable Function (Pre Alarm Options) |
false |
|
|
DisablePreAlarmByFire |
Disable Whilst Unlocked By Fire Drop (Pre Alarm Options) |
false |
|
|
DisableLeftAlarmBySchedule |
Disable During Unlock Schedule (Left Open Options) |
false |
|
|
DisableLeftAlarmByManual |
Disable During Manual Commands (Left Open Options) |
false |
|
|
DisableLeftAlarmByArea |
Disable Whilst Unlocked By Area (Left Open Options) |
false |
|
|
DisableLeftAlarmByFunction |
Disable Whilst Unlocked By Programmable Function (Left Open Options) |
false |
|
|
DisableLeftAlarmByFire |
Disable Whilst Unlocked By Fire Drop (Left Open Options) |
false |
|
|
EnableForcedOpenEvents |
Enable Forced Open Alarms (Forced Open Options) |
true |
|
|
PrealarmSchedule |
Alarm Operating Schedule (Pre Alarm Options) |
2147483647 |
|
|
LeftOpenSchedule |
Alarm Operating Schedule (Left Open Options) |
2147483647 |
|
|
ForcedOpenSchedule |
Alarm Operating Schedule (Forced Open Options) |
2147483647 |
|
|
Function1Pgm |
Function 1 Output |
2147483647 |
|
|
Function1PgmGroup |
Function 1 Output Group |
2147483647 |
|
|
Function1ActivationTime |
Function 1 Activation Time |
5 |
|
|
Function1ActivateOnAccess |
Activate On Access (Function 1 Output) |
false |
|
|
Function1ActivateOnRexRen |
Activate On REX/REN (Function 1 Output) |
false |
|
|
Function1DeactivateOnDoorOpen |
Deactivate on Door Open (Function 1 Output) |
false |
|
|
Function1DeactivateOnDoorClose |
Deactivate on Door Close (Function 1 Output) |
false |
|
|
Function1RecycleTimeOnAccess |
Recycle Time on Access (Function 1 Output) |
false |
|
|
Function1RecycleTimeOnRexRen |
Recycle Time on REX/REN (Function 1 Output) |
false |
|
|
Function2Pgm |
Function 2 Output |
2147483647 |
|
|
Function2PgmGroup |
Function 2 Output Group |
2147483647 |
|
|
Function2ActivationTime |
Function 2 Activation Time |
5 |
|
|
Function2ActivateOnAccess |
Activate On Access (Function 2 Output) |
false |
|
|
Function2ActivateOnRexRen |
Activate On REX/REN (Function 2 Output) |
false |
|
|
Function2DeactivateOnDoorOpen |
Deactivate on Door Open (Function 2 Output) |
false |
|
|
Function2DeactivateOnDoorClose |
Deactivate on Door Close (Function 2 Output) |
false |
|
|
Function2RecycleTimeOnAccess |
Recycle Time on Access (Function 2 Output) |
false |
|
|
Function2RecycleTimeOnRexRen |
Recycle Time on REX/REN (Function 2 Output) |
false |
|
|
Function3Pgm |
Function 3 Output |
2147483647 |
|
|
Function3PgmGroup |
Function 3 Output Group |
2147483647 |
|
|
Function3ActivationTime |
Function 3 Activation Time |
5 |
|
|
Function3ActivateOnAccess |
Activate On Access (Function 3 Output) |
false |
|
|
Function3ActivateOnRexRen |
Activate On REX/REN (Function 3 Output) |
false |
|
|
Function3DeactivateOnDoorOpen |
Deactivate on Door Open (Function 3 Output) |
false |
|
|
Function3DeactivateOnDoorClose |
Deactivate on Door Close (Function 3 Output) |
false |
|
|
Function3RecycleTimeOnAccess |
Recycle Time on Access (Function 3 Output) |
false |
|
|
Function3RecycleTimeOnRexRen |
Recycle Time on REX/REN (Function 3 Output) |
false |
|