Access Levels

Table Name: GXT_ACCESSLEVELS_TBL

List

Request a list of access levels.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_ACCESSLEVELS_TBL

  • Response:

    Copy 
    14=Installer&15=Master&16=User

Detail

Request the details of a specific access level.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_ACCESSLEVELS_TBL&RecId=<RecId>

  • Response:

    Copy 
    AccessLevelId=16&Name=User&OperatingSchedule=2147483647&TimeToActivatePGM=0&ReaderAccessActivatesPGM=false&KeypadAccessActivatesPGM=false&EnableMultiBadgeArming=true&ActivatePGMToExpiry=false&MenuGroupId0=0&ArmingAreaGroupId0=4294967294&ArmingAreaGroupSchedule0=2147483647&DisarmingAreaGroupId0=4294967294&DisarmingAreaGroupSchedule0=2147483647

Update

Update a specific access level.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_ACCESSLEVELS_TBL&AccessLevelId=16&Name=Office

  • Response:

    Copy 
    OK

Create

Create an access level. To create an access level, use the same parameters as update but leave the AccessLevelId empty.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_ACCESSLEVELS_TBL&AccessLevelId=&Name=User&OperatingSchedule=2147483647&TimeToActivatePGM=0&ReaderAccessActivatesPGM=false&KeypadAccessActivatesPGM=false&EnableMultiBadgeArming=true&ActivatePGMToExpiry=false&MenuGroupId0=0&ArmingAreaGroupId0=4294967294&ArmingAreaGroupSchedule0=2147483647&DisarmingAreaGroupId0=4294967294&DisarmingAreaGroupSchedule0=2147483647
  • Response:
  • Copy 
    OK

Delete

Delete a specific access level.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Delete&SubType=GXT_ACCESSLEVELS_TBL&RecId=<RecId>

  • Response:

    Copy 
    OK

Parameters

Parameter

Display Name

Default Value

Notes

AccessLevelId

Database ID

16

The Detail, Control and Delete APIs use this value as the RecId.

Name

Name

User

 

OperatingSchedule

Operating Schedule

2147483647

Default value is Always.

TimeToActivatePGM

Time to Activate Output (seconds)

0

 

ReaderAccessActivatesPGM

Reader Access Activates Output

false

 

KeypadAccessActivatesPGM

Keypad Access Activates Output

false

 

EnableMultiBadgeArming

Enable Multi-badge Arming

true

 

ActivatePGMToExpiry

Activate Output Until Access Level Expiry

false

 

ToggleAccessLevelPGM

Toggle Access Level Output

false

 

EnableUsageRestriction

 

false

This option is not used.

EnableDoorTypeOverride

 

false

This option is not used.

ElevatorDestinationFloor

 

2147483647

This option is not used.

UsageCount

 

0

This option is not used.

UsageResetPeriod

 

0

This option is not used.

UsageResetType

 

3

This option is not used.

SchindlerTemplate

 

 

This option is not used.

DoorId*

Door

 

 

DoorSchedule*

Door Schedule

2147483647

The default schedule is Always.

DoorDirection*

Door Direction

3

The settings are:

Value

Setting

1

Entry Only

2

Exit Only

3

Entry and Exit

DoorGroupId*

Door Group

 

When Include All Doors is enabled in the controller UI, the access level has a door group with ID 4294967294 assigned. This door group grants access to every door on the controller.

This is legacy programming and should not be used in cross controller situations. Instead, use IncludeAllDoors below.

DoorGroupSchedule*

Door Group Schedule

2147483647

The default schedule is Always.

DoorGroupDirection*

Door Group Direction

3

The settings are:

Value

Setting

1

Entry Only

2

Exit Only

3

Entry and Exit

FloorId*

Floor

 

 

FloorSchedule*

Floor Schedule

2147483647

The default schedule is Always.

FloorGroupId*

Floor Group

 

When Include All Floors is enabled in the controller UI, the access level has a floor group with ID 4294967294 assigned. This floor group grants access to every floor on the controller.

This is legacy programming and should not be used in cross controller situations. Instead, use IncludeAllFloors below.

FloorGroupSchedule*

Floor Group Schedule

2147483647

The default schedule is Always.

ElevatorGroupId*

Elevator Group

 

When Include All Elevators is enabled in the controller UI, the access level has an elevator group with ID 4294967294 assigned. This elevator group grants access to every elevator on the controller.

This is legacy programming and should not be used in cross controller situations. Instead, use IncludeAllElevators below.

ElevatorGroupSchedule*

Elevator Group Schedule

2147483647

The default schedule is Always.

MenuGroupId*

Menu Group

 

 

ArmingAreaGroupId*

Arming Area Group

 

When Include All Areas is enabled in the controller UI, the access level has an arming area group with ID 4294967294 assigned. This area group grants access to every area on the controller.

This is legacy programming and should not be used in cross controller situations. Instead, use IncludeAllArmingAreas below.

ArmingAreaGroupSchedule*

Arming Area Group Schedule

2147483647

The default schedule is Always.

DisarmingAreaGroupId*

Disarming Area Group

 

When Include All Areas is enabled in the controller UI, the access level has a disarming area group with ID 4294967294 assigned. This area group grants access to every area on the controller.

This is legacy programming and should not be used in cross controller situations. Instead, use IncludeAllArmingAreas below.

DisarmingAreaGroupSchedule*

Disarming Area Group Schedule

2147483647

The default schedule is Always.

OutputId*

Output

 

 

OutputGroupId*

Output Group

 

 

IncludeAllDoors

 

false

Equivalent to the Include All Doors UI option, but can be used in cross controller situations.

IncludeAllArmingAreas

 

false

Equivalent to the Include All Areas UI option, but can be used in cross controller situations.

IncludeAllDisarmingAreas

 

false

Equivalent to the Include All Areas UI option, but can be used in cross controller situations.

IncludeAllFloors

 

false

Equivalent to the Include All Floors UI option, but can be used in cross controller situations.

IncludeAllElevators

 

false

Equivalent to the Include All Elevators UI option, but can be used in cross controller situations.

Parameters that contain multiple values are documented as <Parameter Name>*, where * is the index of the value. See Programming.