Resource information
| URL | https://api.softnetsport.com/v2/participants |
|---|---|
| XSD | https://api.softnetsport.com/assets/API/docs/xsd/participants.index.xsd |
| Method | GET |
Description | Returns a list of all available participants (teams or persons) for all sports |
| Cache | 60 seconds |
| Autorization required | Yes |
Method parameters
| Name | Type | Description |
|---|---|---|
| There are no method parameters in this resource | ||
Query parameters
| Name | Type | Description |
|---|---|---|
| token | xsd:string | REQUIRED. More information concerning authorization in API introduction section |
| lang | xsd:string | Determines language for the output data. The complete list of possible languages can be retrieved using the API resource: 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 |
| sport_id | xsd:int | REQUIRED. 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_id | xsd:int | Determines 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_id | xsd:int | Determines the area represented by the participant. The complete list of possible areas can be retrieved using the API resource: areas.index |
| multi_ids | xsd:string | List 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) |
| type | xsd:string | Participant type. Possible values:
|
| subtype | xsd:string | Participant subtype. Possible values:
|
| timestamp | xsd: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=5 | Returns a list of participants for soccer in XML format |
| https://api.softnetsport.com/v2/participants?token={{YOUR_TOKEN}}&sport_id=5 | Returns a list of participants for soccer in JSON format |
| https://api.softnetsport.com/v2/participants?token={{YOUR_TOKEN}}&sport_id=5&season_id=45 | Returns team participants fof soccer Premiera Division for the season 2014/2015 |
Output elements
| .participants | |
|---|---|
| ..participant | |
| id | Unique identifier of the participant |
| type | Participant type. Possible values:
|
| name | Participant name. Possible translation of the attribute |
| short_name | Abbreviated name, max length: 20 characters. Possible translation of the attribute |
| acronym | Max 3 characters in length mini name, e.g: BAR, REA |
| gender | Participant gender. Possible value:
|
| area_id | Unique identifier for the area represented by the participant. The complete list of possible areas can be retrieved using the API resource: areas.index |
| area_name | Area name represented by the participant |
| area_code | Max 3 characters in length of the short area name e.g: GER, POL, FRA |
| sport_id | Unique identifier for the sport in which the participant take part. The complete list of possible sports can be retrieved using the API resource: sports.index |
| sport_name | Name of the sport in which participant takes part |
| national | Determines if participant is a national team. Possible values:
|
| website | Participants official website |
| ut | Information about the date and time of when the record was last updated. Format UNIX_TIMESTAMP |
| old_participant_id | deprecated. The attribute will be removed in next API version |
| slug | friendly url for participant |
| logo | Attribute for internal purposes |
| ...details | |
| founded | Date when the team was founded |
| phone | Phone number |
| Email address | |
| address | Addres where the team is located |
| venue_id | Unique identifier of 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 | Participanst birthdate |
| born_place | Participants place of birth |
| is_retired | Determines if the participant has retired. Possible values:
|
| subtype | Participant subtype name. Possible values:
|