Users

Table Name: GXT_USERS_TBL

List

Requests a list of users.

The user list must be paginated when there are more than 2500 users. To enable pagination, specify the StartAfterId parameter in the URL. Each response will return a maximum of 2500 user records.

Example: Less than 2500 Users

To retrieve all users from a system with 3 users:

Request:

Copy

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

Response:

Copy

41=Installer&42=Master&43=User (Demo)&44=Jane Doe

Example: More than 2500 Users

To retrieve all users from a system with 7400 users:

Request 1:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_USERS_TBL&str=&StartAfterId=0

Response 1:

Copy

0=First&42=Master&43=User (Demo)&........&2499=User2499ThisCount=2500&TotalCount=7400

Note that ID 0 is included in the response when StartAfterId=0.

Request 2:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_USERS_TBL&str=&StartAfterId=2499

Response 2:

Copy

2500=User2500&........&4999=User4999ThisCount=2500&TotalCount=7400

Request 3:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_USERS_TBL&str=&StartAfterId=4999

Response 3:

Copy

5000=User5000&........&7399=User7399ThisCount=2400&TotalCount=7400

If the StartAfterId parameter is invalid (too high), the response will be empty.

Detail

Request the details of a specific user.

Request:

Copy

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

Response:

Copy

UserId=41&FirstName=Installer&LastName=&Name=Installer&DefaultLanguage=0&PINNumber=********&StartDateValid=false&StartDate=15-4-2013T0:0:0&ExpiryDateValid=false&ExpiryDate=15-4-2013T0:0:0&UserArea=2147483647&UserAreaGroup=2147483647&AccessLevel0=14&DisableUser=false&Showagreetingmessagetouser=true&GoDirectlyToTheMenuOnLogin=true&UserCanAcknowledgeAlarmMemory=false&ShowAlarmMemoryOnLogin=false&TurnOffthePrimaryAreaIfUserHasAccessOnLogin=false&TurnOfftheUserAreaonLoginifUserhasaccess=false&AcknowledgeSystemTroubles=false&Userhassuperrightsandcanoverrideantipassback=false&UserOperatesADAFunction=false&UserLoiterExpiryCountEnabled=false&UserCanLogInRemotely=false&UserisaDuressUser=false&RearmAreaInStayMode=false&DualCustodyMaster=false&DualCustodyProvider=false&TreatUserPinXXX1AsDuress=false&ReportingId=1&PhoneExtension=&CompanyName=

When RecId=0 the first user in numerical order will returned, which may contain a RecId different to what was requested.

Update

Update a specific user.

Request:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_USERS_TBL&UserId=44&FirstName=Vivienne

Response:
Copy
```
OK
```

Create

Create a user. To create a user, use the same parameters as update but leave the UserId empty.

Request:

Copy

http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_USERS_TBL&UserId=&FirstName=Aron&LastName=Szilagyi&Name=Aron Szilagyi&DefaultLanguage=0&PINNumber=********&StartDateValid=false&StartDate=15-4-2013T0:0:0&ExpiryDateValid=false&ExpiryDate=15-4-2013T0:0:0&UserArea=2147483647&UserAreaGroup=2147483647&AccessLevel0=14&DisableUser=false&Showagreetingmessagetouser=true&GoDirectlyToTheMenuOnLogin=true&UserCanAcknowledgeAlarmMemory=false&ShowAlarmMemoryOnLogin=false&TurnOffthePrimaryAreaIfUserHasAccessOnLogin=false&TurnOfftheUserAreaonLoginifUserhasaccess=false&AcknowledgeSystemTroubles=false&Userhassuperrightsandcanoverrideantipassback=false&UserOperatesADAFunction=false&UserLoiterExpiryCountEnabled=false&UserCanLogInRemotely=false&UserisaDuressUser=false&RearmAreaInStayMode=false&DualCustodyMaster=false&DualCustodyProvider=false&TreatUserPinXXX1AsDuress=false&ReportingId=1&PhoneExtension=&CompanyName=

