...
These are the expected status codes returned by the service - in . In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
...
An example of fetching all users in group.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 0832C85F-E532-472F-92E1-287995CE3726 | ID of the group |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
[ { "Id": "c699d96a-a63b-4087-bc04-c429de15dd53", "UserName": "joeb", "Email": "joeb@unknown.net", "FirstName": "Joe", "LastName": "Bloggs", "Phone": "(09)-555-999", "LastLogIn": null, "Enabled": true, "IsExternal": false, "Self": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53", "Links": [ { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/mailmessages", "Rel": "MailMessages" } ] }, { "Id": "35f32f5b-a69e-4b16-a59c-ebfb988b4bf8", "UserName": "janed", "Email": "janed@unknown.net", "FirstName": "Jane", "LastName": "Doe", "Phone": "(09)-555-999", "LastLogIn": null, "Enabled": true, "IsExternal": false, "Self": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8", "Links": [ { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/mailmessages", "Rel": "MailMessages" } ] } ] |
Status Code
200 - OK
An example of fetching a set of users by first name belonging to the group, by using the ODATA $filter query parameter.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 0832C85F-E532-472F-92E1-287995CE3726 | ID of the group |
$filter | FirstName eq 'Jane' | The ODATA $filter parameter, this query parameter should be url encoded i.e. $filter=FirstName%20eq%20'Jane'. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
[
{
"Id": "35f32f5b-a69e-4b16-a59c-ebfb988b4bf8",
"UserName": "janed",
"Email": "janed@unknown.net",
"FirstName": "Jane",
"LastName": "Doe",
"Phone": "(09)-555-999",
"LastLogIn": null,
"Enabled": true,
"IsExternal": false,
"Self": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8",
"Links": [
{
"Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/password",
"Rel": "ChangePassword"
},
{
"Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/global",
"Rel": "GlobalPermissions"
},
{
"Title": "Group Memberships",
"Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/groups",
"Rel": "Groups"
},
{
"Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/notifications",
"Rel": "Notifications"
},
{
"Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/projects",
"Rel": "ProjectPermissions"
},
{
"Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/mailmessages",
"Rel": "MailMessages"
}
]
}
]
|
Status Code
200 - OK
...
These are the expected status codes returned by the service - in . In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
...
Sets the users who are members of this group.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 0832C85F-E532-472F-92E1-287995CE3726 | ID of the group |
Request Body
Code Block | ||
---|---|---|
| ||
{ "Items": [ { "Id": "c699d96a-a63b-4087-bc04-c429de15dd53" }, { "Id": "35f32f5b-a69e-4b16-a59c-ebfb988b4bf8" } ] } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
[ { "Id": "c699d96a-a63b-4087-bc04-c429de15dd53", "UserName": "joeb", "Email": "joeb@unknown.net", "FirstName": "Joe", "LastName": "Bloggs", "Phone": "(09)-555-999", "LastLogIn": null, "Enabled": true, "IsExternal": false, "Self": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53", "Links": [ { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/mailmessages", "Rel": "MailMessages" } ] }, { "Id": "35f32f5b-a69e-4b16-a59c-ebfb988b4bf8", "UserName": "janed", "Email": "janed@unknown.net", "FirstName": "Jane", "LastName": "Doe", "Phone": "(09)-555-999", "LastLogIn": null, "Enabled": true, "IsExternal": false, "Self": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8", "Links": [ { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/mailmessages", "Rel": "MailMessages" } ] } ] |
Status Code
200 - OK
...