1.3 KiB
1.3 KiB
GET
/api/reviews/
Response Codes: 200
Response Format: JSON
Example response:
[
{
"username": "bob",
"rating": 4.5,
"title": "All fields",
"content": "This user review contains all required and allowed fields!",
"id": "a1b2c3",
"timestamp": "2024-09-12T03a:55:23.830Z"
},
{
"username": "sarah",
"rating": 4.5,
"title": "Only a title",
"content": null,
"id": "e1f2g3",
"timestamp": "2024-09-12T03a:56:23.830Z"
},
{
"username": "phillip",
"rating": 4.5,
"title": null,
"content": null,
"id": "h1i2j3",
"timestamp": "2024-09-12T03a:57:23.830Z"
}
]
/api/reviews/:id
Response Codes: 200, 404, 400
Response Format: JSON
Example requests and responses:
Good Request
GET /api/reviews/a1b2c3
Server Response (200):
{
"username": "bob",
"rating": 4.5,
"title": "All fields",
"content": "This user review contains all required and allowed fields!",
"timestamp": "2024-09-12T03a:55:23.830Z"
}
Bad Request
GET /api/reviews/a
Server Response (400):
{
error: {
"type": "requestError",
"message": "review id must be 6 characters"
}
}