Jump to >

Archived Review Request List Resource

Added in 2.5

List and manipulate entries for review requests archived by the user.

These are requests that the user has archived. This resource can be used for adding and removing archived review requests.

Each item in the resource is an association between the user and the review request.

Details

Name archived_review_requests
URI /api/users/{username}/archived-review-requests/
Token Policy ID archived_review_request
HTTP Methods
  • POST - Mark a review request as archived.
Parent Resource User Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

HTTP POST

Mark a review request as archived.

The ID of the review reqiest must be passed as object_id, and will store that review request in the list.

Request Parameters

object_idString Required

The ID of the object to hide.

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
105 - Invalid Form DataHTTP 400 - Bad Request One or more fields had errors