Status

Request the status of an item.

Type: Status

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Status&SubType=<SubType>

SubTypes

The list of subtypes is a subset of the table names, with some additional items:

GXT_ANALOGEXPANDERS_TBL
GXT_AREAS_TBL
GXT_CONTROLLERS_TBL
GXT_DATAVALUES_TBL
GXT_DOORS_TBL
GXT_FLOORS_TBL
GXT_INPUTEXPANDERS_TBL
GXT_INPUTS_TBL
GXT_KEYPADS_TBL
GXT_PGMEXPANDERS_TBL
GXT_PGMS_TBL
GXT_PROGRAMMABLEFUNCTIONS_TBL
GXT_READEREXPANDERS_TBL
GXT_READERUNITS_TBL
GXT_SCHEDULES_TBL
GXT_SERVICES_TBL
GXT_TROUBLEINPUTS_TBL
AREA_ZONE_STATUS
GXT_MODULES_TBL
ModuleFirmwareUpdate

Request Parameters

Parameter	Example	Description
StartId	0	Limit the response to records between StartId and EndId
EndId	10	Limit the response to records between StartId and EndId

Success Response

A successful response contains an ampersand separated list of statuses.

The keys are in the format <Item><Item ID> where:

<Item> is the table name without GXT_ at the start and S_TBL at the end, e.g. for GXT_DOORS_TBL it would be Door.
<Item ID> is the Record ID of the item.

The values are a comma separated list of the status codes. See below for a list of status codes and their meanings.

Some statuses (areas, doors, inputs, trouble inputs and floors) contain multiple status codes separated by a comma. For example:

Copy

Door0=23,3&Door1=23,3

Any valid request to a record that does not exist will return the following.

Copy

<no response>

Status Codes

The status fields and codes currently used for each device type are outlined below.

Item	Status 1	Status 2	Status 3	Status 4
Door	Door Lock Status	Door Position	Door Flag Bits
Area	24hr Status	Area Status	Area Notification Bits	Current User Count of the Area
Output	Output State	Output Flag Bits
Input	Input State	Input Flags
Trouble Input	Trouble Input State	Trouble Input Flags
Elevator	Floor ID	Floor State
Data Value	Data Value
Module	Module Record ID	Module Type	Module Online State	Module Firmware Progress State
Programmable Function	Function State
Service	Service State
Schedule	Schedule State

Calendar actions (or conditional exceptions) are not used by Protege WX controllers, but are listed here for completeness.

Doors

Value	Description
0	Locked
1	Unlocked By User
2	Unlocked By Schedule
3	Unlocked By User Timed
4	Unlocked By User Latched
5	Unlocked By Exit Device
6	Unlocked By Entry Device
7	Unlocked By Operator
8	Unlocked By Operator Timed
9	Unlocked By Operator Latch
10	Unlocked by Area
11	Unlocked by Fire Alarm
12	Locked By Conditional Exception
13	Unlocked By Conditional Exception
14	Unlocked By User Using Extended Door Time
15	Unlocked By Exit Device Using Extended Door Time
16	Unlocked By Entry Device Using Extended Door Time
17	Unlocked By Operator Using Extended Door Time
18	Locked Using Extended Door Time
19	Locked down (Entry allowed)
20	Locked down (Exit allowed)
21	Locked down (Entry/ Exit allowed)
22	Locked down (full lockdown)
23	Not Locked (in the locked state but not secure)
24	Not Locked Conditional (in the locked state but not secure, with a calendar action active)

Value	Description
0	Closed
1	Open
2	Open Alert
3	Left Open
4	Forced Open
5	Bonding Fault

Bit	Description
0	Calendar Action Active

Areas

Value	Description
0	Disabled
1	Busy
128	Enabled

Value	Description
0	Disarmed
1	Zone(s) Open Waiting For User
2	Trouble Condition Waiting for User
3	Bypass Error Waiting for User
4	Bypass Warning Waiting for User
5	User Count Not Zero Waiting for User
6	Unknown
127	Unknown
128	Armed
129	Exit Delay
130	Entry Delay
131	Disarm Delay
132	Code Delay

Bit	Description
0	Alarm Activated
1	Siren Activated
2	Alarms In Memory
3	Remote Armed
4	Force Armed
5	Instant Armed
6	Partial Armed

Outputs

Value	Description
0	Off
1	On
2	Pulse On
3	On Timed
4	On Pulse Timed
5	Off By Conditional Exception
6	On By Conditional Exception

Bit	Description
0	Calendar Action Active

Inputs

Value	Description
0	Closed / Off
1	Open / On
2	Tamper
3	Short Circuit

Bit	Description
0	Input Bypassed
1	Input Bypassed Latched
2	Siren Lockout

Trouble Inputs

Value	Description
0	Closed / Off
1	Open / On

Bit	Description
0	Input Bypassed
1	Input Bypassed Latched

Elevator Cars

Value	Description
0	Floor is inaccessible
1	Floor accessible due to schedule
2	Floor accessible due to area
3	Floor accessible due to latch
4	Floor accessible due to user (timed)

Data Values

Programmable Functions

Value	Description
0	Programmable function halted
1	Programmable function running
2	Programmable function program error

Services

Value	Description
0	Service halted
1	Service running
2	Service failure
3	Service port in use
4	Service program error
5	Service on hold by another service

Schedules

Bit	Description
0	Schedule Valid
2	Schedule Start Valid
4	Schedule End Valid

Module

Value	Description
1	Controller
2	Keypad
3	Input Expander
4	Reader Expander
5	Output Expander
6	Analog Expander

Bit	Description
0	Module is auto-addressable
1	Module is registered
2	Module is online
3-31	Reserved

Value	Description
0	Module is offline and cannot be updated
1	Update packets sent, awaiting a reply
2	Module is restarting
3	Module update complete
4	Module failed to update

Errors

Copy

Request Failed (2) Did not get a response from the main app.

Copy

Request Failed (3) Did not recognise the response from the main app.

Copy

Request Failed (128) Event Request type not recognised.