LeagueLobster API

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.

To make requests, first obtain an access token, then include it in your request header as Authorization: JWT <your_token>.

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

# Install the Python client library
$ pip install coreapi

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.0.js"></script>
<script src="/api/docs/schema.js"></script>

access-token

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.

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

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

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 = {
    "username": ...,
    "password": ...,
}
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 = {
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

access-token-logged-in

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

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

List all divisions in an association.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
association_id required

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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 &gt; 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 &gt; 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 &gt; list"]
var params = {
    association_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
POST /api/association/{association_id}/divisions/

Add a division to an association.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
association_id required

Request Body

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

ParameterDescription
title required
rankDivisions 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 &gt; 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 &gt; 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 &gt; create"]
var params = {
    association_id: ...,
    title: ...,
    rank: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

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

# Interact with the API endpoint
$ coreapi action association divisions &gt; read -p division_id=... -p association_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 &gt; read"]
params = {
    "division_id": ...,
    "association_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 &gt; read"]
var params = {
    division_id: ...,
    association_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
division_id required
association_id required

Request Body

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

ParameterDescription
title required
rankDivisions 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 &gt; update -p division_id=... -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 &gt; update"]
params = {
    "division_id": ...,
    "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 &gt; update"]
var params = {
    division_id: ...,
    association_id: ...,
    title: ...,
    rank: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
division_id required
association_id required

Request Body

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

ParameterDescription
title
rankDivisions 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 &gt; partial_update -p division_id=... -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 &gt; partial_update"]
params = {
    "division_id": ...,
    "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 &gt; partial_update"]
var params = {
    division_id: ...,
    association_id: ...,
    title: ...,
    rank: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
association_id required

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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 &gt; 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 &gt; 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 &gt; list"]
var params = {
    association_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
association_id required

Request Body

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

ParameterDescription
name requirede.g. Monday Night Football
descriptionShown 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 &gt; 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 &gt; 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 &gt; create"]
var params = {
    association_id: ...,
    name: ...,
    description: ...,
    sport: ...,
    association: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

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

# Interact with the API endpoint
$ coreapi action association leagues &gt; read -p league_id=... -p association_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 &gt; read"]
params = {
    "league_id": ...,
    "association_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 &gt; read"]
var params = {
    league_id: ...,
    association_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
league_id required
association_id required

Request Body

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

ParameterDescription
name requirede.g. Monday Night Football
descriptionShown 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 &gt; update -p league_id=... -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 &gt; update"]
params = {
    "league_id": ...,
    "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 &gt; update"]
var params = {
    league_id: ...,
    association_id: ...,
    name: ...,
    description: ...,
    sport: ...,
    association: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
league_id required
association_id required

Request Body

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

ParameterDescription
namee.g. Monday Night Football
descriptionShown 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 &gt; partial_update -p league_id=... -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 &gt; partial_update"]
params = {
    "league_id": ...,
    "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 &gt; partial_update"]
var params = {
    league_id: ...,
    association_id: ...,
    name: ...,
    description: ...,
    sport: ...,
    association: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
association_id required

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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 &gt; 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 &gt; 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 &gt; list"]
var params = {
    association_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

match

GET /api/match/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
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'
})
PUT /api/match/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id required

Request Body

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

ParameterDescription
week
startremove Timeslot if editing manually
home_score
home_points
away_score
away_points
friendlynot counted in standings
comment
lockedLocks the game when scheduling
season
playoff_fixture
home_team required
away_team required
venueremove 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 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": ...,
    "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: ...,
    season: ...,
    playoff_fixture: ...,
    home_team: ...,
    away_team: ...,
    venue: ...,
    referee: ...,
    assistant_referees: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
PATCH /api/match/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id required

Request Body

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

ParameterDescription
week
startremove Timeslot if editing manually
home_score
home_points
away_score
away_points
friendlynot counted in standings
comment
lockedLocks the game when scheduling
season
playoff_fixture
home_team
away_team
venueremove 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 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": ...,
    "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: ...,
    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 /api/match/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
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

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.

ParameterDescription
referee_id required

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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 &gt; 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 &gt; 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 &gt; list"]
var params = {
    referee_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

season

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.

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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'
})
POST /api/season/

Create a new season.

Request Body

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

ParameterDescription
league_name_inputProvide this to create a new league instance, e.g. "Monday Night Women's Soccer"
leagueID of an existing league. One of `league` or `league name` is required.
name requiredSeason name, e.g. "Spring 2019"
numweeks requiredNumber of weeks in your season (excl. off-weeks).
numgames requiredTotal number of games per team (excl. playoffs)
duration_gameMatch duration in minutes; default: 60
association_nameIf creating a new league (by providing league_name and not league), must provide either `association_name` or `association`
associationsee association_name; ignored if league id given
startdatedatetime; default: today + 2 weeks
enddatedatetime; default: startdate + numweeks
tournamentboolean; True to use tournament scheduler; False to use league scheduler (see pricing)
partner
 
# 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=...

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": ...,
}
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: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
GET /api/season/{id}/

Return details for a given season.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
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'
})
PUT /api/season/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id required

Request Body

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

ParameterDescription
name requirede.g. Spring 2024
startdate
enddate
numweeksEnter 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_gameTime allocation per game IN MINUTES (for scheduling purposes).
duration_game_displayDuration as displayed to players, e.g. 2 x 25 mins
order
open_registrationleave blank to open right away
close_registrationleave blank to close on event start date
max_teamsRegistration will be automatically closed when this many teams have registered and paid (or have been manually included in schedule).
price
individual_priceprice per player when paying individually
draft
claimed_at
modified
league required
start_weekdayweeks start on
merchant_account
standings
settings
weekdays
venues
contactsWhom to contact with questions
 
# 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 order=... -p open_registration=... -p close_registration=... -p max_teams=... -p price=... -p individual_price=... -p draft=... -p claimed_at=... -p modified=... -p league=... -p start_weekday=... -p merchant_account=... -p standings=... -p settings=... -p weekdays=... -p venues=... -p contacts=...

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": ...,
    "order": ...,
    "open_registration": ...,
    "close_registration": ...,
    "max_teams": ...,
    "price": ...,
    "individual_price": ...,
    "draft": ...,
    "claimed_at": ...,
    "modified": ...,
    "league": ...,
    "start_weekday": ...,
    "merchant_account": ...,
    "standings": ...,
    "settings": ...,
    "weekdays": ...,
    "venues": ...,
    "contacts": ...,
}
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: ...,
    order: ...,
    open_registration: ...,
    close_registration: ...,
    max_teams: ...,
    price: ...,
    individual_price: ...,
    draft: ...,
    claimed_at: ...,
    modified: ...,
    league: ...,
    start_weekday: ...,
    merchant_account: ...,
    standings: ...,
    settings: ...,
    weekdays: ...,
    venues: ...,
    contacts: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
PATCH /api/season/{id}/

Update only specified fields on a season.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id required

Request Body

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

ParameterDescription
namee.g. Spring 2024
startdate
enddate
numweeksEnter 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_gameTime allocation per game IN MINUTES (for scheduling purposes).
duration_game_displayDuration as displayed to players, e.g. 2 x 25 mins
order
open_registrationleave blank to open right away
close_registrationleave blank to close on event start date
max_teamsRegistration will be automatically closed when this many teams have registered and paid (or have been manually included in schedule).
price
individual_priceprice per player when paying individually
draft
claimed_at
modified
league
start_weekdayweeks start on
merchant_account
standings
settings
weekdays
venues
contactsWhom to contact with questions
 
# 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 order=... -p open_registration=... -p close_registration=... -p max_teams=... -p price=... -p individual_price=... -p draft=... -p claimed_at=... -p modified=... -p league=... -p start_weekday=... -p merchant_account=... -p standings=... -p settings=... -p weekdays=... -p venues=... -p contacts=...

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": ...,
    "order": ...,
    "open_registration": ...,
    "close_registration": ...,
    "max_teams": ...,
    "price": ...,
    "individual_price": ...,
    "draft": ...,
    "claimed_at": ...,
    "modified": ...,
    "league": ...,
    "start_weekday": ...,
    "merchant_account": ...,
    "standings": ...,
    "settings": ...,
    "weekdays": ...,
    "venues": ...,
    "contacts": ...,
}
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: ...,
    order: ...,
    open_registration: ...,
    close_registration: ...,
    max_teams: ...,
    price: ...,
    individual_price: ...,
    draft: ...,
    claimed_at: ...,
    modified: ...,
    league: ...,
    start_weekday: ...,
    merchant_account: ...,
    standings: ...,
    settings: ...,
    weekdays: ...,
    venues: ...,
    contacts: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
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'
})
GET /api/season/{season_id}/divisions/

List all divisions in a season.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
season_id required

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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 &gt; 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 &gt; 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 &gt; list"]
var params = {
    season_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
POST /api/season/{season_id}/divisions/

Add a division to a season.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
season_id required

Request Body

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

ParameterDescription
season required
division required
max_teamsmaximum number of teams allowed to register
number_of_matchesnumber of matches
 
# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions &gt; 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 &gt; 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 &gt; 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'
})
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.

ParameterDescription
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 &gt; 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 &gt; 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 &gt; read"]
var params = {
    season_id: ...,
    division_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
season_id required
division_id required

Request Body

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

ParameterDescription
season required
division required
max_teamsmaximum number of teams allowed to register
number_of_matchesnumber of matches
 
# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions &gt; 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 &gt; 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 &gt; 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'
})
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.

