LeagueLobster API

Please let us know if you need any assistance. The best way to reach out is the help chat on the main site or at help.leaguelobster.com.<p>To make requests, first obtain an access token, then include it in your request header as `Authorization: JWT <your_token>`.</p>

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

access-token

create

POST /api/access-token/

API View that receives a POST with a user's username and password. Returns a JSON Web Token that can be used for authenticated requests.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`password` required
`username` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action access-token create -p password=... -p username=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["access-token", "create"]
params = {
    "password": ...,
    "username": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["access-token", "create"]
var params = {
    password: ...,
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

access-token-logged-in

list

GET /api/access-token-logged-in/

If you are already logged in you can generate an access token here.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action access-token-logged-in list

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["access-token-logged-in", "list"]
result = client.action(schema, action)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["access-token-logged-in", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

association

divisions > list

GET /api/association/{association_id}/divisions/

List all divisions in an association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association divisions > list -p association_id=... -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "divisions > list"]
params = {
    "association_id": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "divisions > list"]
var params = {
    association_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > create

POST /api/association/{association_id}/divisions/

Add a division to an association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title` required
`rank`	Divisions are sorted on this in ascending order.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association divisions > create -p association_id=... -p title=... -p rank=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "divisions > create"]
params = {
    "association_id": ...,
    "title": ...,
    "rank": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "divisions > create"]
var params = {
    association_id: ...,
    title: ...,
    rank: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > read

GET /api/association/{association_id}/divisions/{division_id}/

Retrieve a division in an association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required
`division_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association divisions > read -p association_id=... -p division_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "divisions > read"]
params = {
    "association_id": ...,
    "division_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "divisions > read"]
var params = {
    association_id: ...,
    division_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > update

PUT /api/association/{association_id}/divisions/{division_id}/

Update a division in an association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required
`division_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title` required
`rank`	Divisions are sorted on this in ascending order.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association divisions > update -p association_id=... -p division_id=... -p title=... -p rank=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "divisions > update"]
params = {
    "association_id": ...,
    "division_id": ...,
    "title": ...,
    "rank": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "divisions > update"]
var params = {
    association_id: ...,
    division_id: ...,
    title: ...,
    rank: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > partial_update

PATCH /api/association/{association_id}/divisions/{division_id}/

Update a division in an association (only modifies fields passed in the request).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required
`division_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title`
`rank`	Divisions are sorted on this in ascending order.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association divisions > partial_update -p association_id=... -p division_id=... -p title=... -p rank=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "divisions > partial_update"]
params = {
    "association_id": ...,
    "division_id": ...,
    "title": ...,
    "rank": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "divisions > partial_update"]
var params = {
    association_id: ...,
    division_id: ...,
    title: ...,
    rank: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

leagues > list

GET /api/association/{association_id}/leagues/

Return list of all Leagues under the given Association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association leagues > list -p association_id=... -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "leagues > list"]
params = {
    "association_id": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "leagues > list"]
var params = {
    association_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

leagues > create

POST /api/association/{association_id}/leagues/

Create a new league under the given Association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required	e.g. Monday Night Football
`description`	Shown to users in League Lists and on registration pages.
`sport`
`association` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association leagues > create -p association_id=... -p name=... -p description=... -p sport=... -p association=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "leagues > create"]
params = {
    "association_id": ...,
    "name": ...,
    "description": ...,
    "sport": ...,
    "association": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "leagues > create"]
var params = {
    association_id: ...,
    name: ...,
    description: ...,
    sport: ...,
    association: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

leagues > read

GET /api/association/{association_id}/leagues/{league_id}/

Retrieve a league under the given Association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required
`league_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association leagues > read -p association_id=... -p league_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "leagues > read"]
params = {
    "association_id": ...,
    "league_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "leagues > read"]
var params = {
    association_id: ...,
    league_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

leagues > update

PUT /api/association/{association_id}/leagues/{league_id}/

Update a league under the given Association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required
`league_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required	e.g. Monday Night Football
`description`	Shown to users in League Lists and on registration pages.
`sport`
`association` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association leagues > update -p association_id=... -p league_id=... -p name=... -p description=... -p sport=... -p association=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "leagues > update"]
params = {
    "association_id": ...,
    "league_id": ...,
    "name": ...,
    "description": ...,
    "sport": ...,
    "association": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "leagues > update"]
var params = {
    association_id: ...,
    league_id: ...,
    name: ...,
    description: ...,
    sport: ...,
    association: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

leagues > partial_update

PATCH /api/association/{association_id}/leagues/{league_id}/

Partially update a league under the given Association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required
`league_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`	e.g. Monday Night Football
`description`	Shown to users in League Lists and on registration pages.
`sport`
`association`

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association leagues > partial_update -p association_id=... -p league_id=... -p name=... -p description=... -p sport=... -p association=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "leagues > partial_update"]
params = {
    "association_id": ...,
    "league_id": ...,
    "name": ...,
    "description": ...,
    "sport": ...,
    "association": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "leagues > partial_update"]
var params = {
    association_id: ...,
    league_id: ...,
    name: ...,
    description: ...,
    sport: ...,
    association: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

matches > list

GET /api/association/{association_id}/matches/

Return a list of all Matches for a given Association.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`association_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action association matches > list -p association_id=... -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["association", "matches > list"]
params = {
    "association_id": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["association", "matches > list"]
var params = {
    association_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

match

read

GET /api/match/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action match read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["match", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["match", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

update

PUT /api/match/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`week`
`start`	remove Timeslot if editing manually
`home_score`
`home_points`
`away_score`
`away_points`
`friendly`	not counted in standings
`comment`
`locked`	Locks the game when scheduling
`home_forfeit`
`away_forfeit`
`season`
`playoff_fixture`
`home_team` required
`away_team` required
`venue`	remove Timeslot if editing manually
`referee`
`assistant_referees`

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action match update -p id=... -p week=... -p start=... -p home_score=... -p home_points=... -p away_score=... -p away_points=... -p friendly=... -p comment=... -p locked=... -p home_forfeit=... -p away_forfeit=... -p season=... -p playoff_fixture=... -p home_team=... -p away_team=... -p venue=... -p referee=... -p assistant_referees=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["match", "update"]
params = {
    "id": ...,
    "week": ...,
    "start": ...,
    "home_score": ...,
    "home_points": ...,
    "away_score": ...,
    "away_points": ...,
    "friendly": ...,
    "comment": ...,
    "locked": ...,
    "home_forfeit": ...,
    "away_forfeit": ...,
    "season": ...,
    "playoff_fixture": ...,
    "home_team": ...,
    "away_team": ...,
    "venue": ...,
    "referee": ...,
    "assistant_referees": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["match", "update"]
var params = {
    id: ...,
    week: ...,
    start: ...,
    home_score: ...,
    home_points: ...,
    away_score: ...,
    away_points: ...,
    friendly: ...,
    comment: ...,
    locked: ...,
    home_forfeit: ...,
    away_forfeit: ...,
    season: ...,
    playoff_fixture: ...,
    home_team: ...,
    away_team: ...,
    venue: ...,
    referee: ...,
    assistant_referees: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

partial_update

PATCH /api/match/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`week`
`start`	remove Timeslot if editing manually
`home_score`
`home_points`
`away_score`
`away_points`
`friendly`	not counted in standings
`comment`
`locked`	Locks the game when scheduling
`home_forfeit`
`away_forfeit`
`season`
`playoff_fixture`
`home_team`
`away_team`
`venue`	remove Timeslot if editing manually
`referee`
`assistant_referees`

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action match partial_update -p id=... -p week=... -p start=... -p home_score=... -p home_points=... -p away_score=... -p away_points=... -p friendly=... -p comment=... -p locked=... -p home_forfeit=... -p away_forfeit=... -p season=... -p playoff_fixture=... -p home_team=... -p away_team=... -p venue=... -p referee=... -p assistant_referees=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["match", "partial_update"]
params = {
    "id": ...,
    "week": ...,
    "start": ...,
    "home_score": ...,
    "home_points": ...,
    "away_score": ...,
    "away_points": ...,
    "friendly": ...,
    "comment": ...,
    "locked": ...,
    "home_forfeit": ...,
    "away_forfeit": ...,
    "season": ...,
    "playoff_fixture": ...,
    "home_team": ...,
    "away_team": ...,
    "venue": ...,
    "referee": ...,
    "assistant_referees": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["match", "partial_update"]
var params = {
    id: ...,
    week: ...,
    start: ...,
    home_score: ...,
    home_points: ...,
    away_score: ...,
    away_points: ...,
    friendly: ...,
    comment: ...,
    locked: ...,
    home_forfeit: ...,
    away_forfeit: ...,
    season: ...,
    playoff_fixture: ...,
    home_team: ...,
    away_team: ...,
    venue: ...,
    referee: ...,
    assistant_referees: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

delete

DELETE /api/match/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action match delete -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["match", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["match", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

referee

matches > list

GET /api/referee/{referee_id}/matches/

Return a list of all Matches for a given Referee.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`referee_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action referee matches > list -p referee_id=... -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["referee", "matches > list"]
params = {
    "referee_id": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["referee", "matches > list"]
var params = {
    referee_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

season

list

GET /api/season/

Return a list of all seasons for current user.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season list -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

create

POST /api/season/

Create a new season.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`league_name_input`	Provide this to create a new league instance, e.g. "Monday Night Women's Soccer"
`league`	ID of an existing league. One of `league` or `league name` is required.
`name` required	Season name, e.g. "Spring 2019"
`numweeks` required	Number of weeks in your season (excl. off-weeks).
`numgames` required	Total number of games per team (excl. playoffs)
`duration_game`	Match duration in minutes; default: 60
`association_name`	If creating a new league (by providing league_name and not league), must provide either `association_name` or `association`
`association`	see association_name; ignored if league id given
`startdate`	datetime; default: today + 2 weeks
`enddate`	datetime; default: startdate + numweeks
`tournament`	boolean; True to use tournament scheduler; False to use league scheduler (see pricing)
`partner`
`draft`	boolean; True if the season is in draft mode (hidden from public lists)

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season create -p league_name_input=... -p league=... -p name=... -p numweeks=... -p numgames=... -p duration_game=... -p association_name=... -p association=... -p startdate=... -p enddate=... -p tournament=... -p partner=... -p draft=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "create"]
params = {
    "league_name_input": ...,
    "league": ...,
    "name": ...,
    "numweeks": ...,
    "numgames": ...,
    "duration_game": ...,
    "association_name": ...,
    "association": ...,
    "startdate": ...,
    "enddate": ...,
    "tournament": ...,
    "partner": ...,
    "draft": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "create"]
var params = {
    league_name_input: ...,
    league: ...,
    name: ...,
    numweeks: ...,
    numgames: ...,
    duration_game: ...,
    association_name: ...,
    association: ...,
    startdate: ...,
    enddate: ...,
    tournament: ...,
    partner: ...,
    draft: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

read

GET /api/season/{id}/

Return details for a given season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

update

PUT /api/season/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required	e.g. Spring 2025
`startdate`
`enddate`
`numweeks`	Enter number of weeks/match days in this season.
`numgames`	[optional] Enter number of games each team will play. <br> Only required if you want to generate a schedule with doubleheaders, i.e. more games than weeks.
`duration_game`	Time allocation per game IN MINUTES (for scheduling purposes).
`duration_game_display`	Duration as displayed to players, e.g. 2 x 25 mins
`open_registration`	leave blank to open right away
`close_registration`	leave blank to close on event start date
`max_teams`	Registration will be automatically closed when this many teams have registered and paid (or have been manually included in schedule).
`price`
`individual_price`	price per player when paying individually
`draft`
`league` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season update -p id=... -p name=... -p startdate=... -p enddate=... -p numweeks=... -p numgames=... -p duration_game=... -p duration_game_display=... -p open_registration=... -p close_registration=... -p max_teams=... -p price=... -p individual_price=... -p draft=... -p league=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "update"]
params = {
    "id": ...,
    "name": ...,
    "startdate": ...,
    "enddate": ...,
    "numweeks": ...,
    "numgames": ...,
    "duration_game": ...,
    "duration_game_display": ...,
    "open_registration": ...,
    "close_registration": ...,
    "max_teams": ...,
    "price": ...,
    "individual_price": ...,
    "draft": ...,
    "league": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "update"]
var params = {
    id: ...,
    name: ...,
    startdate: ...,
    enddate: ...,
    numweeks: ...,
    numgames: ...,
    duration_game: ...,
    duration_game_display: ...,
    open_registration: ...,
    close_registration: ...,
    max_teams: ...,
    price: ...,
    individual_price: ...,
    draft: ...,
    league: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

partial_update

PATCH /api/season/{id}/

Update only specified fields on a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`	e.g. Spring 2025
`startdate`
`enddate`
`numweeks`	Enter number of weeks/match days in this season.
`numgames`	[optional] Enter number of games each team will play. <br> Only required if you want to generate a schedule with doubleheaders, i.e. more games than weeks.
`duration_game`	Time allocation per game IN MINUTES (for scheduling purposes).
`duration_game_display`	Duration as displayed to players, e.g. 2 x 25 mins
`open_registration`	leave blank to open right away
`close_registration`	leave blank to close on event start date
`max_teams`	Registration will be automatically closed when this many teams have registered and paid (or have been manually included in schedule).
`price`
`individual_price`	price per player when paying individually
`draft`
`league`

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season partial_update -p id=... -p name=... -p startdate=... -p enddate=... -p numweeks=... -p numgames=... -p duration_game=... -p duration_game_display=... -p open_registration=... -p close_registration=... -p max_teams=... -p price=... -p individual_price=... -p draft=... -p league=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "startdate": ...,
    "enddate": ...,
    "numweeks": ...,
    "numgames": ...,
    "duration_game": ...,
    "duration_game_display": ...,
    "open_registration": ...,
    "close_registration": ...,
    "max_teams": ...,
    "price": ...,
    "individual_price": ...,
    "draft": ...,
    "league": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "partial_update"]
var params = {
    id: ...,
    name: ...,
    startdate: ...,
    enddate: ...,
    numweeks: ...,
    numgames: ...,
    duration_game: ...,
    duration_game_display: ...,
    open_registration: ...,
    close_registration: ...,
    max_teams: ...,
    price: ...,
    individual_price: ...,
    draft: ...,
    league: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

delete

DELETE /api/season/{id}/

Delete a given season. Use caution, this cannot be undone.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season delete -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

copy > create

POST /api/season/{id}/copy/

Copy a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`new_league`	Boolean; Default is False. If True, a new league will be created
`copy_teams`	Boolean; Default is False. If True, teams from the existing season will be copied
`new_teams`	Boolean; Default is True. If False, existing teams will be used
`copy_matches`	Boolean; Default is False. If True, matches from the existing season will be copied
`clear_scores`	Boolean; Default is True. If False, scores from the copied matches will be kept
`clear_referees`	Boolean; Default is False. If True, referees from the copied matches will be cleared
`copy_registration_settings`	Boolean; Default is True. If False, registration settings from the existing season will not be copied

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season copy > create -p id=... -p new_league=... -p copy_teams=... -p new_teams=... -p copy_matches=... -p clear_scores=... -p clear_referees=... -p copy_registration_settings=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "copy > create"]
params = {
    "id": ...,
    "new_league": ...,
    "copy_teams": ...,
    "new_teams": ...,
    "copy_matches": ...,
    "clear_scores": ...,
    "clear_referees": ...,
    "copy_registration_settings": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "copy > create"]
var params = {
    id: ...,
    new_league: ...,
    copy_teams: ...,
    new_teams: ...,
    copy_matches: ...,
    clear_scores: ...,
    clear_referees: ...,
    copy_registration_settings: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > list

GET /api/season/{season_id}/divisions/

List all divisions in a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions > list -p season_id=... -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "divisions > list"]
params = {
    "season_id": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "divisions > list"]
var params = {
    season_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > create

POST /api/season/{season_id}/divisions/

Add a division to a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`season` required
`division` required
`max_teams`	maximum number of teams allowed to register
`number_of_matches`	number of matches

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions > create -p season_id=... -p season=... -p division=... -p max_teams=... -p number_of_matches=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "divisions > create"]
params = {
    "season_id": ...,
    "season": ...,
    "division": ...,
    "max_teams": ...,
    "number_of_matches": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "divisions > create"]
var params = {
    season_id: ...,
    season: ...,
    division: ...,
    max_teams: ...,
    number_of_matches: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > read

GET /api/season/{season_id}/divisions/{division_id}/

Retrieve a division in a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`division_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions > read -p season_id=... -p division_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "divisions > read"]
params = {
    "season_id": ...,
    "division_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "divisions > read"]
var params = {
    season_id: ...,
    division_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > update

PUT /api/season/{season_id}/divisions/{division_id}/

Update a division in a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`division_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`season` required
`division` required
`max_teams`	maximum number of teams allowed to register
`number_of_matches`	number of matches

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions > update -p season_id=... -p division_id=... -p season=... -p division=... -p max_teams=... -p number_of_matches=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "divisions > update"]
params = {
    "season_id": ...,
    "division_id": ...,
    "season": ...,
    "division": ...,
    "max_teams": ...,
    "number_of_matches": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "divisions > update"]
var params = {
    season_id: ...,
    division_id: ...,
    season: ...,
    division: ...,
    max_teams: ...,
    number_of_matches: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > partial_update

PATCH /api/season/{season_id}/divisions/{division_id}/

Update a division in a season (only modifies fields passed in the request).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`division_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`season`
`division`
`max_teams`	maximum number of teams allowed to register
`number_of_matches`	number of matches

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions > partial_update -p season_id=... -p division_id=... -p season=... -p division=... -p max_teams=... -p number_of_matches=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "divisions > partial_update"]
params = {
    "season_id": ...,
    "division_id": ...,
    "season": ...,
    "division": ...,
    "max_teams": ...,
    "number_of_matches": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "divisions > partial_update"]
var params = {
    season_id: ...,
    division_id: ...,
    season: ...,
    division: ...,
    max_teams: ...,
    number_of_matches: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > delete

DELETE /api/season/{season_id}/divisions/{division_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`division_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions > delete -p season_id=... -p division_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "divisions > delete"]
params = {
    "season_id": ...,
    "division_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "divisions > delete"]
var params = {
    season_id: ...,
    division_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > bulk > create

POST /api/season/{season_id}/divisions/bulk/

Add multiple divisions to a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`ids` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions > bulk > create -p season_id=... -p ids=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "divisions > bulk > create"]
params = {
    "season_id": ...,
    "ids": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "divisions > bulk > create"]
var params = {
    season_id: ...,
    ids: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

divisions > bulk > delete

DELETE /api/season/{season_id}/divisions/bulk/

Remove multiple divisions from a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions > bulk > delete -p season_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "divisions > bulk > delete"]
params = {
    "season_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "divisions > bulk > delete"]
var params = {
    season_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

matches > list

GET /api/season/{season_id}/matches/

Return a list of all Matches in the given Season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season matches > list -p season_id=... -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "matches > list"]
params = {
    "season_id": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "matches > list"]
var params = {
    season_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

matches > create

POST /api/season/{season_id}/matches/

Add a Match or list of Matches to the given Season. Accepts either a dict (to create a single Match) or a list of dicts to (create multiple Matches).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`week`
`start`	naive datetime
`home_score`
`home_points`
`away_score`
`away_points`
`friendly`	set True to exclude game from standings
`comment`
`locked`	Locks the game when scheduling
`home_forfeit`
`away_forfeit`
`season` required	needs to match URL
`playoff_fixture`
`home_team` required
`away_team` required
`venueavail`
`venue`	remove Timeslot if editing manually
`referee`
`assistant_referees`

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season matches > create -p season_id=... -p week=... -p start=... -p home_score=... -p home_points=... -p away_score=... -p away_points=... -p friendly=... -p comment=... -p locked=... -p home_forfeit=... -p away_forfeit=... -p season=... -p playoff_fixture=... -p home_team=... -p away_team=... -p venueavail=... -p venue=... -p referee=... -p assistant_referees=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "matches > create"]
params = {
    "season_id": ...,
    "week": ...,
    "start": ...,
    "home_score": ...,
    "home_points": ...,
    "away_score": ...,
    "away_points": ...,
    "friendly": ...,
    "comment": ...,
    "locked": ...,
    "home_forfeit": ...,
    "away_forfeit": ...,
    "season": ...,
    "playoff_fixture": ...,
    "home_team": ...,
    "away_team": ...,
    "venueavail": ...,
    "venue": ...,
    "referee": ...,
    "assistant_referees": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "matches > create"]
var params = {
    season_id: ...,
    week: ...,
    start: ...,
    home_score: ...,
    home_points: ...,
    away_score: ...,
    away_points: ...,
    friendly: ...,
    comment: ...,
    locked: ...,
    home_forfeit: ...,
    away_forfeit: ...,
    season: ...,
    playoff_fixture: ...,
    home_team: ...,
    away_team: ...,
    venueavail: ...,
    venue: ...,
    referee: ...,
    assistant_referees: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

matches > delete

DELETE /api/season/{season_id}/matches/

Delete all Matches in the given Season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season matches > delete -p season_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "matches > delete"]
params = {
    "season_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "matches > delete"]
var params = {
    season_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

standings > list

GET /api/season/{id}/standings/

Return standings data for a given Season, grouped by Division and Group/Pool.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season standings > list -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "standings > list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "standings > list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

team > read

GET /api/season/{season_id}/team/{team_id}/

List all teams in the given season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`team_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season team > read -p season_id=... -p team_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "team > read"]
params = {
    "season_id": ...,
    "team_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "team > read"]
var params = {
    season_id: ...,
    team_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

team > create

POST /api/season/{season_id}/team/{team_id}/

Add an existing team to a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`team_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`id`	Team ID. Ignored if team_id is passed (via url).
`name`	Team name.
`division`	Division ID
`division_name`	Division name. Ignored if division ID is passed. Will use existing division if found in season's association, otherwise creates a new division.
`group`	Group (pool) ID

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season team > create -p season_id=... -p team_id=... -p id=... -p name=... -p division=... -p division_name=... -p group=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "team > create"]
params = {
    "season_id": ...,
    "team_id": ...,
    "id": ...,
    "name": ...,
    "division": ...,
    "division_name": ...,
    "group": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "team > create"]
var params = {
    season_id: ...,
    team_id: ...,
    id: ...,
    name: ...,
    division: ...,
    division_name: ...,
    group: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

team > update

PUT /api/season/{season_id}/team/{team_id}/

Update a team's division and/or group.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`team_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`id`	Team ID. Ignored if team_id is passed (via url).
`name`	Team name.
`division`	Division ID
`division_name`	Division name. Ignored if division ID is passed. Will use existing division if found in season's association, otherwise creates a new division.
`group`	Group (pool) ID

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season team > update -p season_id=... -p team_id=... -p id=... -p name=... -p division=... -p division_name=... -p group=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "team > update"]
params = {
    "season_id": ...,
    "team_id": ...,
    "id": ...,
    "name": ...,
    "division": ...,
    "division_name": ...,
    "group": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "team > update"]
var params = {
    season_id: ...,
    team_id: ...,
    id: ...,
    name: ...,
    division: ...,
    division_name: ...,
    group: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

team > partial_update

PATCH /api/season/{season_id}/team/{team_id}/

Update a team's division and/or group (pass season id and team id and the new division id or division name and or the new group id).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`team_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`id`	Team ID. Ignored if team_id is passed (via url).
`name`	Team name.
`division`	Division ID
`division_name`	Division name. Ignored if division ID is passed. Will use existing division if found in season's association, otherwise creates a new division.
`group`	Group (pool) ID

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season team > partial_update -p season_id=... -p team_id=... -p id=... -p name=... -p division=... -p division_name=... -p group=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "team > partial_update"]
params = {
    "season_id": ...,
    "team_id": ...,
    "id": ...,
    "name": ...,
    "division": ...,
    "division_name": ...,
    "group": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "team > partial_update"]
var params = {
    season_id: ...,
    team_id: ...,
    id: ...,
    name: ...,
    division: ...,
    division_name: ...,
    group: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

team > delete

DELETE /api/season/{season_id}/team/{team_id}/

Remove a team from a season. The team itself will not be deleted, so it will still be available in any other seasons it may be attached to.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`team_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season team > delete -p season_id=... -p team_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "team > delete"]
params = {
    "season_id": ...,
    "team_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "team > delete"]
var params = {
    season_id: ...,
    team_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

teams > list

GET /api/season/{season_id}/teams/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season teams > list -p season_id=... -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "teams > list"]
params = {
    "season_id": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "teams > list"]
var params = {
    season_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

teams > create

POST /api/season/{season_id}/teams/

Add a team (dict) or list of teams (list of dicts) to a season. Passing team_id uses existing team, passing team_name without team_id creates a new team. Passing a division (id) will use an existing division, passing a division name without an id will create a new division.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`id`	Team ID. Ignored if team_id is passed (via url).
`name`	Team name.
`division`	Division ID
`division_name`	Division name. Ignored if division ID is passed. Will use existing division if found in season's association, otherwise creates a new division.
`group`	Group (pool) ID

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season teams > create -p season_id=... -p id=... -p name=... -p division=... -p division_name=... -p group=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "teams > create"]
params = {
    "season_id": ...,
    "id": ...,
    "name": ...,
    "division": ...,
    "division_name": ...,
    "group": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "teams > create"]
var params = {
    season_id: ...,
    id: ...,
    name: ...,
    division: ...,
    division_name: ...,
    group: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

venues > list

GET /api/season/{season_id}/venues/

Get the related items of a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season venues > list -p season_id=... -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "venues > list"]
params = {
    "season_id": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "venues > list"]
var params = {
    season_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

venues > create

POST /api/season/{season_id}/venues/

Add related items to a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`ids` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season venues > create -p season_id=... -p ids=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "venues > create"]
params = {
    "season_id": ...,
    "ids": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "venues > create"]
var params = {
    season_id: ...,
    ids: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

venues > delete

DELETE /api/season/{season_id}/venues/

Remove related items from a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season venues > delete -p season_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "venues > delete"]
params = {
    "season_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "venues > delete"]
var params = {
    season_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

venues > read

GET /api/season/{season_id}/venues/{item_id}/

Get the related items of a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`item_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season venues > read -p season_id=... -p item_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "venues > read"]
params = {
    "season_id": ...,
    "item_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "venues > read"]
var params = {
    season_id: ...,
    item_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

venues > create_0

POST /api/season/{season_id}/venues/{item_id}/

Add related items to a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`item_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`ids` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season venues > create_0 -p season_id=... -p item_id=... -p ids=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "venues > create_0"]
params = {
    "season_id": ...,
    "item_id": ...,
    "ids": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "venues > create_0"]
var params = {
    season_id: ...,
    item_id: ...,
    ids: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

venues > delete_0

DELETE /api/season/{season_id}/venues/{item_id}/

Remove related items from a season.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`season_id` required
`item_id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season venues > delete_0 -p season_id=... -p item_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["season", "venues > delete_0"]
params = {
    "season_id": ...,
    "item_id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["season", "venues > delete_0"]
var params = {
    season_id: ...,
    item_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

team

list

GET /api/team/

Lists all Teams for all of the user's Associations.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action team list -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["team", "list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["team", "list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

read

GET /api/team/{team}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`team` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action team read -p team=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["team", "read"]
params = {
    "team": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["team", "read"]
var params = {
    team: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

update

PUT /api/team/{team}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`team` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`	Team name

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action team update -p team=... -p name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["team", "update"]
params = {
    "team": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["team", "update"]
var params = {
    team: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

partial_update

PATCH /api/team/{team}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`team` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`	Team name

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action team partial_update -p team=... -p name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["team", "partial_update"]
params = {
    "team": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["team", "partial_update"]
var params = {
    team: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

delete

DELETE /api/team/{team}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`team` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action team delete -p team=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["team", "delete"]
params = {
    "team": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["team", "delete"]
var params = {
    team: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

matches > list

GET /api/team/{team_id}/matches/

Return a list of all Matches for a given Team.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`team_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action team matches > list -p team_id=... -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["team", "matches > list"]
params = {
    "team_id": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["team", "matches > list"]
var params = {
    team_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

venue

list

GET /api/venue/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action venue list -p page=... -p page_size=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["venue", "list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["venue", "list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

create

POST /api/venue/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`address`
`city`
`state`
`zipcode`
`country`
`info`	e.g. venue website
`order`	Venues are sorted on this in ascending order.
`master`
`position`	drag the pin to the approximate position of the entrance
`associations`

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action venue create -p name=... -p address=... -p city=... -p state=... -p zipcode=... -p country=... -p info=... -p order=... -p master=... -p position=... -p associations=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["venue", "create"]
params = {
    "name": ...,
    "address": ...,
    "city": ...,
    "state": ...,
    "zipcode": ...,
    "country": ...,
    "info": ...,
    "order": ...,
    "master": ...,
    "position": ...,
    "associations": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["venue", "create"]
var params = {
    name: ...,
    address: ...,
    city: ...,
    state: ...,
    zipcode: ...,
    country: ...,
    info: ...,
    order: ...,
    master: ...,
    position: ...,
    associations: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

read

GET /api/venue/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action venue read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["venue", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["venue", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

update

PUT /api/venue/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`address`
`city`
`state`
`zipcode`
`country`
`info`	e.g. venue website
`order`	Venues are sorted on this in ascending order.
`master`
`position`	drag the pin to the approximate position of the entrance
`associations`

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action venue update -p id=... -p name=... -p address=... -p city=... -p state=... -p zipcode=... -p country=... -p info=... -p order=... -p master=... -p position=... -p associations=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["venue", "update"]
params = {
    "id": ...,
    "name": ...,
    "address": ...,
    "city": ...,
    "state": ...,
    "zipcode": ...,
    "country": ...,
    "info": ...,
    "order": ...,
    "master": ...,
    "position": ...,
    "associations": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["venue", "update"]
var params = {
    id: ...,
    name: ...,
    address: ...,
    city: ...,
    state: ...,
    zipcode: ...,
    country: ...,
    info: ...,
    order: ...,
    master: ...,
    position: ...,
    associations: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

partial_update

PATCH /api/venue/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`
`address`
`city`
`state`
`zipcode`
`country`
`info`	e.g. venue website
`order`	Venues are sorted on this in ascending order.
`master`
`position`	drag the pin to the approximate position of the entrance
`associations`

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action venue partial_update -p id=... -p name=... -p address=... -p city=... -p state=... -p zipcode=... -p country=... -p info=... -p order=... -p master=... -p position=... -p associations=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["venue", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "address": ...,
    "city": ...,
    "state": ...,
    "zipcode": ...,
    "country": ...,
    "info": ...,
    "order": ...,
    "master": ...,
    "position": ...,
    "associations": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["venue", "partial_update"]
var params = {
    id: ...,
    name: ...,
    address: ...,
    city: ...,
    state: ...,
    zipcode: ...,
    country: ...,
    info: ...,
    order: ...,
    master: ...,
    position: ...,
    associations: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

delete

DELETE /api/venue/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action venue delete -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["venue", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["venue", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

verify-token

create

POST /api/verify-token/

API View that checks the validity of a token, returning the token if it is valid.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`token` required

# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action verify-token create -p token=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://scheduler.leaguelobster.com/api/docs/")

# Interact with the API endpoint
action = ["verify-token", "create"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["verify-token", "create"]
var params = {
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})