...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Host: voot.surfconext.nl GET /me/groups HTTP/1.1 Response HTTP/1.1 200 OK Content-Type: application/json [ { "filteredid" : false"urn:collab:group:uniharderwijk.nl:cis", "itemsPerPagedisplayName" : 2, "sortedcis": true, "startIndexdescription" : 0null, "totalResultssourceID" : 2, "updatedSinceUniHarderwijk": false, "entrymembership" : [ { "descriptionbasic" : "Private law working group 2014Q2",member" } }, { "id" : "urn:collab:group:surfteams.nl:nl:surfnet:diensten:privat_law_2014Q2myexampleteam", "titledisplayName" : "Private law 2014Q2MyExampleTeam", "voot_membership_role""description" : "admin" This team is an }, {example", "descriptionsourceID": null, "id": "urn:collab:group:surfteams.nl:nl:surfnet:diensten:students2014SURFteams", "titlemembership" : "Students started in 2014",{ "voot_membership_role""basic" : "memberadmin" } } ] } |
Get group information
Group information is taken from SURFconext Teams. This call will only return the group's information if the user is a member of this group.
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Host: voot.surfconext.nl GET /me/groups/urn:collab:group:surfteams.nl:nl:surfnet:diensten:abc_helpdesk_administrators HTTP/1.1 Response HTTP/1.1 200 OK Content-Type: application/json { "filteredid" : false, "itemsPerPage": 1"urn:collab:group:surfteams.nl:nl:surfnet:diensten:abc_helpdesk_administrators", "sorteddisplayName": false, "startIndex": 0, "totalResults": 1, "updatedSince": false"ABC helpdesk administrators", "entrydescription": [ { "description": "Administrators of the ABC helpdesk service.", "idsourceID" : "nl:surfnet:diensten:abc_helpdesk_administratorsSURFteams", "titlemembership" : "ABC helpdesk administrators",{ "voot_membership_role""basic" : "admin" } ] } |
Request parameters
The calls can have three parameters:
startIndex
offset as the start for giving back results.- count
number of results to be returned. sortBy
key for sorting groups. Possible values:id,
title,
description.
note that the members of a group cannot be sorted
sorting MUST be performed beforestartIndex
andcount
Code Block | ||||
---|---|---|---|---|
| ||||
/me/groups/urn:collab:group:surfteams.nl:nl:surfnet:diensten:privat_law_2014Q2?startIndex=3&count=2 /me/groups?sortBy=title |
Response parameters
...
Errors
Handling failures of OAuth (Bearer) authentication are handled as described in [RFC 6750]. This will involve sending the WWW-Authenticate
header if something is wrong, for example an invalid OAuth 2.0 access token will result in the following response:
...