Controllers
Table Name: GXT_CONTROLLERS_TBL
List
Request a list of controllers.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_CONTROLLERS_TBL -
Response:
Copy5=PROTEGE WX
Detail
Request the details of the controller.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_CONTROLLERS_TBL&RecId=5 -
Response:
CopyControllerId=5&Name=PROTEGE WX&ACFailTimeMinutes=30&BatteryTestTimeMinutes=60&HighCurrentChargeOnPanelBatteryCircuit=false&GeneratePeriodicMinutesTestReport=false&TroublesRequireAcknowledge=false&GenerateZoneRestoreOnTestReportZone=false&LogZoneReferenceErrors=false&LogAssertionErrors=false&LoginUserCodeNotRequired=false&PanelName=PROTEGE WX&PanelIdCode=5&HostIdCode=5&TestReport=1-1-2226T0:0:0&EnableAutomaticOfflineDownload=false&AutomaticOfflineTime=1-1-2226T0:0:0&ACRestoreDelayTime=60&AutomaticallySynchronizeWithAnInternetTimeServer=false&PrimarySNTPTimeServer=0.0.0.0&SecondarySNTPTimeServer=0.0.0.0&TimeZone=0&ModuleUDPPort=9450&ModemCountry=0&DefaultLanguage=0&TouchScreenUDPPort=9460&CustomReaderType=0&BitLength=0&SiteCodeStart=0&SiteCodeEnd=0&CardNumberStart=0&CardNumberEnd=0&DataFormat=0&ParityType=0&ParityLocation=255&ParityStart=255&ParityEnd=255&ParityType2=0&ParityLocation2=255&ParityStart2=255&ParityEnd2=255&ParityType3=0&ParityLocation3=255&ParityStart3=255&ParityEnd3=255&ParityType4=0&ParityLocation4=255&ParityStart4=255&ParityEnd4=255&SetBit1=255&SetBit2=255&SetBit3=255&SetBit4=255&ClearBit1=255&ClearBit2=255&ClearBit3=255&ClearBit4=255&ModemBackupIfIPFails=false&BackupOnlyAlarmEvents=false&ModemBackupPhoneNumber=2147483647&RefreshPCStatusAfterConnecting=true&RegisterAsReaderExpander=0&OnboardReader=2&InvertControllerTamperInput=false&LogAllAccessLevelEvents=false&Commands=&EnableULOperationMode=false&3GUserName=&3GPassword=&3GAPN=&Enable3GModem=false&3GDebug=false&3GOnlinePingTest=2147483647&BlindDial=false&PP_Length=false&PP_LengthField=6&PP_Ucase=false&PP_UcaseField=2&PP_Digits=false&PP_DigitsField=2&PP_Schars=false&PP_ScharsField=2&PP_Uname=false&VoipPhoneBook=false&EnableDDNSCable=false&EnableDDNS3G=false&DDNSServer=&DDNSCableHost=&DDNS3GHost=&DDNSUserName=&DDNSPassword=&SMTPMailServer=exampleserver.smtp.com&SMTPPort=587&UseSSL=false&SMTPLogon=username&SMTPPassword=password&SMTPTimeout=100&SenderEmailAddress=sender@example.com&SenderDisplayName=Name&PurgeOldEvents=false&EventPurgeDays=2147483647
Update
Update the controller.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_CONTROLLERS_TBL&ControllerId=5&Name=Controller -
Response:
CopyOK
Create
It is not possible to create a controller record.
Delete
It is not possible to delete a controller record.
Parameters
|
Parameter |
Display Name |
Default Value |
Notes |
||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ControllerId |
Database ID |
5 |
The Detail, Control and Delete APIs use this value as the RecId. |
||||||||||||||||||||||||||||||||
|
Name |
Name |
PROTEGE WX |
|
||||||||||||||||||||||||||||||||
|
ACFailTimeMinutes |
|
30 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
BatteryTestTimeMinutes |
|
60 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
HighCurrentChargeOnPanelBatteryCircuit |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
GeneratePeriodicMinutesTestReport |
Test Report Time is Periodic |
false |
|
||||||||||||||||||||||||||||||||
|
TroublesRequireAcknowledge |
|
false |
When enabled, system troubles will remain in the keypad trouble view menu until they are acknowledged by a user. When disabled, troubles will be removed when the trouble condition ends. |
||||||||||||||||||||||||||||||||
|
GenerateZoneRestoreOnTestReportZone |
Generate Input Restore On Test Report Input |
false |
|
||||||||||||||||||||||||||||||||
|
LogZoneReferenceErrors |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
LogAssertionErrors |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
LoginUserCodeNotRequired |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
PanelName |
Name |
PROTEGE WX |
|
||||||||||||||||||||||||||||||||
|
PanelIdCode |
|
5 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
HostIdCode |
|
5 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
TestReport |
Test Report Time |
1-1-2226T0:0:0 |
|
||||||||||||||||||||||||||||||||
|
EnableAutomaticOfflineDownload |
Enable Automatic Offline Download |
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
AutomaticOfflineTime |
Automatic Offline Time |
1-1-2226T0:0:0 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
ACRestoreDelayTime |
|
60 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
AutomaticallySynchronizeWithAnInternetTimeServer |
Automatically Synchronize With An Internet Time Server |
false |
|
||||||||||||||||||||||||||||||||
|
PrimarySNTPTimeServer |
Primary SNTP Time Server |
0.0.0.0 |
|
||||||||||||||||||||||||||||||||
|
SecondarySNTPTimeServer |
Secondary SNTP Time Server |
0.0.0.0 |
|
||||||||||||||||||||||||||||||||
|
TimeZone |
Time Zone |
0 |
Enter the offset from GMT. |
||||||||||||||||||||||||||||||||
|
ModuleUDPPort |
Module UDP Port |
9450 |
|
||||||||||||||||||||||||||||||||
|
ModemCountry |
|
0 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
DefaultLanguage |
Default Keypad Language |
0 |
The settings are:
|
||||||||||||||||||||||||||||||||
|
TouchScreenUDPPort |
Touch Screen UDP Port |
9460 |
|
||||||||||||||||||||||||||||||||
|
CustomReaderType |
Custom Reader Type |
0 |
The settings are:
|
||||||||||||||||||||||||||||||||
|
BitLength |
Bit Length |
0 |
|
||||||||||||||||||||||||||||||||
|
SiteCodeStart |
Site Code Start |
0 |
|
||||||||||||||||||||||||||||||||
|
SiteCodeEnd |
Site Code End |
0 |
|
||||||||||||||||||||||||||||||||
|
CardNumberStart |
Card Number Start |
0 |
|
||||||||||||||||||||||||||||||||
|
CardNumberEnd |
Card Number End |
0 |
|
||||||||||||||||||||||||||||||||
|
DataFormat |
Data Format |
0 |
The settings are:
|
||||||||||||||||||||||||||||||||
|
ParityType |
Parity Type (1) |
0 |
The settings are:
|
||||||||||||||||||||||||||||||||
|
ParityLocation |
Parity Location (1) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityStart |
Parity Start (1) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityEnd |
Parity End (1) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityType2 |
Parity Type (2) |
0 |
|
||||||||||||||||||||||||||||||||
|
ParityLocation2 |
Parity Location (2) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityStart2 |
Parity Start (2) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityEnd2 |
Parity End (2) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityType3 |
Parity Type (3) |
0 |
|
||||||||||||||||||||||||||||||||
|
ParityLocation3 |
Parity Location (3) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityStart3 |
Parity Start (3) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityEnd3 |
Parity End (3) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityType4 |
Parity Type (4) |
0 |
|
||||||||||||||||||||||||||||||||
|
ParityLocation4 |
Parity Location (4) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityStart4 |
Parity Start (4) |
255 |
|
||||||||||||||||||||||||||||||||
|
ParityEnd4 |
Parity End (4) |
255 |
|
||||||||||||||||||||||||||||||||
|
SetBit1 |
Set Bit 1 |
255 |
|
||||||||||||||||||||||||||||||||
|
SetBit2 |
Set Bit 2 |
255 |
|
||||||||||||||||||||||||||||||||
|
SetBit3 |
Set Bit 3 |
255 |
|
||||||||||||||||||||||||||||||||
|
SetBit4 |
Set Bit 4 |
255 |
|
||||||||||||||||||||||||||||||||
|
ClearBit1 |
Clear Bit 1 |
255 |
|
||||||||||||||||||||||||||||||||
|
ClearBit2 |
Clear Bit 2 |
255 |
|
||||||||||||||||||||||||||||||||
|
ClearBit3 |
Clear Bit 3 |
255 |
|
||||||||||||||||||||||||||||||||
|
ClearBit4 |
Clear Bit 4 |
255 |
|
||||||||||||||||||||||||||||||||
|
ModemBackupIfIPFails |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
BackupOnlyAlarmEvents |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
ModemBackupPhoneNumber |
|
2147483647 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
RefreshPCStatusAfterConnecting |
|
true |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
RegisterAsReaderExpander |
|
0 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
OnboardReader |
|
2 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
InvertControllerTamperInput |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
LogAllAccessLevelEvents |
Log All Access Level Events |
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
Commands |
Commands |
|
|
||||||||||||||||||||||||||||||||
|
EnableULOperationMode |
Enable UL Operation Mode |
false |
|
||||||||||||||||||||||||||||||||
|
3GUserName |
|
|
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
3GPassword |
|
|
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
3GAPN |
|
|
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
Enable3GModem |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
3GDebug |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
3GOnlinePingTest |
|
2147483647 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
BlindDial |
Do Not Wait for Dial Tone When Modem Dials Out |
false |
|
||||||||||||||||||||||||||||||||
|
PP_Length |
Minimum Password Length (Active) |
false |
|
||||||||||||||||||||||||||||||||
|
PP_LengthField |
Minimum Password Length (Length) |
6 |
|
||||||||||||||||||||||||||||||||
|
PP_Ucase |
Minimum Number Of Uppercase Characters (Active) |
false |
|
||||||||||||||||||||||||||||||||
|
PP_UcaseField |
Minimum Number Of Uppercase Characters (Length) |
2 |
|
||||||||||||||||||||||||||||||||
|
PP_Digits |
Minimum Number Of Digits (Active) |
false |
|
||||||||||||||||||||||||||||||||
|
PP_DigitsField |
Minimum Number Of Digits (Length) |
2 |
|
||||||||||||||||||||||||||||||||
|
PP_Schars |
Minimum Number Of Special Characters (Active) |
false |
|
||||||||||||||||||||||||||||||||
|
PP_ScharsField |
Minimum Number Of Special Characters (Length) |
2 |
|
||||||||||||||||||||||||||||||||
|
PP_Uname |
Compare Against Username (Active) |
false |
|
||||||||||||||||||||||||||||||||
|
VoipPhoneBook |
Enable VOIP Integration |
false |
|
||||||||||||||||||||||||||||||||
|
EnableDDNSCable |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
EnableDDNS3G |
|
false |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
DDNSServer |
|
|
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
DDNSCableHost |
|
|
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
DDNS3GHost |
|
|
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
DDNSUserName |
|
|
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
DDNSPassword |
|
|
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||
|
SMTPMailServer |
SMTP Mail Server |
exampleserver.smtp.com |
|
||||||||||||||||||||||||||||||||
|
SMTPPort |
SMTP Port |
587 |
|
||||||||||||||||||||||||||||||||
|
UseSSL |
Use SSL |
false |
|
||||||||||||||||||||||||||||||||
|
SMTPLogon |
SMTP Logon |
username |
|
||||||||||||||||||||||||||||||||
|
SMTPPassword |
SMTP Password |
password |
|
||||||||||||||||||||||||||||||||
|
SMTPTimeout |
SMTP Timeout |
100 |
|
||||||||||||||||||||||||||||||||
|
SenderEmailAddress |
Sender Email Address |
sender@example.com |
|
||||||||||||||||||||||||||||||||
|
SenderDisplayName |
Sender Display Name |
Name |
|
||||||||||||||||||||||||||||||||
|
PurgeOldEvents |
Purge Old Events |
false |
|
||||||||||||||||||||||||||||||||
|
EventPurgeDays |
Days To Keep Events |
2147483647 |
|
||||||||||||||||||||||||||||||||
|
DualCredentialAtKeypad |
Require Dual Credential for Keypad Access |
false |
|
||||||||||||||||||||||||||||||||
|
AllowDuplicatePIN |
Allow Duplicate PIN |
false |
|
||||||||||||||||||||||||||||||||
|
DefaultPINLength |
Default PIN Length |
6 |
|
||||||||||||||||||||||||||||||||
|
MinimumPINLength |
Minimum PIN Length |
1 |
|
||||||||||||||||||||||||||||||||
|
MaxSequentialDigitsInPIN |
Maximum Sequential Digits |
2147483647 |
Default setting is -Not Set-. Available values are 2, 3 and 4. |
||||||||||||||||||||||||||||||||
|
MaxRepeatDigitsInPIN |
Maximum Repetitive Digits |
2147483647 |
Default setting is -Not Set-. Available values are 2, 3 and 4. |
||||||||||||||||||||||||||||||||
|
DaysUntilPINExpiry |
PIN Expiry Time |
90 |
For Never, set value to 0. Available settings are 30, 60, 90, 180 and 365 days. |
||||||||||||||||||||||||||||||||
|
AutoGeneratedUserPINs |
|
false |
This option is not used. |