Search Try Now

Searches the category.

Request Information

URI Parameters

Name	Description	Type	Additional information

Body Parameters

The category request.

SearchCategoryRequest

Name	Description	Type	Additional information
CategoryName	The name of the category.	string	None.
ParentCategoryId	The parent category.	string	None.
OrderBy	Sets the order by.(Note: Please use column Name Given in Response only,Don't use "Page" or "ItemsPerPage").	string	None.
SortOrder	The SortOrder i.e. "ASC" or "DESC"	string	None.
DateUpdated	Set Date Updated you can use either Date Updated Or UpdatedSince.	date	None.
UpdatedSince	Set From Date and To Date value. Return result for between date , From Date And To Date.	DateValue	None.
Page	Sets the page.	integer	None.
ItemsPerPage	Sets the items per page.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CategoryName": "",
  "ParentCategoryId": "",
  "OrderBy": "",
  "SortOrder": null,
  "DateUpdated": "2024-04-24T17:00",
  "UpdatedSince": {
    "FromDate": "2024-04-24T17:00",
    "ToDate": "2024-04-24T17:01",
    "FilterByTime": true
  },
  "Page": 6,
  "ItemsPerPage": 7
}

Response Information

Resource Description

Search category result

CategoryResponse

Name	Type	Additional information
Items	Collection of CategoryResponse	None.
Page	integer	None.
TotalPages	integer	None.
Records	integer	None.
Meta	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "CategoryId": "",
      "CategoryName": "",
      "ParentCategoryId": "",
      "DateAdded": "2024-04-24T17:00",
      "DateUpdated": "2024-04-24T17:00",
      "Status": "Any",
      "Performers": [
        {
          "PerformerId": "",
          "Performer": "",
          "CategoryId": ""
        }
      ],
      "Groupings": [
        {
          "GroupingId": "",
          "Name": "",
          "SHGroupingId": 3,
          "CategoryId": ""
        }
      ]
    }
  ],
  "Page": 1,
  "TotalPages": 2,
  "Records": 3,
  "Meta": {}
}