Resource information
URL | https://api.softnetsportstatscore.com/v2/events/{eventId}/incidents |
---|---|
XSD | https://api.softnetsport.com/assets/API/docs/xsd/events.incidents.index.xsd |
Method | GET |
Description | Returns a list of incidents for the selected event. |
Cache | Not cached |
Authorization required | Yes |
Internal method | Yes |
Method parameters
NameType | Data type | Description | There are no method parameters in this resource
---|---|---|
event_id | xsd:int | REQUIRED. The requested event identifier |
Query parameters
Name | Type | Description |
---|---|---|
statuses | xsd:string | Determines incidents status identifiers, separated by a comma (e.g. 123,234,321) |
incidents | xsd:string | Determines incidents identifiers, separated by a comma (e.g. 123,234,321) |
important | xsd:string | Determines only important or not important incidents. Possible values: yes, no. |
updated | xsd:string | Determines only updated or not updated incidents. Possible values: yes, no. |
deleted | xsd:string | Determines to list only deleted or not deleted incidents. Possible values: yes, no. |
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 |
sort_order | xsd:string | Additional parameter for sort_type which determines the direction of sorting (ascending, descending). The resource is sorted by sport-specific status then after the time in that status. By default the value of "desc" is set. Possible values:
|
Method calling examples
Link | Description |
---|---|
https://api.softnetsportstatscore.com/v2/events/1877031/incidents?username=softnetsport&incidents=410,413&deleted=no&limit=5&token={{YOUR TOKEN}} | Returns a list of event incidents. |
Output elements
...
.event_incidents | Data type | Description |
---|---|---|
..incident |
id | xsd:array | Incident identifier. Unique for sport. |
action | xsd:string | Describes type of operation. Possible values:
|
old_id | xsd:int | DEPRECATED. Old Id |
event_id | xsd:int | REQUIRED. The event identifier |
incident_id | xsd:int | Incident id in data.sports.incidents node for event |
. The complete list of possible incidents can be retrieved using the API resource: sports.show | ||
attribute_ids | xsd:array | Attributes identifiers related to incident, separated by a comma (e.g. [397, 398]) |
confirmation | xsd:string | Describes confirmation status for the incident. Possible values:
|
participant_id | xsd:int | Participant id |
participant_team_id | xsd:int | Participant team id |
participant_name | xsd:string | Participant name. |
status_id | xsd:int | Status id in data.sports.statuses node for event |
. The complete list of possible statuses can be retrieved using the API resource: statuses.index | ||
minute | xsd:int | Incident time: minute |
second | xsd:int | Incident time: second |
home_score | xsd:int | Home Score |
away_score | xsd:int | Away Score |
home_score1 | xsd:int | Home Score 1 |
away_score1 | xsd:int | Away Score 1 |
home_score2 | xsd:int | Home Score 2 |
away_score2 | xsd:int | Away Score 2 |
x_pos | xsd:int | Ball position on X axis (percentage) |
y_pos | xsd:int | Ball position on Y axis (percentage) |
add_data | xsd:string | Custom information |
display_info | xsd:string | Label for incidents |
counter | xsd:int | Subsequent number of the incydent type in the event. Example: 5th goal in the match. |
ct | xsd:int | Created date |
ut | xsd:int | Last update date |
dt | xsd:int | Deleted date |
additional_info | xsd:array | Contains additional information, e.g. goalkeeper_id, assistant_id (assistant_id = 12345) |
old_added_id | xsd:int | DEPRECATED. Old Id |
sort_type | xsd:string | Determines sort order of data. Possible values:
|
for | xsd:string | Determine what the participant includes incident
|