Jump to >

Watched Review Group Resource

Lists and manipulates entries for review groups watched by the user.

These are groups that the user has starred in their Dashboard. This resource can be used for listing existing review groups and adding new review groups to watch.

Each item in the resource is an association between the user and the review group. The entries in the list are not the review groups themselves, but rather an entry that represents this association by listing the association’s ID (which can be used for removing the association) and linking to the review group.

Details

Name watched_review_group
URI /api/users/{username}/watched/review-groups/
Token Policy ID watched_review_group
HTTP Methods
  • DELETE - Deletes a watched review group entry.
  • GET - Returned an HTTP 302 Found pointing to the review group being watched.
Parent Resource Watched Review Group List Resource
Child Resources None
Anonymous Access Yes, if anonymous site access is enabled

HTTP DELETE

Deletes a watched review group entry.

This is the same effect as unstarring a review group. It does not actually delete the review group, just the entry in the list.

Errors

100 - Does Not ExistHTTP 404 - Not Found Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized You are not logged in
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden OAuth2 token access for this resource is prohibited.

HTTP GET

Returned an HTTP 302 Found pointing to the review group being watched.

Rather than returning a body with the entry, performing an HTTP GET on this resource will redirect the client to the actual review group being watched.

Clients must properly handle HTTP 302 Found and expect this redirect to happen.

Errors

100 - Does Not ExistHTTP 404 - Not Found Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized You are not logged in
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden OAuth2 token access for this resource is prohibited.