Person
#
Prerequisites- To use the Social Feed API, you must first authenticate yourself and receive a token. See the Authentication documentation for more information on how to do this.
- Person endpoints need a
personId
as path parameter. A person belongs to an organization, so check the organization and getpersonId
. See the Organization documentation for more information on how to do this.
#
RequestsPerson resource provides the following endpoints:
Path | HTTP Method | Description |
---|---|---|
v1/persons/ | GET | View All persons of current user's organization |
v1/persons/{personId} | GET | View a specified person |
v1/persons/{personId} | PUT | Update an existing person |
v1/persons/{personId} | DEL | Delete an existing person |
v1/persons/{personId}/posts | GET | View All posts created by a specified person |
v1/persons/{personId}/posts | POST | Create a new post for a specified person |
v1/persons/{personId}/posts/{postId} | DEL | Delete an existing post |
v1/persons/{personId}/posts/{postId} | PUT | Update an existing post content |
v1/persons/{personId}/posts/{postId} | GET | View a specified post for a specified person |
v1/persons/{personId}/posts/pages | GET | View paginated posts of a specified organization |
v1/persons/{personId}/posts/find | POST | View Information of specified list of post's ID |
v1/persons/{personId}/posts/{postId}/likes | PUT | Increase/decrease number of likes of a specified post |
v1/persons/{personId}/posts/{postId}/comments | POST | Create a new comment of a specified post |
v1/persons/{personId}/comments/{commentId} | PUT | Update an existing comment |
v1/persons/{personId}/comments/{commentId} | DEL | Delete an existing comment |
v1/persons/{personId}/comments/{commentId}/likes | PUT | Increase/decrease number of likes of a specified comment |
See the API documentation documentation for more information on these endpoints
#
Example RequestThe following example curl command demonstrates how to create a new post for a specified person.
#
Responses- If successful, the operation responds with HTTP status code 2XX.
- If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.
- If the specified person (gets or) updates post or comments of another person, the operation returns the
Access is denied
error. - If the specified person does not belong to the authenticating user organization, the operation returns the
Access is denied
error. - If the authenticating user or the specified person, post, category and comment does not exist, the operation returns the
Not found
error. - If the specified person likes a post or comment for more than one time, the operation returns the
Conflict
error. - If the Authorization header is not present or invalid, a 401 error code will be returned.
- If the specified person (gets or) updates post or comments of another person, the operation returns the