Reviews¶
Added in version 0.9.0: This resource endpoint.
Resource description¶
The review resource contains the following public fields:
Field |
Type |
Description |
---|---|---|
id |
number |
The unique ID of the review object |
submission |
string |
The unique code of the submission the review relates to |
user |
string |
The |
text |
string |
The review’s text |
score |
number |
The review’s score |
created |
datetime |
The review’s creation timestamp |
updated |
datetime |
The review’s last change timestamp |
answers |
list |
The question answers given by the reviewer. |
Endpoints¶
- GET /api/events/{event}/reviews¶
Returns a list of all reviews the authenticated user/token has access to. For organisers, this includes all reviews on the event except for talks the requesting user has submitted. For reviewers it will include all reviews they have access to, which may vary depending on track permissions and the current review phase.
Example request:
GET /api/events/sampleconf/reviews HTTP/1.1 Accept: application/json, text/javascript
Example response:
HTTP/1.1 200 OK Vary: Accept Content-Type: application/json { "count": 1, "next": null, "previous": null, "results": [ { "id": 23, "submission": "ABCDE", "user": {"name": "Jane", "email": "jane.doe@gmail.com"}, "text": "This is a good submission", "score": 10, "created": "2019-05-04T23:40:00", "updated": "2019-05-04T23:40:00"; "answers": [ { "id": 1, "question": {"id": 1, "question": {"en": "How much would you like to see this talk?"}, "required": false, "target": "review", "options": []}, "answer": "11", "answer_file": null, "review": 23, "person": null, "options": [] } ] } ] }
- Parameters:
event – The
slug
field of the event to fetch
- Query Parameters:
page – The page number in case of a multi-page result set, default is 1
submission__code – Filter reviews by the code of their submission
- GET /api/events/(event)/reviews/{id}¶
Returns information on one review, identified by its ID.
Example request:
GET /api/events/sampleconf/reviews/23 HTTP/1.1 Accept: application/json, text/javascript
Example response:
HTTP/1.1 200 OK Vary: Accept Content-Type: application/json { "id": 23, "submission": "ABCDE", "user": {"name": "Jane", "email": "jane.doe@gmail.com"}, "text": "This is a good submission", "score": 10, "created": "2019-05-04T23:40:00", "updated": "2019-05-04T23:40:00"; "answers": [ { "id": 1, "question": {"id": 1, "question": {"en": "How much would you like to see this talk?"}, "required": false, "target": "review", "options": []}, "answer": "11", "answer_file": null, "review": 23, "person": null, "options": [] } ] }
- Parameters:
event – The
slug
field of the event to fetchcode – The
id
field of the review to fetch
- Status Codes:
200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested event does not exist or you have no permission to view it.