Skip to main content

Votes

Votes

Vote on a Post

  • Authentication: Required

When casting a vote upon a post, the vote is registered under the current authenticated user. Impersonate another user to vote on behalf of them.

POST /api/v1/posts/{number}/votes

Parameters

NameTypeDescription
numbernumberRequired. The number of the post to vote on.

Example

POST <baseURL>/api/v1/posts/47/votes

Response

200 OK
---
{}

Remove Vote from a Post

  • Authentication: Required

When removing the vote from a post, the vote is removed from the current authenticated user. Impersonate another user to remove votes on behalf of them.

DELETE /api/v1/posts/{number}/votes

Parameters

NameTypeDescription
numbernumberRequired. The number of the post to have the vote removed.

Example

DELETE <baseURL>/api/v1/posts/47/votes

Response

200 OK
---
{}

List Votes of a Post

  • Authentication: Required
  • Required Role: Collaborator or Administrator
GET /api/v1/posts/{number}/votes

Parameters

NameTypeDescription
numbernumberRequired. The number of the post to list the votes.

Example

GET <baseURL>/api/v1/posts/47/votes

Response

200 OK
---
[
{
"createdAt":"2018-11-28T12:18:26.95415Z",
"user":{
"id":1234,
"name":"Jon Snow",
"email":"jon.snow@got.com"
}
},
{
"createdAt":"2018-11-28T15:45:45.612288Z",
"user":{
"id":5678,
"name":"Arya Stark",
"email":"arya.stark@got.com"
}
}
]