Response:
Copy
```
OK
```

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 user.

Request:

Copy

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

Response:
Copy
```
OK
```

Parameters

Parameter

Display Name

Default Value

Notes

UserId

Database ID

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

FirstName

First Name

Installer

Maximum length is 32 characters.

LastName

Last Name

Maximum length is 32 characters.

Name

Display Name

Installer

Maximum length is 32 characters.

DefaultLanguage

Default Language

The settings are:

Value	Setting
0	English
1	French
2	Spanish
3	Estonian
4	Italian
5	Polish
6	Greek
7	Russian
8	Romanian
9	Swedish
10	Finnish
11	Norwegian
12	Czech
13	Dutch
14	German

PINNumber

PIN Code

********

CardFac*

Facility Number

CardNum*

Card Number

StartDateValid

Start Date Enabled

false

StartDate

Start Date

15-4-2013T0:0:0

ExpiryDateValid

Expiry Date Enabled

false

ExpiryDate

Expiry Date

15-4-2013T0:0:0

UserArea

User Area

2147483647

UserAreaGroup

2147483647

This option is not used.

AccessLevel*

Access Levels

DisableUser

Disable User

false

Showagreetingmessagetouser

Show A Greeting Message To User

true

GoDirectlyToTheMenuOnLogin

Go Directly To The Menu On Login

true

UserCanAcknowledgeAlarmMemory

User Can Acknowledge Alarm Memory

false

ShowAlarmMemoryOnLogin

Show Alarm Memory On Login

false

TurnOffthePrimaryAreaIfUserHasAccessOnLogin

Turn Off The Primary Area If User Has Access On Login

false

TurnOfftheUserAreaonLoginifUserhasaccess

Turn Off The User Area On Login If User Has Access

false

AcknowledgeSystemTroubles

Acknowledge System Troubles

false

Userhassuperrightsandcanoverrideantipassback

User Has Super Rights And Can Override Antipassback

false

UserOperatesADAFunction

User Operates Extended Door Access Function

false

UserLoiterExpiryCountEnabled

User Loiter Expiry Count Enabled

false

UserCanLogInRemotely

false

This is a legacy option that has no effect.

UserisaDuressUser

User Is A Duress User

false

RearmAreaInStayMode

Rearm Area In Stay Mode

false

DualCustodyMaster

Dual Custody Master

false

DualCustodyProvider

Dual Custody Provider

false

TreatUserPinXXX1AsDuress

Treat User PIN +1 As Duress

false

ReportingId

Reporting ID

CredentialType*

Credential Type

none

CredentialDisabled*

Disable

false

Credential*

Credential

none

CredentialStartDate*

NotSet

This option is not used.

CredentialStartDateValid*

false

This option is not used.

CredentialExpiryDate*

NotSet

This option is not used.

CredentialExpiryDateValid*

false

This option is not used.

PhoneExtension

Phone Extension

CompanyName

Company Name

DateOfLastPINUpdate

NotSet

UserDaysUntilPINExpiry

PIN Expiry Time

For Never, set value to 0. Available settings are 30, 60, 90, 180 and 365 days.

TraceUser

false

This option is not used.

CondoArmOnly

false

This option is not used.

CondoViewMenu

false

This option is not used.

CondoDisarmOnBadge

false

This option is not used.

CondoArmOnTripleBadge

false

This option is not used.

CondoBadgeLatchToggle

false

This option is not used.

CondoBadgeLatch2Hours

false

This option is not used.

CondoBadgeLatch4Hours

false

This option is not used.

CondoBadgeLatch8Hours

false

This option is not used.

ElevatorVIP

false

This option is not used.

ElevatorVertigo

false

This option is not used.

ElevatorSplitGroup

false

This option is not used.

ElevatorVertigo2

false

This option is not used.

ElevatorCartService

false

This option is not used.

ElevatorCIMOverride

false

This option is not used.

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