Maintain staff records. A staff record defines a person that can login to the Point of Sale and perform transactions.
Input Arguments
Arg# | Name | Datatype | Description |
8 | string | Required. Must be "retailmax.elink.staff.edit" | |
11 | Action | char | Set to 'I' to insert a new record |
100 | Tid | number | Specifies the unique internal number allocated to this staff member. This value is required for edit. It will be ignored for an insert operation and should not be supplied as the Point of Sale allocates a unique number. |
101 | Name | string | The name of the staff member. This name is the login name and must be unique across active staff members. |
102 | Active | string | |
103 | Password | string | The desired password for this staff member. Passwords are processed and obscured before being stored into the database. |
107 | Barcode | string | A barcode that when scanned will cause this staff member to be logged in |
110 | Handness | string | |
130 | PrivateEmail | string | The persons private home contact email address. |
131 | WorkEmail | string | The persons official work email address |
300 | DomainUser | string | |
301 | DomainName | string | |
500 | GrantRole | string | Grant a security role to this staff member. This field may be present multiple times. All staff members are automatically granted the role "All Staff" (sometimes called 'everybody') |
501 | GrantRight | string | Grant individual security rights to this staff member. This field may be present multiple times. |
502 | RevokeRole | string | Revoke a security role from a staff member. This field may only be specified for edit operations (Field 11, Action = 'E') |
503 | RevokeRight | string | Revoke individual security rights from a staff member. This field may only be specified for edit operations (Field 11, Action = 'E'). If this staff member is granted a right, this field will not remove the right - this field is only used to remove directly granted security rights. |
Notes
Writing to the password field for a staff member also resets the failed login count to zero and removes the disabled flag. Overall this makes the staff record available to login and be used.
Values for individual rights can be found under Reference Data
Examples
Creating a simple HTML form to enter new staff members. This is an example only, you would not typically use the API like this as it is not a nice user experience.
<form action="POST" method="/GNAP/DATI"> <input type='hidden' name='f8' value='retailmax.elink.staff.edit'> <input type='hidden' name='f11_B' value='I'> Name: <input size=12 name='f101'><br> Password: <input size=12 name='f103'><br> <input type='submit' value='Save'> </form>
Changing the active flag to 0 (disabled) for staff member 123
/gnap/DATI?8=retailmax.elink.staff.edit&102=0&9=f100,0,123