Schedule

Schedule of season for tournament

Returns list of scheduled matches of the given season and tournament.

get/tournaments/{tournament_id}/seasons/{season_id}/schedule

Request

  • Base URL
    https://api.clubplatform.de/api
  • URL
    https://api.clubplatform.de/api/tournaments/{tournament_id}/seasons/{season_id}/schedule
  • Auth
    API key in query parameter auth_token

Path parameters

tournament_idinteger required

ID of the tournament.

season_idinteger required

ID of the season.

Query parameters

club_idinteger

Filter matches by club id.

group_idinteger

Filter matches by group.

roundstring

Id of the round.

All divisions without this round are filtered out. This parameter can also have the value current_round which will give you the current_round.

previousinteger

Number of matches before yesterday to limiting the returning matches.

nextinteger

Number of matches since yesterday to limiting the returning matches. The value includes yesterday.

locale'de-DE' | 'en-GB' | 'nl-NL'

It returns only items for that locale. Additionally, as side effect the response will be in that locale.

NOTE: The locale must be whitelisted for your club! If not the locale for the auth_token will be used as default.

Filter ItemsSet locale
✅✅

Headers

If-Modified-Sincestring date-time

This makes the request conditional - the server will send back the requested resource, with a 200 status, only if it has been last modified after the given date. If the request has not been modified since, the response will be a 304 without any body; the Last-Modified header will contain the date of last modification.

You MUST set this header, if you can, to respect API caching.

Response

OK

Example response

{
  "data": {
    "season_id": 1573215,
    "season_name": "2016/2017",
    "tournament_id": 1,
    "tournament_name": "Bundesliga",
    "tournament_handle": "BUNDESLIGA",
    "number_of_rounds": 34,
    "divisions": [
      {
        "id": 1,
        "name": "First half of the season",
        "rounds": [
          {
            "id": 2,
            "name": "2. Spieltag",
            "matches": [
              {
                "id": 42,
                "start_date_time": "2016-08-22T20:45:00+02:00",
                "start_weekday": "wednesday",
                "group": {
                  "id": 6,
                  "name": "Gruppe F"
                },
                "site": {
                  "id": 45,
                  "name": "Red Bull Arena",
                  "built": 2004,
                  "seats": 42959,
                  "surface": "turf",
                  "url": "www.sportforum-leipzig.com",
                  "city": "Leipzig",
                  "postal_code": "04105",
                  "street": "Am Sportforum, 3",
                  "pitch": {
                    "x": 105,
                    "y": 68
                  }
                },
                "teams": [
                  {
                    "id": 1401830,
                    "name": "SV Eintracht Trier 05",
                    "club": {
                      "id": 81
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.