Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 33 Next »

Resource information

URLhttps://api.softnetsport.com/v2/participants
MethodGET

Description

Returns a list of all available participants (teams or persons) for all sports

Cache60 seconds
Autorization requiredYes

Method parameters

NameTypeDescription
There are no method parameters in this resource 

Query parameters

NameTypeDescription
tokenxsd:stringREQUIRED. More information concerning authorization in API introduction section
langxsd:string

Determines language for the output data. The complete list of possible languages can be retrieved using the API resource: languages.index

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

sport_idxsd:intREQUIRED. Identifier for the sport. Allows you to filter participants for the selected sport. The complete list of possible sports can be retrieved using the API resource: sports.index
season_idxsd:intDetermines the season id, in which participants participated. e.g. to get all participants that played in Premiership in 2014/15. The complete list of possible seasons can be retrieved using the API resource: seasons.index
area_idxsd:intDetermines the area represented by the participant. The complete list of possible areas can be retrieved using the API resource: areas.index
multi_idsxsd:stringList of participant identifiers separated by a comma (e.g. 123,234,321) for the details of the participant you want returned. (Up to 100 ids)
typexsd:string

Participant type. Possible values:

  • team
  • person
subtypexsd:string

Participant subtype. Possible values:

  • athlete
  • coach
  • playing_coach
  • referee
  • director
timestampxsd:unix_timestamp

Selection date, format UNIX_TIMESTAMP. Only changes for participants that occurred or were updated after this timestamp will be returned.

Method calling examples

Link
Description
https://api.softnetsport.com/v2/participants.xml?token={{YOUR_TOKEN}}&sport_id=5Returns a list of participants for soccer in XML format
https://api.softnetsport.com/v2/participants?token={{YOUR_TOKEN}}&sport_id=5Returns a list of participants for soccer in JSON format
https://api.softnetsport.com/v2/participants?token={{YOUR_TOKEN}}&sport_id=5&season_id=45Returns team participants fof soccer Premiera Division for the season 2014/2015

Output elements

participants
participants > participant

idUnique identifier of the participant
type

Participant type. Possible values:

  • team
  • person
  • double
nameParticipants name
short_nameParticipants abbreviated name, max length: 20 characters
acronymMax 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_idUnique identifier for the area represented by the participant.  
area_nameArea name represented by the participant.
area_codeMax 3 characters in length for the abbreviated area name e.g. GER, POL, FRA.
sport_idUnique identifier for the sport in which the participant is involved.
sport_nameName of the sport in which the participant is involved.
national

Determines if participant is a national team. Possible values:

  • yes
  • no
websiteParticipants official website
utInformation about when the date and time of the record was last updated. Format UNIX_TIMESTAMP
old_participant_iddeprecated. The attribute will be removed in the next API version
slugfriendly url for participant
logoAttribute for internal purpose
virtual

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

  • yes
  • no
shirt_nrInformation about player's season number

participants > participant > details
participants > participant > details > detail
foundedDate when the team was founded
phonePhone number
emailEmail address
addressAddres where the team is located
venue_idUnique identifier of 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
birthdateParticipanst birthdate
born_placeParticipants place of birth
is_retired

Determines if the participant has retired. Possible values:

  • yes
  • no
subtype

Participant subtype name. Possible values:

  • athlete
  • coach
  • referee
  • director
  • No labels