Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Resource information


Include Page
APS:booked-events.index
APS:booked-events.index

...

Description

...

Returns a list of events booked by the client for the selected product.
Please note: the list will only contain events with the status: "finished", "live" and "scheduled" including events for the next 14 days.
Default order for returned data is: start date - ascending. 

...

Method parameters

...

Query parameters

...

REQUIRED. Determines product in which given events were booked. Possible values:

  • livescorepro
  • scoutsfeed 
  • scoreframe

...

Determines if subnodes of events (details, participants, results, stats) will be visible. Possible values:

  • yes - event subnodes will be shown
  • no - event subnodes will be hidden

...

Determines if events are mapped with client_event_id. Possible values:

  • mapped - display events mapped with customer
  • unmapped - display events unmapped with customer
  • all - display all events (mapped and unmapped)

...

:

...

Determines maximum number of returned records on page. Used in paginated data. Default value is 500

Possible values: 5, 10, 25, 50, 100, 250, 500

Method calling examples

...

booked-

...

Output elements

...

events

...

Possible value:

  • yes - result is booked in selected product
  • no - result is not booked in selected product

Required with product.

...

When the value is 0 then event was autobooked.

Has value only when query parameter product is provided.

...

Determines when the result/score of the event is updated. Possible values:

  • yes - result/score is updated only when the event is finished 
  • no - result/score is updated during the event

...

Type of event coverage. Possible values:

  • from_venue - means the scout is relaying the event directly from the stadium (max. latency 1 second)
  • from_tv - means the scout is relaying the event from TV transmission (max. latency 8 seconds)
  • basic - for this type of coverage we don't provide detailed event incidents (max. latency around 60 seconds)

...

Information concerning scouts coverage. Possible values:

  • yes - means that play by play incidents will be available for the event
  • no - means that play by play incidents will not be available for the event

...

Name of the event status

...

Type of status. Possible values:

  • live
  • scheduled
  • finished
  • cancelled
  • interrupted
  • deleted
  • other

...

Clock status. Possible value:

  • running
  • stopped

...

Possible value:

  • active
  • suspended

...

Relation status. Attribute for internal purposes. Possible value:

  • not_started - for an event that has not started
  • in_progress - for a live event
  • finished - for an event that has finished
  • 30_min_left - scout confirms his ability to deliver the coverage 30 min before the event
  • 5_min_left - scout confirms his ability to deliver the coverage 5 min before the event

...

Determines if the event is played at a neutral venue. Possible values:

  • yes
  • no

...

Describes status of the item (record). Possible values:

  • active - the record is active
  • deleted - the record was deleted by the admin. When an event was added by mistake

...

Possible value:

  • yes - result is verified with an official source
  • no - result is not verified with an official source

...

.index

...

booked_events > events > details > detail

idUnique identifier for the details
nameName of the details. Possible values are different depending on the sport 
valueValue related to the details

...

Participant type. Possible values:

  • team
  • person

...

Participants gender. Possible value:

  • male
  • female
  • mixed (e.g for mixed doubles in tennis )

...

Determines if participant is a national team. Possible values:

  • yes
  • no

...

Determines if the participant is real player / team or virtual. Possible values:

  • yes
  • no

...

foundedDate when the team was founded
phonePhone number
emailEmail address
addressAddress where the team is located
venue_idUnique identifier for the venue in which the team plays home games
venue_nameName of the venue in which the team plays home games
weightParticipants weight
heightParticipants height
nicknameParticipants nickname
position_nameName of the participants position
birthdateParticipants date of birth
born_placeParticipants place of birth
is_retired

Determines if participant has retired. Possible values:

  • yes
  • no
subtype

Participant subtype name. Possible values:

  • athlete
  • coach
  • referee
  • director

...

idUnique identifier for the result
short_nameAbbreviated name of the result.
nameName of the result. Possible values are different depending on the sport
valueValue related to the result

...