Permissions

Permissions information is included in list responses to indicate the write operations that the user is allowed to perform. If the API does not support any write operations, then permissions information is not returned.

Parameters

  • canCreate: Indicates whether a create operation is allowed. Values are true/false. If the create operation is not supported by the API, then this parameter is not returned.
  • canUpdate: Indicates whether an update operation is allowed. Values are true/false. If the update operation is not supported by the API, then this parameter is not returned.
  • canDelete: Indicates whether a delete operation is allowed. Values are true/false. If the delete operation is not supported by the API, then this parameter is not returned.
  • role: Type of role of the user performing the request. Values are administrator/supervisor.
  • departmentAdmin: Indicates whether or not an administrator is restricted to specific departments only (true), or is a global administrator (false). Values are true/false.

Example Get Response

Code Snippet
Copy<permissionInfo>
    <canCreate>false</canCreate>
    <canUpdate>true</canUpdate>
    <canDelete>false</canDelete>
    <role>Administrator</role>
    <departmentAdmin>false</departmentAdmin>
</permissionInfo>