Classify a review

A verified reviewer is able to classify the review and mark it as rejected or approved as long as the request is in the awaiting_review state.

{info} Classifying a request will send an email with a message (optional) to the requesting researcher. The corresponding message will also be attached as a comment to the request.

• Headers
• Success Response
• Error Response

Headers

The API requires a header Accept to be submitted with the request:

{
    "Accept": "application/json",
    "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3M..." 
}

Data constraints

{
    "message": "text"
}

Success Responses

Condition : User must be a reviewer.

Code : 200 Okay

Content example : Response will reflect back the updated review's request . The request is the active request which is the latest created revision of the request.

{
  "id": "01e1d8ae-6826-4d63-abd8-4b965177f7c4",
  "status": "awaiting_approval",
  "request": {
    "id": "50b17bb5-9270-4bfd-8f44-8206960c1bcb",
    "title": "Hello Sunshine Exposure generation",
    "author": {
      "firstName": "Jeroen",
      "lastName": "Boumans",
      ...
    },
    "coauthors": [
      "Jan Janssen"
    ],
    "has_informed_coauthors": 0,
    "has_agreed_terms": 0,
    "is_student": 0,
    "student_details": null,
    "hypotheses": null,
    "background": null,
    "design": null,
    "analyses": null,
    "timeline": null,
    ...
  },
  "revisions": [
    {
        "id": "50b17bb5-9270-4bfd-8f44-8206960c1bcb",
        "title": "Hello Sunshine Exposure",
        "author": {
        ...
    }
  ],
  "created_at": "2020-07-23T16:15:45.000000Z",
  "updated_at": "2020-07-23T16:15:45.000000Z"
}

Error Responses

Condition : If the current user does not have the role reviewer attached and/or the request is not in awaiting_review state.

Code : 403 Unauthorized

{
    "message": "The review cannot be classified at the current status (rejected) or current user."
}