Mike.robski: 1 revision: Release 91

2014-03-11T17:13:41Z

1 revision: Release 91

Mike.robski at 17:13, 11 March 2014

2014-03-11T17:13:01Z

New page

= 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.
__TOC__

== Request ==
<code>GET /roles</code>

==== Request Parameters ====
None

=== URI Parameters ===
None

=== Request Headers ===
None

== Response ==

=== 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

=== Response Body ===
<nowiki>
{
"list": [
"sitecontrol_account_owner",
"sitecontrol_technical_admin",
...
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/roles", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
None

== See Also ==
* [[Account]]
* [[Accounts-accountId-users-userName-roles:GET|GET /accounts/{accountId}/users/{userName}/roles]]
* [[Accounts-accountId-users-userName-roles:PUT|PUT /accounts/{accountId}/users/{userName}/roles]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Miscellaneous APIs]]

Roles:GET - Revision history

Mike.robski: 1 revision: Release 91

Mike.robski at 17:13, 11 March 2014