TicketUserServices

<back to all web services

EventsSearchRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequired permission:Tickets.Add
The following routes are available for this service:
POST/Event/Search
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Event:
    id: Optional[int] = None
    name: Optional[str] = None
    description: Optional[str] = None
    external_reference: Optional[str] = None
    time_of_event: Optional[datetime.datetime] = None
    event_location_id: Optional[int] = None
    event_series_id: Optional[int] = None
    event_owner_id: Optional[int] = None
    event_active: Optional[bool] = None
    default_values: Optional[str] = None
    external_reference_type: Optional[str] = None
    postponed_no_date: Optional[bool] = None
    away_team_external_id: Optional[str] = None
    sport_gender_id: Optional[str] = None
    sale_is_active: Optional[bool] = None
    seating_image_url: Optional[str] = None
    venue_id: Optional[int] = None
    away_team_owner_id: Optional[int] = None
    detailed_description: Optional[str] = None
    image_url: Optional[str] = None
    direct_access_code: Optional[str] = None
    image_url2: Optional[str] = None
    hide_event: Optional[bool] = None
    owner_cards_not_allowed: Optional[bool] = None
    end_of_event: Optional[datetime.datetime] = None
    end_of_event_u_t_c: Optional[datetime.datetime] = None
    time_zone: Optional[str] = None
    time_of_event_u_t_c: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventsResult:
    items: Optional[List[Event]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventsSearchRequest:
    name: Optional[str] = None
    external_i_d: Optional[str] = None
    external_id_type: Optional[str] = None

Python EventsSearchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Event/Search HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EventsSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <ExternalID>String</ExternalID>
  <ExternalIdType>String</ExternalIdType>
  <Name>String</Name>
</EventsSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EventsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:Event>
      <d2p1:AwayTeamExternalId>String</d2p1:AwayTeamExternalId>
      <d2p1:AwayTeamOwnerId>0</d2p1:AwayTeamOwnerId>
      <d2p1:DefaultValues>String</d2p1:DefaultValues>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DetailedDescription>String</d2p1:DetailedDescription>
      <d2p1:DirectAccessCode>String</d2p1:DirectAccessCode>
      <d2p1:EndOfEvent>0001-01-01T00:00:00</d2p1:EndOfEvent>
      <d2p1:EndOfEventUTC>0001-01-01T00:00:00</d2p1:EndOfEventUTC>
      <d2p1:EventActive>false</d2p1:EventActive>
      <d2p1:EventLocationId>0</d2p1:EventLocationId>
      <d2p1:EventOwnerId>0</d2p1:EventOwnerId>
      <d2p1:EventSeriesId>0</d2p1:EventSeriesId>
      <d2p1:ExternalReference>String</d2p1:ExternalReference>
      <d2p1:ExternalReferenceType>String</d2p1:ExternalReferenceType>
      <d2p1:HideEvent>false</d2p1:HideEvent>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:ImageUrl>String</d2p1:ImageUrl>
      <d2p1:ImageUrl2>String</d2p1:ImageUrl2>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OwnerCardsNotAllowed>false</d2p1:OwnerCardsNotAllowed>
      <d2p1:PostponedNoDate>false</d2p1:PostponedNoDate>
      <d2p1:SaleIsActive>false</d2p1:SaleIsActive>
      <d2p1:SeatingImageUrl>String</d2p1:SeatingImageUrl>
      <d2p1:SportGenderId>String</d2p1:SportGenderId>
      <d2p1:TimeOfEvent>0001-01-01T00:00:00</d2p1:TimeOfEvent>
      <d2p1:TimeOfEventUTC>0001-01-01T00:00:00</d2p1:TimeOfEventUTC>
      <d2p1:TimeZone>String</d2p1:TimeZone>
      <d2p1:VenueId>0</d2p1:VenueId>
    </d2p1:Event>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</EventsResult>