swiss unihockey clubs endpoint Endpoint Documentation

/rest/v1.0/clubs
Read methods
Name Value and Notes
Method / Path: GET /
Description: Returns all (active) clubs.
Required (form) parameters: apikey: Valid API key registered at swiss unihockey
Response formats: xml
Status codes: 200: OK — Returning all found clubs.
404: Not Found — No clubs could be found.
Testing: Test form (click to reveal)
Name Value and Notes
Method / Path: GET /{clubid}
Description: Returns the requested club.
Path parameters: clubid: The club id
Required (form) parameters: apikey: Valid API key registered at swiss unihockey
Response formats: xml
Status codes: 200: OK — Returning the club.
404: Not Found — No club with the given id found.
Testing: Test form (click to reveal)
Name Value and Notes
Method / Path: GET /{clubid}/teams
Description: Returns the teams of a club.
Path parameters: clubid: The club id
Required (form) parameters: apikey: Valid API key registered at swiss unihockey
Optional (query) parameters: season: The season (default: current season)
Response formats: xml
Status codes: 200: OK — Returning the teams for this club (for the given season).
404: Not Found — No teams for this club found (for the given season).
Testing: Test form (click to reveal)
Name Value and Notes
Method / Path: GET /search
Description: Search for clubs by keyword.
Required (form) parameters: q: The search query
apikey: Valid API key registered at swiss unihockey
Optional (query) parameters: limit: The search result limit [10]
Response formats: xml
Status codes: 200: OK — Returning all clubs found for the given keyword.
404: Not Found — No club for the given keyword found.
400: Bad Request — Given club name too short (at least 5 characters are required).
Testing: Test form (click to reveal)