Keypads
Table Name: GXT_KEYPADS_TBL
List
Request a list of keypads.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_KEYPADS_TBL -
Response:
Copy1=Keypad One&2=Keypad Two
Detail
Request the details of a specific keypad.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_KEYPADS_TBL&RecId=<RecId> -
Response:
CopyKeypadId=1&Name=Keypad One&PollTimeForTheLCDSeconds=250&AreaThisLCDBelongsTo=2147483647&DisplayCustomMessagelines1And2=true&DisplayPrimaryAreaStatus=false&DisplayScrollableAreaGroup=false&DisplayTroubleMessage=false&DisplayBypassMessage=false&DisplayAlarmMessage=false&DisplayPrimaryAreaMessagesOnly=false&DisplayDeferAreaWarningMessages=false&FunctionKeyUnlocksDoorWhenLoggedInREX=false&KeypadCanAccessOnlyPrimaryArea=false&AllowAreaGroupSelectionAccess=true&Allow24HrAreaAccess=true&FunctionKeyUnlocksDoorWhenLoggedOutREX=false&AutoLogoutAfterUserArming=false&ActivateAccessLevelPGM=false&LockKeypadOnExcessAttempts=false&OfflineAccessToAutomationMenu=false&AllowAccessToTheTroubleViewMenu=true&AllowAccessToTheEventReviewMenu=false&AllowAccessToTheInformationMenu=true&KeypadLoginRequiresCard=false&DisplayUserAccessDetails=false&DisableTheLCDKeypadBeeper=false&DuplexZones4KeypadZones=false&BeepOnCommunicationFailure=false&ClearKeyCanDisableKeypressBeeper=true&VirtualModule=false&EnableZone1AsDoorInput=false&EnableZone2AsREXInput=false&DualCodeTimeout=0&LockoutKeypadTime=60&DoorNumberConnectedToKeypad=2147483647&MenuGroupForThisKeypad=2147483647&AreaGroupForThisKeypad=2147483647&SmokeResetPGM=2147483647&TimeUserIsLoggedInSeconds=2&SmokeResetPGMGroup=2147483647&PhysicalAddress=0&ActivateAccessLevelPGMOnlyonValidAccess=false&AlwaysActivateAccessLevelPGM=false&Commands=&DefaultDisplayLineOne= Protege WX&DefaultDisplayLineTwo= By ICT&MaxInvalidPINEntries=3
Update
Update a specific keypad.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_KEYPADS_TBL&KeypadId=1&Name=Reception Keypad -
Response:
CopyOK
Create
Create a keypad. To create a keypad, use the same parameters as update but leave the KeypadId empty.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_KEYPADS_TBL&KeypadId=&Name=Keypad One&PollTimeForTheLCDSeconds=250&AreaThisLCDBelongsTo=2147483647&DisplayCustomMessagelines1And2=true&DisplayPrimaryAreaStatus=false&DisplayScrollableAreaGroup=false&DisplayTroubleMessage=false&DisplayBypassMessage=false&DisplayAlarmMessage=false&DisplayPrimaryAreaMessagesOnly=false&DisplayDeferAreaWarningMessages=false&FunctionKeyUnlocksDoorWhenLoggedInREX=false&KeypadCanAccessOnlyPrimaryArea=false&AllowAreaGroupSelectionAccess=true&Allow24HrAreaAccess=true&FunctionKeyUnlocksDoorWhenLoggedOutREX=false&AutoLogoutAfterUserArming=false&ActivateAccessLevelPGM=false&LockKeypadOnExcessAttempts=false&OfflineAccessToAutomationMenu=false&AllowAccessToTheTroubleViewMenu=true&AllowAccessToTheEventReviewMenu=false&AllowAccessToTheInformationMenu=true&KeypadLoginRequiresCard=false&DisplayUserAccessDetails=false&DisableTheLCDKeypadBeeper=false&DuplexZones4KeypadZones=false&BeepOnCommunicationFailure=false&ClearKeyCanDisableKeypressBeeper=true&VirtualModule=false&EnableZone1AsDoorInput=false&EnableZone2AsREXInput=false&DualCodeTimeout=0&LockoutKeypadTime=60&DoorNumberConnectedToKeypad=2147483647&MenuGroupForThisKeypad=2147483647&AreaGroupForThisKeypad=2147483647&SmokeResetPGM=2147483647&TimeUserIsLoggedInSeconds=2&SmokeResetPGMGroup=2147483647&PhysicalAddress=0&ActivateAccessLevelPGMOnlyonValidAccess=false&AlwaysActivateAccessLevelPGM=false&Commands=&DefaultDisplayLineOne=Welcome to&DefaultDisplayLineTwo=Building 2&MaxInvalidPINEntries=3 -
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 keypad.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Delete&SubType=GXT_KEYPADS_TBL&RecId=<RecId> -
Response:
CopyOK
Parameters
|
Parameter |
Display Name |
Default Value |
Notes |
|---|---|---|---|
|
KeypadId |
Database ID |
1 |
The Detail, Control and Delete APIs use this value as the RecId. |
|
Name |
Name |
Keypad One |
|
|
PollTimeForTheLCDSeconds |
|
250 |
This is a legacy option that has no effect. |
|
AreaThisLCDBelongsTo |
Area This LCD Belongs To |
2147483647 |
|
|
DisplayCustomMessagelines1And2 |
Display Custom Message (lines 1 and 2) |
true |
|
|
DisplayPrimaryAreaStatus |
Display Primary Area Status |
false |
|
|
DisplayScrollableAreaGroup |
Display Scrollable Area Group |
false |
|
|
DisplayTroubleMessage |
Display Trouble Message |
false |
|
|
DisplayBypassMessage |
Display Bypass Message |
false |
|
|
DisplayAlarmMessage |
Display Alarm Message |
false |
|
|
DisplayPrimaryAreaMessagesOnly |
Display Primary Area Messages Only |
false |
|
|
DisplayDeferAreaWarningMessages |
Display Defer Area Warning Messages |
false |
|
|
FunctionKeyUnlocksDoorWhenLoggedInREX |
Function Key Unlocks Door When Logged In (REX) |
false |
|
|
KeypadCanAccessOnlyPrimaryArea |
Keypad Can Access Only Primary Area |
false |
|
|
AllowAreaGroupSelectionAccess |
Allow Area Group Selection Access |
true |
|
|
Allow24HrAreaAccess |
Allow 24Hr Area Access |
true |
|
|
FunctionKeyUnlocksDoorWhenLoggedOutREX |
Function Key Unlocks Door When Logged Out (REX) |
false |
|
|
AutoLogoutAfterUserArming |
Auto Logout After User Arming |
false |
|
|
ActivateAccessLevelPGM |
Activate Access Level Output |
false |
|
|
LockKeypadOnExcessAttempts |
Lock Keypad On Excess Attempts |
false |
|
|
OfflineAccessToAutomationMenu |
Offline Access to Automation Menu |
false |
|
|
AllowAccessToTheTroubleViewMenu |
Allow Access to the Trouble View Menu |
true |
|
|
AllowAccessToTheEventReviewMenu |
Allow Access to the Event Review Menu |
false |
|
|
AllowAccessToTheInformationMenu |
Allow Access to the Information Menu |
true |
|
|
KeypadLoginRequiresCard |
Keypad Login Requires Card |
false |
|
|
DisplayUserAccessDetails |
|
false |
This option is not used. |
|
DisableTheLCDKeypadBeeper |
Disable the LCD Keypad Beeper |
false |
|
|
DuplexZones4KeypadZones |
Duplex Inputs (4 Keypad Inputs) |
false |
|
|
BeepOnCommunicationFailure |
Beep On Communication Failure |
false |
|
|
ClearKeyCanDisableKeypressBeeper |
Clear Key Can Disable Keypress Beeper |
true |
|
|
VirtualModule |
Virtual Module |
false |
|
|
EnableZone1AsDoorInput |
|
false |
This is a legacy option that has no effect. |
|
EnableZone2AsREXInput |
|
false |
This is a legacy option that has no effect. |
|
DualCodeTimeout |
|
0 |
This is a legacy option that has no effect. |
|
LockoutKeypadTime |
Lockout Keypad Time (seconds) |
60 |
|
|
DoorNumberConnectedToKeypad |
Door Connected To Keypad |
2147483647 |
|
|
MenuGroupForThisKeypad |
Menu Group For This Keypad |
2147483647 |
|
|
AreaGroupForThisKeypad |
Area Group for this Keypad |
2147483647 |
|
|
SmokeResetPGM |
Smoke Reset Output |
2147483647 |
|
|
TimeUserIsLoggedInSeconds |
Time User Is Logged In (seconds) |
2 |
|
|
SmokeResetPGMGroup |
Smoke Reset Output Group |
2147483647 |
|
|
PhysicalAddress |
Physical Address |
0 |
|
|
ActivateAccessLevelPGMOnlyonValidAccess |
Activate Access Level Output Only on Valid Access |
false |
|
|
AlwaysActivateAccessLevelPGM |
Always Activate Access Level Output |
false |
|
|
Commands |
Commands |
|
|
|
DefaultDisplayLineOne |
Default Display Line One |
Protege WX |
|
|
DefaultDisplayLineTwo |
Default Display Line Two |
By ICT |
|
|
MaxInvalidPINEntries |
Max Invalid PIN Entry Attempts |
3 |
|