REL documentation
uiproperties systemrole (http://api.3plcentral.com/rels/uiproperties/systemrole)
Resource:
list of rights, immutable
C# Rel Const:
Rels.UiPropertySvc.SystemRole
URI template:
systemroles/{id}
Obtain URI from:
/rels/uiproperties/systemrolesummaries
Get an immutable role with policies
Success status: 200; Response is cacheable
Name (* = required) Data Type Description
id * int role id
Type Description
Name string
Description string
CreationDate DateTime
LastModifiedDate DateTime
CreatedByUserIdentifier Generic.Models.UserIdentifier
Name string
Id int
LastModifiedByUserIdentifier Generic.Models.UserIdentifier
Name string
Id int
Scope Common.Enum.UiRoleScopeEnum Valid scopes for UI Roles
- 1: Customer
- 2: Warehouse
- 3: SuperAdmin
HasOutOfScopeRights bool
Policies IEnumerable<Generic.Models.Policy>
Anchor string can be either a fully qualified right, or a right-truncated right regarded as a matching collection of fully qualified rights
Granted bool
Sample accept: application/hal+json
{
  "name": "str",
  "description": "str",
  "creationDate": "2016-12-25T23:00:00",
  "lastModifiedDate": "2016-12-25T23:00:00",
  "createdByUserIdentifier": {
    "name": "str",
    "id": 2
  },
  "lastModifiedByUserIdentifier": {
    "name": "str",
    "id": 2
  },
  "scope": 1,
  "hasOutOfScopeRights": true,
  "policies": [
    {
      "anchor": "str",
      "granted": true
    }
  ]
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.