booked-events.index

Resource information

URL	https://api.softnetsport.com/v2/booked-events
XSD	https://api.softnetsport.com/assets/API/docs/xsd/booked-events.index.xsd
Method	GET
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 that start from the moment of your request until the end of that day plus the following 24hrs.
Package	This resource is included in ALL packages
Cache	900 seconds (15 min.)
Authorization required	No

Method parameters

Name	Type	Description
There are no method parameters in this resource

Query parameters

Name	Type	Description
client_id	xsd:int	REQUIRED. Assigned to you by the softnetSPORT administrator
product	xsd:string	REQUIRED. Determines product in which given events were booked. Possible values: livescorepro scoutsfeed
events_details	xsd:string	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
lang	xsd:string	Determines language for the output data. softnetSPORT API provides the following languages: languages.index
page	xsd:int	Determines offset of paginated data. Default value is 1 which means first page
limit	xsd:int	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

Link	Description
https://api.softnetsport.com/v2/booked-events.xml?client_id=1&product=livescorepro&events_details=no	Returns a list of booked events without detailed node about events.

Output elements

.booked_events
..event
id	Unique identifier for the event
client_event_id	Unique event identifier for the client.
name	Name of the event e.g. Spain - Italy
start_date	Date when the event starts in format DATE_TIME (2015-03-01 11:02)
ft_only	Determines when the result/score of the event is updated. Possible values: yes - result/score is updated only when event is finished no - result/score is updated during the event
coverage_type	Type of event coverage. Possible values: from_venue - means the scout is relaying the event directly from the stadium (max. latency 1 second) from_low_latency_tv - means the scout is relaying the event from tv transmission (max. latency 3 seconds) 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)
scoutsfeed	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
status_id	Unique identifier of the event status. softnetSPORT API provides the following statuses: statuses.index
status_name	Name of the event status
status_type	Type of status. Possible values: live scheduled finished cancelled interrupted deleted other
clock_time	How many seconds have passed in the current event period. Possible empty value
sport_id	Unique identifier for the sport in which the event is played. softnetSPORT API provides the following sports: sports.index
sport_name	Name of the sport in which event is played
day	Day of the season
neutral_venue	Determines if event is played at a neutral venue. Possible values: yes no
item_status	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
ut	Information about when the date and time of the event record was last updated. Format UNIX_TIMESTAMP
old_event_id	deprecated. The attribute will be removed in the next API version
slug	friendly url for event
logo	Attribute for internal purposes
competition_id	Unique identifier for the competition
competition_short_name	Abbreviated name of the competition

......details	additional information related to event
.......detail
id	Unique identifier for the details
name	Name of the details. Possible values are different depending on the sport. For more information please find node details in the sports.show: sports.show
value	Value related to the details
......participants
.......participant
counter	Number of participants in the event. Participant with counter="1" is the home team.
id	Unique identifier of the participant
type	Participant type. Possible values: team person
name	Participants name
short_name	Participanst abbreviated name, max length: 20 characters
acronym	Max 3 characters length mini name, e.g. BAR, REA
gender	Participants gender. Possible value: male female mixed (e.g for mixed doubles in tennis )
area_id	Unique identifier for the area represented by the participant. softnetSPORT API provides the following areas: areas.index
area_name	Area name represented by the participant
area_code	Max 3 characters in length for the abbreviated area name e.g. GER, POL, FRA
sport_id	Unique identifier for the sport in which the participant is involved. softnetSPORT API provides the following sports: sports.index
sport_name	Name of the sport in which the participant is involved.
national	Determines if participant is a national team. Possible values: yes no
website	Participants official website
ut	Information about when the date and time of the record was last updated. Format UNIX_TIMESTAMP
old_participant_id	deprecated. The attribute will be deprecated in next API version
slug	friendly url for participant
competition_id	Unique identifier for the competition
competition_short_name	Abbreviated name for the competition e.g. U19 WCH, Max 20 characters
........results
.........result
id	Unique identifier for the result
name	Name of the result. Possible values are different depending on the sport. For more information please find node details in the sports.show: sports.show
value	Value related to the result
........stats
.........stat
id	Unique identifier for the statistic
name	Name of the statistic. Possible values are different depending on the sport. For more information please find node details in the sports.show: sports.show
value	Value related to the statistic