GET Categories with Pagination

Overview

---

The following table contains important information about the GET method in regards to receiving the categories with pagination.

GET Categories with Pagination
Method	GET
URL or Endpoint	​/api/projects/projectId/categories/paged
Headers	Authorization
Parameters	projectId, search, page, take, order, insertedDate
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	Yes	string	A word you want to filter.
page	Yes	integer($int32)	The page in which the category is located
take	Yes	integer($int32)	The number of categories to take from the page.
order	Yes	string	The order in which you receive the categories.
insertedDate	No	Date	The date when the category was inserted.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 4,
    "pageSize": 3,
    "totalCount": 12,
    "items": [
      {
        "id": 3,
        "name": "Sports",
        "entityId": 0,
        "deleted": false
      },
      {
        "id": 4,
        "name": "Automotive",
        "entityId": 0,
        "deleted": false
      },
      {
        "id": 5,
        "name": "Sports",
        "entityId": 0,
        "deleted": false
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
currentPage	integer($int32)	The page where the category was taken from.
totalPages	integer($int32)	The total number of pages that contain categories.
pageSize	integer($int32)	The size of the page.
totalCount	integer($int32)	The total number of categories.
item	array[Object]	Returns the items received as an array of objects.
id	integer($int32)	The id of the category.
name	string	The name of the category.
entityId	integer($int32)	The id of the entity.
isDeleted	bool	Indicates whether the category is deleted.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed