Rel doc - Rel

POST

create a customizable role with policies; it is an error to create a role with policies less restrictive than those of the logged-in user
Success status: 201; ETag response header supplied

none

	Type	Description
Name	string
Description	string
CreationDate	DateTime	Set by System to coordinated universal time upon creation
LastModifiedDate	DateTime	Set by System to coordinated universal time upon update
CreatedByUserIdentifier	Generic.Models.UserIdentifier	Set by System to logged-in user upon creation
Name	string
Id	int
LastModifiedByUserIdentifier	Generic.Models.UserIdentifier	Set by System to logged-in user upon update
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 content-type: 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
    }
  ]
}

	Type	Description
Name	string
Description	string
CreationDate	DateTime	Set by System to coordinated universal time upon creation
LastModifiedDate	DateTime	Set by System to coordinated universal time upon update
CreatedByUserIdentifier	Generic.Models.UserIdentifier	Set by System to logged-in user upon creation
Name	string
Id	int
LastModifiedByUserIdentifier	Generic.Models.UserIdentifier	Set by System to logged-in user upon update
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
Links	IList<WebApi.Hal.Link>
	- edit

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.