POST POS/EventData/Events/Search Try Now

Searches the event.

Request Information

URI Parameters

NameDescriptionTypeAdditional information

Body Parameters

The search request.

NameDescriptionTypeAdditional information
EventName
The event name.
string
None.
StubHubEventId
The stubhub event id.
string
None.
EventDate
The event date.
DateValue
None.
VenueId
The Venue Id.
string
None.
CategoryId
string
None.
IncludePastEvents
Boolean flag to load passed or cancelled events.
boolean
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:
{
  "EventName": "",
  "StubHubEventId": "",
  "EventDate": {
    "FromDate": "2019-10-18T08:46",
    "ToDate": "2019-10-18T08:47",
    "FilterByTime": true
  },
  "VenueId": "",
  "CategoryId": "",
  "IncludePastEvents": true,
  "OrderBy": "",
  "SortOrder": null,
  "DateUpdated": "2019-10-18T08:46",
  "UpdatedSince": {
    "FromDate": "2019-10-18T08:46",
    "ToDate": "2019-10-18T08:47",
    "FilterByTime": true
  },
  "Page": 8,
  "ItemsPerPage": 9
}

Response Information

Resource Description

Search event result

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

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "EventId": "",
      "StubHubEventId": "",
      "EventName": "",
      "EventDate": "2019-10-18T08:46",
      "EventDateUtc": "2019-10-18T08:46",
      "Venue": {
        "VenueId": "",
        "Name": "",
        "Country": "",
        "CountryCode": "",
        "State": "",
        "StateISO": "",
        "City": "",
        "ZipCode": "",
        "Status": "Any"
      },
      "Category": {
        "CategoryId": "",
        "CategoryName": "",
        "ParentCategoryId": ""
      },
      "Performers": [
        {
          "IsPrimary": true,
          "PerformerId": "",
          "Performer": "",
          "CategoryId": ""
        }
      ],
      "Groupings": [
        {
          "GroupingId": "",
          "Name": "",
          "SHGroupingId": 3,
          "CategoryId": ""
        }
      ],
      "Status": "None",
      "DateUpdated": "2019-10-18T08:46",
      "DateAdded": "2019-10-18T08:46",
      "CurrencyCode": "",
      "HideEventDate": true,
      "HideEventTime": true,
      "SHListings": 11
    }
  ],
  "Page": 1,
  "TotalPages": 2,
  "Records": 3,
  "Meta": {}
}