Versions Compared

Key

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

Resource information

URLhttps://api.softnetsportstatscore.com/v2/events/{eventId}/incidents
XSDhttps://api.softnetsport.com/assets/API/docs/xsd/events.incidents.index.xsd
MethodGET

Description

Returns a list of incidents for the selected event.

CacheNot cached
Authorization requiredYes
Internal methodYes

Method parameters

There are no method parameters in this resource 
NameTypeData typeDescription
event_idxsd:intREQUIRED. The requested event identifier

Query parameters

NameTypeDescription
statusesxsd:stringDetermines incidents status identifiers, separated by a comma (e.g. 123,234,321) 
incidentsxsd:stringDetermines incidents identifiers, separated by a comma (e.g. 123,234,321)
importantxsd:string

Determines only important or not important incidents.

Possible values: yes, no.

updatedxsd:string

Determines only updated or not updated incidents.

Possible values: yes, no.

deletedxsd:string

Determines to list only deleted or not deleted incidents.

Possible values: yes, no.

pagexsd:intDetermines offset of paginated data. Default value is 1 which means first page
limitxsd: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:

  • asc - sort ascending
  • desc - sort descending

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
  event_id
xsd:arrayIncident identifier. Unique for sport.
action

xsd:

intREQUIRED. The requested event identifiertoken

string

Describes type of operation. Possible values:

  • insert
  • update
  • delete
old_idxsd:
stringincident
int
REQUIRED. More information concerning authorization in API introduction section
DEPRECATED. Old Id
event_idxsd:
array
intREQUIRED.
 Array with incident parametersincident[
 The event identifier
incident_id
]
xsd:int
REQUIRED. Incident
Incident id in data.sports.incidents node for event
from resource
. The complete list of possible incidents can be retrieved using the API resource: sports.show
attribute_idsxsd:arrayAttributes identifiers related to incident, separated by a comma (e.g. [397, 398])
confirmationxsd:string

Describes confirmation status for the incident. Possible values:

  • tbd – appears as default for Goal, Penalty, Red card, Yellow card and Corner incidents.
  • confirmed – appears when the following incident will be confirmed by referee.
  • cancelled – appears when the following incident will be cancelled by referee. Incidents with this value have no effect on statistics.
participant_id
]
xsd:intParticipant id
incident[
participant_team_id
]
xsd:intParticipant team id
incident[
participant_name
]
xsd:stringParticipant name.
incident[
status_id
]
xsd:intStatus id in data.sports.statuses node for event
from resource sports.showincident[minute]
. The complete list of possible statuses can be retrieved using the API resource: statuses.index
minutexsd:intIncident time: minute
incident[
second
]
xsd:intIncident time: second
incident[
home_score
]
xsd:intHome Score
incident[
away_score
]
xsd:intAway Score
incident[
home_score1
]
xsd:intHome Score 1
incident[
away_score1
]
xsd:intAway Score 1
incident[
home_score2
]
xsd:intHome Score 2
incident[
away_score2
]
xsd:intAway Score 2
incident[
x_posxsd:intBall position on X axis (percentage)
y_posxsd:intBall position on Y axis (percentage)
add_data
]
xsd:stringCustom information
incident[
display_info
]
xsd:stringLabel for incidents
incident[
counterxsd:intSubsequent number of the incydent type in the event. Example: 5th goal in the match.
ctxsd:intCreated date
utxsd:intLast update date
dtxsd:intDeleted date
additional_infoxsd:arrayContains additional information, e.g. goalkeeper_id, assistant_id (assistant_id = 12345)
old_added_id
]
xsd:intDEPRECATED. Old Id

...

sort_typexsd:string

Determines sort order of data. Possible values:

  • id - Incidents are sorted by the id of the Incident
forxsd:stringDetermine what the participant includes incident
  • all
  • own
  • rival
  • none