REL documentation
uiproperties systemrolesummaries (http://api.3plcentral.com/rels/uiproperties/systemrolesummaries)
Resource:
collection: system role summaries
C# Rel Const:
Rels.UiPropertySvc.SystemRoleSummaryList
URI template:
systemrolesummaries{?scope}
Obtain URI from:
Billboard
get a list of all system role summaries (name, description) having policies at least as restrictive as those of the logged-in user
Success status: 200; Response is cacheable
Name Data Type Description
scope Common.Enum.UiRoleScopeEnum Scope of system roles to return - Defaults to Warehouse
- Customer
- Warehouse
- SuperAdmin
Type Description
ResourceList IList<UIProperty.Models.SystemRoleSummary>
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
Links IList<WebApi.Hal.Link>
- /rels/uiproperties/systemrole
Sample accept: application/hal+json
{
  "_embedded": {
    "item": [
      {
        "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
      }
    ]
  }
}

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.