Skip to main content

Category

Prerequisites #

  • To use the Social Feed API, you must first authenticate yourself and receive a token enables you to access the service. See the Authentication documentation for more information on how to do this.
  • Category endpoints need a categoryId as path parameter.

Requests #

Category resource provides the following endpoints:

PathHTTP MethodDescription
v1/categories/GETView categories
v1/categories/POSTCreate a new category
v1/categories/latestPostsGETView latest created posts in all categories
v1/categories/{categoryId}GETView a specified category
v1/categories/{categoryId}PUTUpdate an existing category
v1/categories/{categoryId}DELDelete an existing category
v1/categories/{categoryId}/latestPostsGETView latest created posts for a specified category

See the API documentation documentation for more information on these endpoints

Example Request #

The following example curl command demonstrates how to get a specified category.

In a Linux/Unix/macOS environment:

curl -i "https://sf-dev.microservice.bankify.io/v1/categories/<categoryId>"
-H "Authorization: Bearer <access_token>"

In Windows PowerShell:

curl https://sf-dev.microservice.bankify.io/v1/categories/<categoryId>

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 authenticating user is not active, the operation returns the Access is denied error.
    • If the authenticating user or the specified category does not exist, the operation returns the Not found error.
    • If the specified category is already exist, the operation returns the Conflict error.
      • If the Authorization header is not present or invalid, a 401 error code will be returned.