Resource information
softnetsportXSDhttps://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 24hrsfor the next 14 days. Default order for returned data is: start date - ascending. |
Package | This resource is included in ALL packages |
900 15 5 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 API administrator |
product | xsd:string | REQUIRED. Determines product in which given events were booked. Possible values: |
scoutsfeed events_details- scoutsfeed
- scoreframe
- prematchcenter
|
client_event_id | xsd:string | Determines if |
subnodes of events (details, participants, results, stats) will be visibleno - event subnodes will be hiddenclients event identifier is mapped with STATSCORE event. Values could be separated by comma (e.g. 123,234,321). If clients event is not mapped proper message will be returned. |
mapped_status | xsd:string | Determines if events are mapped with client_event_id. Possible values: |
yes - event subnodes will be shown- mapped - display events mapped with customer
- unmapped - display events unmapped with customer
- all - display all events (mapped and unmapped)
|
multi_ids | xsd:string | List of events identifiers separated by a comma (e.g. 123,234,321) for which you want to get the events details (Up to 100 ids) |
lang | xsd:string | Determines language for the output |
data. softnetSPORT API provides the following languages: languages.indexdata |
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
Output elements
. | ..event | booked_events > events |
---|
id | Unique identifier for the event | client_event_id | Unique event identifier for the client. | booked | Possible value: - yes - result is booked in selected product
- no - result is not booked in selected product
Required with product. | booked_by | When the value is 0 then event was autobooked. Has value only when query parameter product is provided. | name | Name of the event e.g. Spain - Italy | start_date | Date when the event starts in the 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 the 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 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 - 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 | clock_status | Clock status. Possible value: | bet_status | Possible value: | relation_status | 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
| source | Identifier of scout related to the event. Attribute for internal purposes | winner_id | Who is the winner of the match | progress_id | Who advanced to the next round | day | Day of the season | sport_id | Unique identifier for the sport in which |
|
the softnetSPORT API provides the following sportsThe complete list of possible sports can be retrieved using the API resource: sports.index | sport_name | Name of the sport in which event is played |
|
day | Day of the seasonround_id | Unique identifier for the round in which event is played. Possible null value. | round_name | Name of the round | neutral_venue | Determines if the event is played at a neutral venue. Possible values: | 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
| verified_result | Possible value: - yes - result is verified with an official source
- no - result is not verified with an official source
| 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 | area_id | Unique identifier for area in which competitions are played. The complete list of possible areas can be retrieved using the API resource: areas.index | area_name | Name of area in which competitions are played. Possible translation of the attribute | season_id | Unique identifier for season | season_name | Name of the season e. |
|
..details additional information related to event | | |
---|
g. Premiership 2014/15 | stage_id | Unique identifier for stage | stage_name | Name of the stage | inverted_participants | Information about inverted order of participants (e.g. Team B - Team A instead of Team A - Team B). Possible values: | event_stats_lvl | Information about the statistics level. Possible values: | event_stats_lvl_live | Information about expected statistics level when the match is LIVE. Possible values: | event_stats_lvl_after | Information about expected statistics level after the end of the match. Possible values: | latency | Information about the expected latency. Possible values: - null (for the event with scoutsfeed=no parameter)
- 1-2s
- 3-6s
- 7-15s
|
|
booked_events > events > details |
---|
booked_events > events > details > 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 | sport | value | Value related to the details |
|
| |
---|
booked_events > events > participants |
---|
booked_events > events > 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: | name | Participants name | short_name |
|
Participanst Participants abbreviated name, max length: 20 characters | acronym | Max 3 characters in 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: sportsindex | sport_name | Name of the sport in which the participant is involved. | national | Determines if participant is a national team. Possible values: | 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 removed in the next API version | slug | friendly url for participant |
|
competition | logo | Attribute for internal purpose | virtual | Determines if the participant is real player / team or virtual. Possible values: |
|
booked_events > events > participants > participant > details |
---|
booked_events > events > participants > participant > details > detail |
---|
founded | Date when the team was founded | phone | Phone number | email | Email address | address | Address where the team is located | venue_id | Unique identifier for |
|
the competitioncompetition_short_name | Abbreviated name for the competition e.g. U19 WCH, Max 20 characters |
| |
---|
| the venue in which the team plays home games | venue_name | Name of the venue in which the team plays home games | weight | Participants weight | height | Participants height | nickname | Participants nickname | position_name | Name of the participants position | birthdate | Participants date of birth | born_place | Participants place of birth | is_retired | Determines if participant has retired. Possible values: | subtype | Participant subtype name. Possible values: - athlete
- coach
- referee
- director
|
|
booked_events > events > participants > participant > results |
---|
booked_events > events > participants > participant > results > result |
---|
id | Unique identifier for the result | short_name | Abbreviated name of the result. | name | Name of the result. Possible values are different depending on |
|
the . For more information please find node details in the sports.show: sports.show | value | Value related to the result |
|
| |
---|
|
|
booked_events > events > participants > participant > stats |
---|
booked_events > events > participants > participant > stats > stat |
---|
id | Unique identifier for the statistic | short_name | Abbreviated name of the statistic. | name | Name of the statistic. Possible values are different depending on |
|
the . For more information please find node details in the sports.show: sports.show | value | Value related to the statistic |
|