ParameterDescription
season_id required
division_id required

Request Body

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

ParameterDescription
season
division
max_teamsmaximum number of teams allowed to register
number_of_matchesnumber of matches
 
# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season divisions &gt; 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 &gt; 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 &gt; 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'
})
DELETE /api/season/{season_id}/divisions/{division_id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
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 &gt; 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 &gt; 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 &gt; delete"]
var params = {
    season_id: ...,
    division_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
season_id required

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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 &gt; 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 &gt; 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 &gt; list"]
var params = {
    season_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
season_id required

Request Body

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

ParameterDescription
week
startnaive datetime
home_score
home_points
away_score
away_points
friendlyset True to exclude game from standings
comment
lockedLocks the game when scheduling
season requiredneeds to match URL
playoff_fixture
home_team required
away_team required
venueavail
venueremove 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 &gt; 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 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 &gt; create"]
params = {
    "season_id": ...,
    "week": ...,
    "start": ...,
    "home_score": ...,
    "home_points": ...,
    "away_score": ...,
    "away_points": ...,
    "friendly": ...,
    "comment": ...,
    "locked": ...,
    "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 &gt; create"]
var params = {
    season_id: ...,
    week: ...,
    start: ...,
    home_score: ...,
    home_points: ...,
    away_score: ...,
    away_points: ...,
    friendly: ...,
    comment: ...,
    locked: ...,
    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'
})
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.

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

# Interact with the API endpoint
$ coreapi action season matches &gt; 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 &gt; 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 &gt; delete"]
var params = {
    season_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

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

# Interact with the API endpoint
$ coreapi action season standings &gt; 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 &gt; 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 &gt; list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
GET /api/season/{season_id}/team/{team}/

List all teams in the given season.

Path Parameters

The following parameters should be included in the URL path.

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

# Interact with the API endpoint
$ coreapi action season team &gt; read -p season_id=... -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 = ["season", "team &gt; read"]
params = {
    "season_id": ...,
    "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 = ["season", "team &gt; read"]
var params = {
    season_id: ...,
    team: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
PUT /api/season/{season_id}/team/{team}/

Update a team's division and/or group.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
season_id required
team required

Request Body

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

ParameterDescription
teamTeam ID passed in URL, no need to pass again in request
nameTeam name
division_nameDivision name. Ignored if division ID is passed. Will use existing division if found in season's association, otherwise creates a new division.
groupGroup (pool) ID
divisionDivision ID
 
# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season team &gt; update -p season_id=... -p team=... -p team=... -p name=... -p division_name=... -p group=... -p division=...

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 &gt; update"]
params = {
    "season_id": ...,
    "team": ...,
    "team": ...,
    "name": ...,
    "division_name": ...,
    "group": ...,
    "division": ...,
}
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 &gt; update"]
var params = {
    season_id: ...,
    team: ...,
    team: ...,
    name: ...,
    division_name: ...,
    group: ...,
    division: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
PATCH /api/season/{season_id}/team/{team}/

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.

ParameterDescription
season_id required
team required

Request Body

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

ParameterDescription
teamTeam ID passed in URL, no need to pass again in request
nameTeam name
division_nameDivision name. Ignored if division ID is passed. Will use existing division if found in season's association, otherwise creates a new division.
groupGroup (pool) ID
divisionDivision ID
 
# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season team &gt; partial_update -p season_id=... -p team=... -p team=... -p name=... -p division_name=... -p group=... -p division=...

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 &gt; partial_update"]
params = {
    "season_id": ...,
    "team": ...,
    "team": ...,
    "name": ...,
    "division_name": ...,
    "group": ...,
    "division": ...,
}
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 &gt; partial_update"]
var params = {
    season_id: ...,
    team: ...,
    team: ...,
    name: ...,
    division_name: ...,
    group: ...,
    division: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
DELETE /api/season/{season_id}/team/{team}/

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.

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

# Interact with the API endpoint
$ coreapi action season team &gt; delete -p season_id=... -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 = ["season", "team &gt; delete"]
params = {
    "season_id": ...,
    "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 = ["season", "team &gt; delete"]
var params = {
    season_id: ...,
    team: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
GET /api/season/{season_id}/teams/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
season_id required

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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 &gt; 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 &gt; 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 &gt; list"]
var params = {
    season_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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 and updates team name if different
  • passing team_name without team_id creates a new team
  • returns team.id - store this for future use
  • passing a division id will use an existing division and include it in the season if it isn't already
  • passing a division name without an id will create a new division and include it in the season

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
season_id required

Request Body

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

ParameterDescription
teamTeam ID passed in URL, no need to pass again in request
nameTeam name
division_nameDivision name. Ignored if division ID is passed. Will use existing division if found in season's association, otherwise creates a new division.
groupGroup (pool) ID
divisionDivision ID
 
# Load the schema document
$ coreapi get https://scheduler.leaguelobster.com/api/docs/

# Interact with the API endpoint
$ coreapi action season teams &gt; create -p season_id=... -p team=... -p name=... -p division_name=... -p group=... -p division=...

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 &gt; create"]
params = {
    "season_id": ...,
    "team": ...,
    "name": ...,
    "division_name": ...,
    "group": ...,
    "division": ...,
}
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 &gt; create"]
var params = {
    season_id: ...,
    team: ...,
    name: ...,
    division_name: ...,
    group: ...,
    division: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
season_id required

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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 &gt; 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 &gt; 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 &gt; list"]
var params = {
    season_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
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 &gt; 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 &gt; 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 &gt; read"]
var params = {
    season_id: ...,
    item_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
season_id required
item_id required

Request Body

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

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

# Interact with the API endpoint
$ coreapi action season venues &gt; create -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 &gt; create"]
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 &gt; create"]
var params = {
    season_id: ...,
    item_id: ...,
    ids: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
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.

ParameterDescription
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 &gt; delete -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 &gt; delete"]
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 &gt; delete"]
var params = {
    season_id: ...,
    item_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

team

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.

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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'
})
GET /api/team/{team}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
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'
})
PUT /api/team/{team}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
team required

Request Body

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

ParameterDescription
teamTeam ID passed in URL, no need to pass again in request
nameTeam 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 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": ...,
    "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: ...,
    team: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
PATCH /api/team/{team}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
team required

Request Body

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

ParameterDescription
teamTeam ID passed in URL, no need to pass again in request
nameTeam 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 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": ...,
    "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: ...,
    team: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
DELETE /api/team/{team}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
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'
})
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.

ParameterDescription
team_id required

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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 &gt; 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 &gt; 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 &gt; list"]
var params = {
    team_id: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

venue

GET /api/venue/

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber 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'
})
POST /api/venue/

Request Body

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

ParameterDescription
name required
address
city
state
zipcode
country
infoe.g. venue website
orderVenues are sorted on this in ascending order.
positiondrag 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 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": ...,
    "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: ...,
    position: ...,
    associations: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
GET /api/venue/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
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'
})
PUT /api/venue/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id required

Request Body

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

ParameterDescription
name required
address
city
state
zipcode
country
infoe.g. venue website
orderVenues are sorted on this in ascending order.
positiondrag 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 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": ...,
    "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: ...,
    position: ...,
    associations: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
PATCH /api/venue/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id required

Request Body

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

ParameterDescription
name
address
city
state
zipcode
country
infoe.g. venue website
orderVenues are sorted on this in ascending order.
positiondrag 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 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": ...,
    "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: ...,
    position: ...,
    associations: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})
DELETE /api/venue/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
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'
})