Latest revision as of 11:13, 11 March 2014

[edit] GET /roles

Returns a list of available roles. Note that this will only include the roles available for users tied to a specific account; Agent-type roles (that have global access or access to an entire franchise) will not appear in this list.

[edit] Request

GET /roles

[edit] Request Parameters

None

[edit] URI Parameters

None

[edit] Request Headers

None

[edit] Response

[edit] Status Code

200 OK

Success

304 Not changed

The list of users hasn't changed since the last request; the client should use its locally cached copy instead.

401 Unauthorized

The authorization header contained an invalid value

[edit] Response Body

{
  "list": [
    "sitecontrol_account_owner",
    "sitecontrol_technical_admin",
    ...
  ],
  "links": [
    {"href": "https://api.hostway.com/roles", "rel": "self"}
  ]
}
 

[edit] Parameters

None

[edit] See Also

• Account
• GET /accounts/{accountId}/users/{userName}/roles
• PUT /accounts/{accountId}/users/{userName}/roles
• Common Features