REL documentation
master apiroles (http://api.3plcentral.com/rels/master/apiroles)
Resource:
Collection: of apirole
C# Rel Const:
Rels.MasterSvc.ApiRoles
URI template:
api/roles{?pgsiz,pgnum,rql,sort}
Obtain URI from:
Billboard
Get a list of ApiRoles
Success status: 200
Name Data Type Description
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
Type Description
TotalResults int
ResourceList IList<Master.Models.ApiRole>
Role string
Policies IEnumerable<Master.Models.ApiPolicy>
Service string valid service name or * (meaning all services)
Resource string valid resource name or * (meaning all resources)
HttpMethods IEnumerable<string> Valid values : GET, PUT, POST, DELETE, * (meaning all HTTP verbs)
Unauthorized bool
Links IList<WebApi.Hal.Link>
- edit If Link.Name contains 'Disallow: ' with DELETE in the list, then policies for this role cannot be deleted because it is in use.
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/master/apirole": [
      {
        "role": "str",
        "policies": [
          {
            "service": "str",
            "resource": "str",
            "httpMethods": [
              "str"
            ],
            "unauthorized": true
          }
        ]
      }
    ]
  }
}
Add an apiRole to the collection of apiRoles
Success status: 200
none
Type Description
Role string
Policies IEnumerable<Master.Models.ApiPolicy>
Service string valid service name or * (meaning all services)
Resource string valid resource name or * (meaning all resources)
HttpMethods IEnumerable<string> Valid values : GET, PUT, POST, DELETE, * (meaning all HTTP verbs)
Unauthorized bool
Sample content-type: application/hal+json
 
{
  "role": "str",
  "policies": [
    {
      "service": "str",
      "resource": "str",
      "httpMethods": [
        "str"
      ],
      "unauthorized": true
    }
  ]
}
Type Description
Role string
Policies IEnumerable<Master.Models.ApiPolicy>
Service string valid service name or * (meaning all services)
Resource string valid resource name or * (meaning all resources)
HttpMethods IEnumerable<string> Valid values : GET, PUT, POST, DELETE, * (meaning all HTTP verbs)
Unauthorized bool
Links IList<WebApi.Hal.Link>
- edit If Link.Name contains 'Disallow: ' with DELETE in the list, then policies for this role cannot be deleted because it is in use.
Sample accept: application/hal+json
{
  "role": "str",
  "policies": [
    {
      "service": "str",
      "resource": "str",
      "httpMethods": [
        "str"
      ],
      "unauthorized": 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.