|
|
APIServer.Role.UpdateRole
| Field | Variable | ...as | Description |
|---|---|---|---|
| RoleName | UpdateData | Input | The name of the role. This must be unique for the site (mandatory). |
| RoleDescription | UpdateData | Input | A textual description of the role (optional). |
| RoleComment | UpdateData | Input | Comment field for the role (optional). |
| RolePriority | UpdateData | Input | Numeric field - indicates the "importance" of the role. Used for situations where a session is authorized by more than one role and a choice between the roles are necessary. The higher the number, the more important the role is. (optional) |
| RoleSiteKey | UpdateData | Input | The site which the role belongs to. (mandatory) |
| RoleFolderListID | UpdateData | Input | The folder list to be used for sessions authorized by this role. (mandatory) |
| RoleSurrogate | UpdateKey | Input | The unique identification of the role that should be updated. (mandatory) |
| NumberOfErrors | Error | Output | The number of errors encountered and reported in the ErrorArray. |
| ErrorMessage | ErrorArray(20) | Output | A description of an error, which has occurred during either validation or create. |
Validates and updates an existing role.
If the validation fails the field Environment<*Returned status> is set to a non-successful value and for each error an error message can be written in the ErrorArray output variable. The output field NumberOfErrors is set to the number of errors returned in ErrorArray.
Online documentation - WebsydianExpress v3.5