API - Groups

July 10th, 2008

Groups APIs

Getting all groups

Nooked supports Groups of users on our platform - any Nooked users can belong to many groups. The list of groups is made available via API as a paging Atom feed. These Atom feeds will only contain a limited number of results (defaults to 25 for groups). However, if you need more, the Atom feed returned contains elements that point to the URL of the first/last/next/previous pages (also Atom feeds). JSON versions of these feeds are also supported.

The 'alternate' link element in each feed entry links to another Atom feed which contains entries for each member (user) of the group

URL

https://api.nooked.com/v1/groups.atom or https://api.nooked.com/v1/groups.json

Authentication

No authentication data is needed.

Request

Send a GET request to this URL with no parameters:

Response

Platform responds with a HTTP Status code indicating the success of the request:

  • 200 OK - The body of the response message will contain an Atom or JSON feed.

Getting a list of members of a group

Use the Groups API to get a list of groups (see above) and GET the Atom feed for a particular Group. The entries in the returned feed represent users in the group. Each entry contains a attribute that points to the users public AtomPub Service Document (which in turn contains references to the users feeds).

The list of groups is made available via API as a paging Atom feed. These Atom feeds will only contain a limited number of results (defaults to 25 for groups). However, if you need more, the Atom feed returned contains elements that point to the URL of the first/last/next/previous pages (also Atom feeds)

URL

https://api.nooked.com/v1/groups/1.atom or https://api.nooked.com/v1/groups/1.json

Authentication

No authentication data is needed.

Request

Send a GET request to this URL with no parameters:

Response

Platform responds with a HTTP Status code indicating the success of the request:

  • 200 OK - The body of the response message will contain an Atom or JSON feed.
Posted by joshea Filed in Documentation

Sorry, comments are closed for this article.