Inputs
Table Name: GXT_INPUTS_TBL
List
Request a list of inputs.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_INPUTS_TBL
-
Response:
Copy0=Controller Input 1&1=Controller Input 2&2=Controller Input 3&3=Controller Input 4&4=Controller Input 5&5=Controller Input 6&6=Controller Input 7&7=Controller Input 8&12=Keypad 1 Input 1&13=Keypad 1 Input 2
Detail
Request the details of a specific input.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_INPUTS_TBL&RecId=<RecId>
-
Response:
CopyInputId=0&Name=Controller Input 1&Area1=2147483647&Area2=2147483647&Area3=2147483647&Area4=2147483647&ZoneType1=2147483647&ZoneType2=2147483647&ZoneType3=2147483647&ZoneType4=2147483647&ZoneLedDisplay1=255&ZoneLedDisplay2=255&ZoneLedDisplay3=255&ZoneLedDisplay4=255&LogToEventBuffer=false&TestForTroubleCondition=false&BypassingNotAllowed=false&LatchBypassingNotAllowed=false&ZoneInverted=false&LogZoneEventwhenBypassed=false&TamperZoneifModuleOffline=false&TamperFollowsBypassState=true&NoBypassIfAnyAreaArmed=false&InputEndOfLine=4&ControlPGM=2147483647&ControlAutomation=2147483647&ReportingId=1&AlarmZoneSpeed=5&RestoreZoneSpeed=5&ControlPGMGroup=2147483647&Module=1&ModuleAddress=0&ModuleZone=0&Commands=&EnableInputLockout=false&InputLockoutCount=1
Update
Update a specific input.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_INPUTS_TBL&InputId=652&Name=RD5.1
-
Response:
CopyOK
Create
Create an input. To create an input, use the same parameters as update but leave the InputId empty.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_INPUTS_TBL&InputId=&Name=Controller Input 1&Area1=2147483647&Area2=2147483647&Area3=2147483647&Area4=2147483647&ZoneType1=2147483647&ZoneType2=2147483647&ZoneType3=2147483647&ZoneType4=2147483647&ZoneLedDisplay1=255&ZoneLedDisplay2=255&ZoneLedDisplay3=255&ZoneLedDisplay4=255&LogToEventBuffer=false&TestForTroubleCondition=false&BypassingNotAllowed=false&LatchBypassingNotAllowed=false&ZoneInverted=false&LogZoneEventwhenBypassed=false&TamperZoneifModuleOffline=false&TamperFollowsBypassState=true&NoBypassIfAnyAreaArmed=false&InputEndOfLine=4&ControlPGM=2147483647&ControlAutomation=2147483647&ReportingId=1&AlarmZoneSpeed=5&RestoreZoneSpeed=5&ControlPGMGroup=2147483647&Module=1&ModuleAddress=0&ModuleZone=0&Commands=&EnableInputLockout=false&InputLockoutCount=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 input.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Delete&SubType=GXT_INPUTS_TBL&RecId=<RecId>
-
Response:
CopyOK
Parameters
Parameter |
Display Name |
Default Value |
Notes |
||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
InputId |
Database ID |
0 |
The Detail, Control and Delete APIs use this value as the RecId. |
||||||||||||||||||||||||||||||||||
Name |
Name |
Controller Input 1 |
|
||||||||||||||||||||||||||||||||||
Area1 |
Area (1) |
2147483647 |
|
||||||||||||||||||||||||||||||||||
Area2 |
Area (2) |
2147483647 |
|
||||||||||||||||||||||||||||||||||
Area3 |
Area (3) |
2147483647 |
|
||||||||||||||||||||||||||||||||||
Area4 |
Area (4) |
2147483647 |
|
||||||||||||||||||||||||||||||||||
ZoneType1 |
Input Type (1) |
2147483647 |
|
||||||||||||||||||||||||||||||||||
ZoneType2 |
Input Type (2) |
2147483647 |
|
||||||||||||||||||||||||||||||||||
ZoneType3 |
Input Type (3) |
2147483647 |
|
||||||||||||||||||||||||||||||||||
ZoneType4 |
Input Type (4) |
2147483647 |
|
||||||||||||||||||||||||||||||||||
ZoneLedDisplay1 |
KLES Input LED (1) |
255 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||||
ZoneLedDisplay2 |
KLES Input LED (2) |
255 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||||
ZoneLedDisplay3 |
KLES Input LED (3) |
255 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||||
ZoneLedDisplay4 |
KLES Input LED (4) |
255 |
This is a legacy option that has no effect. |
||||||||||||||||||||||||||||||||||
LogToEventBuffer |
Log to Event Buffer |
false |
|
||||||||||||||||||||||||||||||||||
TestForTroubleCondition |
Test For Trouble Condition |
false |
|
||||||||||||||||||||||||||||||||||
BypassingNotAllowed |
Bypassing Not Allowed |
false |
|
||||||||||||||||||||||||||||||||||
LatchBypassingNotAllowed |
Latch Bypassing Not Allowed |
false |
|
||||||||||||||||||||||||||||||||||
ZoneInverted |
Contact Type |
false |
|
||||||||||||||||||||||||||||||||||
LogZoneEventwhenBypassed |
Log Input Event when Bypassed |
false |
|
||||||||||||||||||||||||||||||||||
TamperZoneifModuleOffline |
Tamper Input if Module Offline |
false |
|
||||||||||||||||||||||||||||||||||
TamperFollowsBypassState |
Tamper Follows Bypass State |
true |
|
||||||||||||||||||||||||||||||||||
NoBypassIfAnyAreaArmed |
No Bypass If Any Area Armed |
false |
|
||||||||||||||||||||||||||||||||||
InputEndOfLine |
Input End Of Line (EOL) |
4 |
The settings are:
|
||||||||||||||||||||||||||||||||||
ControlPGM |
Control Output |
2147483647 |
|
||||||||||||||||||||||||||||||||||
ControlAutomation |
Control Automation |
2147483647 |
|
||||||||||||||||||||||||||||||||||
ReportingId |
Reporting ID |
1 |
|
||||||||||||||||||||||||||||||||||
AlarmZoneSpeed |
Alarm Input Speed |
5 |
The settings are:
|
||||||||||||||||||||||||||||||||||
RestoreZoneSpeed |
Restore Input Speed |
5 |
The settings are:
|
||||||||||||||||||||||||||||||||||
ControlPGMGroup |
Control Output Group |
2147483647 |
|
||||||||||||||||||||||||||||||||||
Module |
Module Type |
1 |
The settings are:
|
||||||||||||||||||||||||||||||||||
ModuleAddress |
Module Address |
0 |
|
||||||||||||||||||||||||||||||||||
ModuleZone |
Module Input |
0 |
|
||||||||||||||||||||||||||||||||||
Commands |
Commands |
|
|
||||||||||||||||||||||||||||||||||
EnableInputLockout |
Enable Input Lockout |
false |
|
||||||||||||||||||||||||||||||||||
InputLockoutCount |
Input Lockout Count |
1 |
|