Operators

Table Name: GXT_OPERATORS_TBL

List Names

Request a name list of operators.

• Request:

  Copy

  http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Session&SubType=ListOperators&str=

• Response:

  Copy

  0=Administrator&1=Installer&16=TesterName

List Usernames

Request a username list of operators.

• Request:

  Copy

  http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Session&SubType=ListOperatorNames

• Response:

  Copy

  0=admin&1=installer&16=testerUserName

Detail

Request the details of a specific operator.

• Request:

  Copy

  http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Session&SubType=GetOperator&OperatorId=<OperatorId>

• Response:

  Copy

  OperatorId=0&UserName=admin&Name=Administrator&Email=unknown&Timeout=3600&Password=d033e22ae348aeb5660fc2140aec35850c4da997&Language=en&Role=3&TimeoutEnabled=false

Update

Update a specific operator.

• Request:

  Copy

  http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Session&SubType=SaveOperator&OperatorId=17&action=update&Name=Test&UserName=test&Timeout=3600&Password=da39a3ee5e6b4b0d3255bfef95601890afd80709&Language=en&Email=&Role=1&TimeoutEnabled=true

• Response:

  Copy

  OK

Create

Create an operator. To create an operator, use the same parameters as update but leave the OperatorId empty.

• Request:

  Copy

  http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Session&SubType=SaveOperator&OperatorId=&action=insert&Name=TestName&UserName=TestUserName&Timeout=3600&Password=da39a3ee5e6b4b0d3255bfef95601890afd80709&Language=en&Email=&Role=1&TimeoutEnabled=true

• Response:

  Copy

  OK

Reset the Admin Operator

When the controller is defaulted you must reset the default admin operator before the controller will accept a login request. This command can be submitted prior to establishing a session.

• Request:

  Copy

  http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Session&SubType=SaveOperator&OperatorId=&action=resetadmin&Name=Test&UserName=test&Timeout=3600&Password=da39a3ee5e6b4b0d3255bfef95601890afd80709&Language=en&Email=&Role=1&TimeoutEnabled=true

• Success Response:

  Copy

  OK

• Errors:

  • If the operator cannot be created the following error will be returned:

    Copy

    FAIL
    
    Corrective action: Check that the request is correctly formatted.

  • If the operator cannot be created because the name field is empty the following error will be returned:

    Copy

    FAIL - Operator Name/Username must not be empty
    
    Corrective action: Check that the request contains the correct name details and is correctly formatted.

  • If the operator cannot be created because the name is too long the following error will be returned:

    Copy

    FAIL - Operator Name/Username has invalid length

Delete

Delete a specific Operator.

• Request:

  Copy

  http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Session&SubType=DeleteOperator&OperatorId=<OperatorId>

• Response:

  Copy

  OK

Parameters

Parameter	Display Name	Default Value	Notes
OperatorId	Database ID
Name	Name
Username	Username		Must be 1-40 characters long.
Password	Password
Role	Role	1	The following roles are available: Value Role 1 User 2 Master 3 Installer
Language	Language	en	The following languages are available: Code Language en English cs Czech nl Dutch et Estonian fi Finnish fr French de German el Greek it Italian nb Norwegian pl Polish ro Romanian ru Russian es Spanish sv Swedish
TimeoutEnabled	Enable Operator Timeout	false
Timeout	Operator Timeout	60	Cannot be set to less than 60 seconds.