POST POS/EventData/Groupings/Search Try Now

Searches the grouping.

Request Information

URI Parameters

NameDescriptionTypeAdditional information

Body Parameters

The search request.

NameDescriptionTypeAdditional information
GroupingName
Gets or sets the name.
string
None.
SHGroupingId
Gets or sets the sh grouping identifier.
integer
None.
CategoryId
Gets or sets the category identifier.
string
None.
ParentGroupingId
Gets or sets the parent grouping identifier.
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:
{
  "GroupingName": "",
  "SHGroupingId": 2,
  "CategoryId": "",
  "ParentGroupingId": "",
  "OrderBy": "",
  "SortOrder": null,
  "DateUpdated": "2019-10-18T16:31",
  "UpdatedSince": {
    "FromDate": "2019-10-18T16:31",
    "ToDate": "2019-10-18T16:32",
    "FilterByTime": true
  },
  "Page": 8,
  "ItemsPerPage": 9
}

Response Information

Resource Description

Search grouping result

NameDescriptionTypeAdditional information
Items
Collection of GroupingResponse
None.
Page
integer
None.
TotalPages
integer
None.
Records
integer
None.
Meta
Object
None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "GroupingId": "",
      "Name": "",
      "Description": "",
      "SHGroupingId": 4,
      "Category": {
        "CategoryId": "",
        "CategoryName": "",
        "ParentCategoryId": ""
      },
      "ParentGroupingId": "",
      "IsDeleted": true,
      "DateAdded": "2019-10-18T16:31",
      "DateUpdated": "2019-10-18T16:31",
      "EventCount": 9,
      "Performers": [
        {
          "PerformerId": "",
          "Performer": "",
          "CategoryId": ""
        }
      ]
    }
  ],
  "Page": 1,
  "TotalPages": 2,
  "Records": 3,
  "Meta": {}
}