Getting Started

To get started, contact someone at WSL for access to APIs.

Begin using APIs

All the APIs available are listed to the left. Click on an API to get more information.

The structure of the url you will need to make the HTTP request should look like this:

Structure: https://<host>/<apiVersion>/<uri> Example: https://apictfantasy.staging.worldsurfleague.com/v1/hub/details

Authorization

All the APIs will need an authorization header with a proper OAuth 2.0 access token.

To obtain an access token, use the /oauth/token API using your Client Credentials given to you by the WSL.

The authorization header should look like Authorization: Bearer accessTokenHere

Service Errors

HTTP Response Codes

Status Code Description
200 A 200 response code will be returned for successful requests
400 A 400 response code for errors along with a list of the errors
500 A 500 response code if there was an internal error on our side (no error message will be returned in this case)

Error Representaton

In the case of a webservice error, a json response will be returned to the caller. The representation can show multiple errors for the same call. Example error representation:

JSON:

{"errors": [{"message":"You have entered an invalid email address."}]}