Helium API Documentation

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

# Install the Python client library
$ pip install coreapi

auth

token > create

POST /auth/token/

Obtain an authentication token for the given user credentials. The "token" in the response should then be provided in all future calls that required authentication. This can be done by setting the `Authorization` header with a value of `Token <token>`.

Request Body

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

Parameter	Description
`username` required	The username or email for the user.
`password` required	The password for the user.

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

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

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

import coreapi

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

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

token > revoke

DELETE /auth/token/revoke/

Revoke the authenticated user's access token.

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

# Interact with the API endpoint
$ coreapi action auth token revoke

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 = ["auth", "token > revoke"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["auth", "token > revoke"]
result = client.action(schema, action)

user > read

GET /auth/user/

Return the authenticated user instance, including profile and settings details.

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

# Interact with the API endpoint
$ coreapi action auth user read

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 = ["auth", "user > read"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["auth", "user > read"]
result = client.action(schema, action)

user > update

PUT /auth/user/

Update the authenticated user instance. This endpoint only updates the fields given (i.e. no need to PATCH for partials data).

Request Body

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

Parameter	Description
`username` required	A unique name used to login to the system.
`email` required	A unique and valid email address.
`old_password`	The current password for the user (required only when changing an existing password).
`password`	A password to set for the user.

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

# Interact with the API endpoint
$ coreapi action auth user update -p username=... -p email=... -p old_password=... -p password=...

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

import coreapi

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

# Interact with the API endpoint
action = ["auth", "user > update"]
params = {
    "username": ...,
    "email": ...,
    "old_password": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

user > forgot_password

PUT /auth/user/forgot/

Reset the password for the user instance associated with the given email.

Request Body

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

Parameter	Description
`username` required	A unique name used to login to the system.
`email` required	The email for the user.
`old_password`	The current password for the user (required only when changing an existing password).
`password`	A password to set for the user.

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

# Interact with the API endpoint
$ coreapi action auth user forgot_password -p username=... -p email=... -p old_password=... -p password=...

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

import coreapi

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

# Interact with the API endpoint
action = ["auth", "user > forgot_password"]
params = {
    "username": ...,
    "email": ...,
    "old_password": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

user > register

POST /auth/user/register/

Request Body

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

Parameter	Description
`username` required	A unique name used to login to the system.
`email` required	A unique and valid email address.
`old_password`	The current password for the user (required only when changing an existing password).
`password` required	A password to set for the user.
`time_zone`	A valid time zone choice.

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

# Interact with the API endpoint
$ coreapi action auth user register -p username=... -p email=... -p old_password=... -p password=... -p time_zone=...

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 = ["auth", "user > register"]
var params = {
    username: ...,
    email: ...,
    old_password: ...,
    password: ...,
    time_zone: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["auth", "user > register"]
params = {
    "username": ...,
    "email": ...,
    "old_password": ...,
    "password": ...,
    "time_zone": ...,
}
result = client.action(schema, action, params=params)

user > verify_email

GET /auth/user/verify/

Verify an email address for the user instance associated with the username and verification code.

Query Parameters

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

Parameter	Description
`username` required	The username for the user.
`code` required	The email verification code for the user

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

# Interact with the API endpoint
$ coreapi action auth user verify_email -p username=... -p code=...

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 = ["auth", "user > verify_email"]
var params = {
    username: ...,
    code: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["auth", "user > verify_email"]
params = {
    "username": ...,
    "code": ...,
}
result = client.action(schema, action, params=params)

user > delete > delete

DELETE /auth/user/delete/

Delete the given user instance.

Request Body

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

Parameter	Description
`username` required	The username for the user.
`email` required	The email for the user.
`password` required	The password for the user.

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

# Interact with the API endpoint
$ coreapi action auth user delete delete -p username=... -p email=... -p password=...

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

import coreapi

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

# Interact with the API endpoint
action = ["auth", "user > delete > delete"]
params = {
    "username": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

user > profile > update

PUT /auth/user/profile/

Update the authenticated user's profile. This endpoint only updates the fields given (i.e. no need to PATCH for partials data).

Request Body

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

Parameter	Description
`phone`	A valid phone number.
`phone_verification_code`	The code sent to `phone` when registering or changing a phone number

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

# Interact with the API endpoint
$ coreapi action auth user profile update -p phone=... -p phone_verification_code=...

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 = ["auth", "user > profile > update"]
var params = {
    phone: ...,
    phone_verification_code: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["auth", "user > profile > update"]
params = {
    "phone": ...,
    "phone_verification_code": ...,
}
result = client.action(schema, action, params=params)

user > settings > update

PUT /auth/user/settings/

Update the authenticated user's settings. This endpoint only updates the fields given (i.e. no need to PATCH for partials data). For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Request Body

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

Parameter	Description
`time_zone`	A valid time zone choice.
`default_view`	A valid default calendar view choice.
`week_starts_on`	A valid day on which the week should start choice.
`show_getting_started`	Whether or not the "Getting Started" dialog should be shown.
`events_color`	A valid hex color code choice to determine the color events will be shown on the calendar
`default_reminder_offset`	The default offset when creating a new reminder.
`default_reminder_offset_type`	A valid default type of time offset choice when creating a new reminder.
`default_reminder_type`	A valid default type of reminder choice when creating a new reminder.
`receive_emails_from_admin`	Whether or not the `email` on file should receive bulletin emails.

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

# Interact with the API endpoint
$ coreapi action auth user settings update -p time_zone=... -p default_view=... -p week_starts_on=... -p show_getting_started=... -p events_color=... -p default_reminder_offset=... -p default_reminder_offset_type=... -p default_reminder_type=... -p receive_emails_from_admin=...

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 = ["auth", "user > settings > update"]
var params = {
    time_zone: ...,
    default_view: ...,
    week_starts_on: ...,
    show_getting_started: ...,
    events_color: ...,
    default_reminder_offset: ...,
    default_reminder_offset_type: ...,
    default_reminder_type: ...,
    receive_emails_from_admin: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["auth", "user > settings > update"]
params = {
    "time_zone": ...,
    "default_view": ...,
    "week_starts_on": ...,
    "show_getting_started": ...,
    "events_color": ...,
    "default_reminder_offset": ...,
    "default_reminder_offset_type": ...,
    "default_reminder_type": ...,
    "receive_emails_from_admin": ...,
}
result = client.action(schema, action, params=params)

feed

externalcalendars > list

GET /feed/externalcalendars/

Return a list of all external calendar instances for the authenticated user.

Query Parameters

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

Parameter	Description
`shown_on_calendar`

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

# Interact with the API endpoint
$ coreapi action feed externalcalendars list -p shown_on_calendar=...

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 = ["feed", "externalcalendars > list"]
var params = {
    shown_on_calendar: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

externalcalendars > create

POST /feed/externalcalendars/

Create a new external calendar instance for the authenticated user. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Request Body

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

Parameter	Description
`title` required	A display name.
`url` required	A public-facing URL to a valid ICAL feed.
`color`	A valid hex color code choice to determine the color items will be shown on the calendar
`shown_on_calendar`	Whether or not items should be shown on the calendar.

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

# Interact with the API endpoint
$ coreapi action feed externalcalendars create -p title=... -p url=... -p color=... -p shown_on_calendar=...

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 = ["feed", "externalcalendars > create"]
var params = {
    title: ...,
    url: ...,
    color: ...,
    shown_on_calendar: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["feed", "externalcalendars > create"]
params = {
    "title": ...,
    "url": ...,
    "color": ...,
    "shown_on_calendar": ...,
}
result = client.action(schema, action, params=params)

externalcalendars > read

GET /feed/externalcalendars/{id}/

Return the given external calendar instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this external calendar.

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

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

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 = ["feed", "externalcalendars > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

externalcalendars > update

PUT /feed/externalcalendars/{id}/

Update the given external calendar instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this external calendar.

Request Body

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

Parameter	Description
`title` required	A display name.
`url` required	A public-facing URL to a valid ICAL feed.
`color`	A valid hex color code choice to determine the color items will be shown on the calendar
`shown_on_calendar`	Whether or not items should be shown on the calendar.

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

# Interact with the API endpoint
$ coreapi action feed externalcalendars update -p id=... -p title=... -p url=... -p color=... -p shown_on_calendar=...

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 = ["feed", "externalcalendars > update"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    color: ...,
    shown_on_calendar: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["feed", "externalcalendars > update"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "color": ...,
    "shown_on_calendar": ...,
}
result = client.action(schema, action, params=params)

externalcalendars > delete

DELETE /feed/externalcalendars/{id}/

Delete the given external calendar instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this external calendar.

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

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

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 = ["feed", "externalcalendars > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

externalcalendars > events > list

GET /feed/externalcalendars/{id}/events/

Return an external calendar's ICAL feed items as a list of event instances. The IDs given for each event are sequential, unique only amongst the results of this particular query, and not guaranteed to be consistent across calls.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this external calendar.

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

# Interact with the API endpoint
$ coreapi action feed externalcalendars events list -p id=...

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 = ["feed", "externalcalendars > events > list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

private > disable

PUT /feed/private/disable/

Disable the private feed URLs for the authenticated user.

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

# Interact with the API endpoint
$ coreapi action feed private disable

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 = ["feed", "private > disable"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["feed", "private > disable"]
result = client.action(schema, action)

private > enable

PUT /feed/private/enable/

Enable the private feed URLs for the authenticated user. It is safe to make this request multiple times, and if private feeds are already enabled, the response will simply contain links to the feeds.

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

# Interact with the API endpoint
$ coreapi action feed private enable

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 = ["feed", "private > enable"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["feed", "private > enable"]
result = client.action(schema, action)

private > courseschedules.ics > list

GET /feed/private/{slug}/courseschedules.ics

:get Return a list of all course schedule instances for the authenticated user formatted for an ICAL stream. The response will contain a `Content-Disposition` of `attachment; filename=Helium_<username>_coursescheduleevents.ics`, so if the request is initiated from an HTML form, the response will be a downloadable file in a browser.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

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

# Interact with the API endpoint
$ coreapi action feed private courseschedules.ics list -p slug=...

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 = ["feed", "private > courseschedules.ics > list"]
var params = {
    slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["feed", "private > courseschedules.ics > list"]
params = {
    "slug": ...,
}
result = client.action(schema, action, params=params)

private > events.ics > list

GET /feed/private/{slug}/events.ics

:get Return a list of all event instances for the authenticated user formatted for an ICAL stream. The response will contain a `Content-Disposition` of `attachment; filename=Helium_<username>_events.ics`, so if the request is initiated from an HTML form, the response will be a downloadable file in a browser.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

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

# Interact with the API endpoint
$ coreapi action feed private events.ics list -p slug=...

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 = ["feed", "private > events.ics > list"]
var params = {
    slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["feed", "private > events.ics > list"]
params = {
    "slug": ...,
}
result = client.action(schema, action, params=params)

private > homework.ics > list

GET /feed/private/{slug}/homework.ics

:get Return a list of all homework instances for the authenticated user formatted for an ICAL stream. The response will contain a `Content-Disposition` of `attachment; filename=Helium_<username>_homework.ics`, so if the request is initiated from an HTML form, the response will be a downloadable file in a browser.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

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

# Interact with the API endpoint
$ coreapi action feed private homework.ics list -p slug=...

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 = ["feed", "private > homework.ics > list"]
var params = {
    slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["feed", "private > homework.ics > list"]
params = {
    "slug": ...,
}
result = client.action(schema, action, params=params)

importexport

export_data

GET /importexport/export/

Return an export of all non-sensitive data for the user. The response will contain a `Content-Disposition` of `attachment; filename=Helium_<username>.json`, so if the request is initiated from an HTML form, the response will be a downloadable file in a browser. The exported data for each model type will match that of the documented APIs.

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

# Interact with the API endpoint
$ coreapi action importexport export_data

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 = ["importexport", "export_data"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["importexport", "export_data"]
result = client.action(schema, action)

import_data

POST /importexport/import/

Import the resources for the authenticated user from the the uploaded files. Multiple files can be imported at once passed in the `file[]` field. The maximum file size for each upload is 10M. Each model will be imported in a schema matching that of the documented APIs.

Request Body

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

Parameter	Description
`username` required	A unique name used to login to the system.
`email` required	A unique and valid email address.
`old_password`	The current password for the user (required only when changing an existing password).
`password`	A password to set for the user.

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

# Interact with the API endpoint
$ coreapi action importexport import_data -p username=... -p email=... -p old_password=... -p password=...

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

import coreapi

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

# Interact with the API endpoint
action = ["importexport", "import_data"]
params = {
    "username": ...,
    "email": ...,
    "old_password": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

planner

attachments > list

GET /planner/attachments/

Return a list of all attachment instances for the authenticated user. To download the attachment, follow the link contained in the `attachment` field of an instance, which will direct you to attached media URL.

Query Parameters

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

Parameter	Description
`course`
`event`
`homework`

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

# Interact with the API endpoint
$ coreapi action planner attachments list -p course=... -p event=... -p homework=...

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 = ["planner", "attachments > list"]
var params = {
    course: ...,
    event: ...,
    homework: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "attachments > list"]
params = {
    "course": ...,
    "event": ...,
    "homework": ...,
}
result = client.action(schema, action, params=params)

attachments > create

POST /planner/attachments/

Create new attachment instances and upload the associated files for the authenticated user. Multiple files can be passed in the `file[]` field, but note that even if only one file is created, the response will still contain a list. The `title` attribute is set dynamically by the `filename` field passed for each file to be uploaded. The maximum file size for each upload is 10M. At least one of `course`, `event`, or `homework` must be given. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Request Body

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

Parameter	Description
`file[]`	A multipart list of files to upload.
`course`	The course with which to associate.
`event`	The event with which to associate.
`homework`	The homework with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner attachments create -p file[]=... -p course=... -p event=... -p homework=...

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 = ["planner", "attachments > create"]
var params = {
    file[]: ...,
    course: ...,
    event: ...,
    homework: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "attachments > create"]
params = {
    "file[]": ...,
    "course": ...,
    "event": ...,
    "homework": ...,
}
result = client.action(schema, action, params=params)

attachments > read

GET /planner/attachments/{id}/

Return the given attachment instance. To download the attachment, follow the link contained in the `attachment` field of an instance, which will direct you to attached media URL.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this attachment.

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

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

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 = ["planner", "attachments > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

attachments > delete

DELETE /planner/attachments/{id}/

Delete the given attachment instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this attachment.

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

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

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 = ["planner", "attachments > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

GET /planner/categories/

Return a list of all category instances for the authenticated user.

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

# Interact with the API endpoint
$ coreapi action planner categories list

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 = ["planner", "categories > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "categories > list"]
result = client.action(schema, action)

coursegroups > list

GET /planner/coursegroups/

Return a list of all course group instances for the authenticated user.

Query Parameters

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

Parameter	Description
`shown_on_calendar`
`start_date`
`start_date__gte`
`end_date`
`end_date__lte`

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

# Interact with the API endpoint
$ coreapi action planner coursegroups list -p shown_on_calendar=... -p start_date=... -p start_date__gte=... -p end_date=... -p end_date__lte=...

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 = ["planner", "coursegroups > list"]
var params = {
    shown_on_calendar: ...,
    start_date: ...,
    start_date__gte: ...,
    end_date: ...,
    end_date__lte: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > list"]
params = {
    "shown_on_calendar": ...,
    "start_date": ...,
    "start_date__gte": ...,
    "end_date": ...,
    "end_date__lte": ...,
}
result = client.action(schema, action, params=params)

coursegroups > create

POST /planner/coursegroups/

Create a new course group instance for the authenticated user. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Request Body

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

Parameter	Description
`title` required	A display name.
`start_date` required	An ISO-8601 date.
`end_date` required	An ISO-8601 date.
`shown_on_calendar`	Whether or not items should be shown on the calendar.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups create -p title=... -p start_date=... -p end_date=... -p shown_on_calendar=...

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 = ["planner", "coursegroups > create"]
var params = {
    title: ...,
    start_date: ...,
    end_date: ...,
    shown_on_calendar: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > create"]
params = {
    "title": ...,
    "start_date": ...,
    "end_date": ...,
    "shown_on_calendar": ...,
}
result = client.action(schema, action, params=params)

coursegroups > read

GET /planner/coursegroups/{id}/

Return the given course group instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this course group.

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

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

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 = ["planner", "coursegroups > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

coursegroups > update

PUT /planner/coursegroups/{id}/

Update the given course group instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this course group.

Request Body

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

Parameter	Description
`title` required	A display name.
`start_date` required	An ISO-8601 date.
`end_date` required	An ISO-8601 date.
`shown_on_calendar`	Whether or not items should be shown on the calendar.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups update -p id=... -p title=... -p start_date=... -p end_date=... -p shown_on_calendar=...

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 = ["planner", "coursegroups > update"]
var params = {
    id: ...,
    title: ...,
    start_date: ...,
    end_date: ...,
    shown_on_calendar: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > update"]
params = {
    "id": ...,
    "title": ...,
    "start_date": ...,
    "end_date": ...,
    "shown_on_calendar": ...,
}
result = client.action(schema, action, params=params)

coursegroups > delete

DELETE /planner/coursegroups/{id}/

Delete the given course group instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this course group.

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

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

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 = ["planner", "coursegroups > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

coursegroups > courses > list

GET /planner/coursegroups/{course_group}/courses/

Return a list of all course instances, including course schedule details, for the given course group.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.

Query Parameters

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

Parameter	Description
`start_date`
`start_date__gte`
`end_date`
`end_date__lte`

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses list -p course_group=... -p start_date=... -p start_date__gte=... -p end_date=... -p end_date__lte=...

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 = ["planner", "coursegroups > courses > list"]
var params = {
    course_group: ...,
    start_date: ...,
    start_date__gte: ...,
    end_date: ...,
    end_date__lte: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > list"]
params = {
    "course_group": ...,
    "start_date": ...,
    "start_date__gte": ...,
    "end_date": ...,
    "end_date__lte": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > create

POST /planner/coursegroups/{course_group}/courses/

Create a new course instance for the given course group. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.

Request Body

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

Parameter	Description
`title` required	A display name.
`room`	An arbitrary string.
`credits` required	A decimal corresponding to credit hours.
`color`	A valid hex color code choice to determine the color events will be shown on the calendar
`website`	A valid URL.
`is_online`	Whether or not the course is online (and thus may have times associated with it)
`teacher_name`	A display name for the teacher.
`teacher_email`	A valid email address.
`start_date` required	An ISO-8601 date.
`end_date` required	An ISO-8601 date.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses create -p course_group=... -p title=... -p room=... -p credits=... -p color=... -p website=... -p is_online=... -p teacher_name=... -p teacher_email=... -p start_date=... -p end_date=...

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 = ["planner", "coursegroups > courses > create"]
var params = {
    course_group: ...,
    title: ...,
    room: ...,
    credits: ...,
    color: ...,
    website: ...,
    is_online: ...,
    teacher_name: ...,
    teacher_email: ...,
    start_date: ...,
    end_date: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > create"]
params = {
    "course_group": ...,
    "title": ...,
    "room": ...,
    "credits": ...,
    "color": ...,
    "website": ...,
    "is_online": ...,
    "teacher_name": ...,
    "teacher_email": ...,
    "start_date": ...,
    "end_date": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > read

GET /planner/coursegroups/{course_group}/courses/{id}/

Return the given course instance, including course schedule details.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`id` required	A unique integer value identifying this course.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses read -p course_group=... -p id=...

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 = ["planner", "coursegroups > courses > read"]
var params = {
    course_group: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

coursegroups > courses > update

PUT /planner/coursegroups/{course_group}/courses/{id}/

Update the given course instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`id` required	A unique integer value identifying this course.

Request Body

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

Parameter	Description
`title` required	A display name.
`room`	An arbitrary string.
`credits` required	A decimal corresponding to credit hours.
`color`	A valid hex color code choice to determine the color events will be shown on the calendar
`website`	A valid URL.
`is_online`	Whether or not the course is online (and thus may have times associated with it)
`teacher_name`	A display name for the teacher.
`teacher_email`	A valid email address.
`start_date` required	An ISO-8601 date.
`end_date` required	An ISO-8601 date.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses update -p course_group=... -p id=... -p title=... -p room=... -p credits=... -p color=... -p website=... -p is_online=... -p teacher_name=... -p teacher_email=... -p start_date=... -p end_date=...

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 = ["planner", "coursegroups > courses > update"]
var params = {
    course_group: ...,
    id: ...,
    title: ...,
    room: ...,
    credits: ...,
    color: ...,
    website: ...,
    is_online: ...,
    teacher_name: ...,
    teacher_email: ...,
    start_date: ...,
    end_date: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > update"]
params = {
    "course_group": ...,
    "id": ...,
    "title": ...,
    "room": ...,
    "credits": ...,
    "color": ...,
    "website": ...,
    "is_online": ...,
    "teacher_name": ...,
    "teacher_email": ...,
    "start_date": ...,
    "end_date": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > delete

DELETE /planner/coursegroups/{course_group}/courses/{id}/

Delete the given course instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`id` required	A unique integer value identifying this course.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses delete -p course_group=... -p id=...

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 = ["planner", "coursegroups > courses > delete"]
var params = {
    course_group: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

GET /planner/coursegroups/{course_group}/courses/{course}/categories/

Return a list of all category instances for the given course.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses categories list -p course_group=... -p course=...

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 = ["planner", "coursegroups > courses > categories > list"]
var params = {
    course_group: ...,
    course: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > categories > list"]
params = {
    "course_group": ...,
    "course": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > categories > create

POST /planner/coursegroups/{course_group}/courses/{course}/categories/

Create a new category instance for the given course. Note that all weights associated with a single course cannot exceed a value of 100. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.

Request Body

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

Parameter	Description
`title` required	A display name.
`weight` required	A decimal weight for this category's homework (note that all weights associated with a single course cannot exceed a value of 100).
`color`	A valid hex color code choice to determine the color items will be shown on the calendar

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses categories create -p course_group=... -p course=... -p title=... -p weight=... -p color=...

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 = ["planner", "coursegroups > courses > categories > create"]
var params = {
    course_group: ...,
    course: ...,
    title: ...,
    weight: ...,
    color: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > categories > create"]
params = {
    "course_group": ...,
    "course": ...,
    "title": ...,
    "weight": ...,
    "color": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > categories > read

GET /planner/coursegroups/{course_group}/courses/{course}/categories/{id}/

Return the given category instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this category.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses categories read -p course_group=... -p course=... -p id=...

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 = ["planner", "coursegroups > courses > categories > read"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > categories > read"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > categories > update

PUT /planner/coursegroups/{course_group}/courses/{course}/categories/{id}/

Update the given category instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this category.

Request Body

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

Parameter	Description
`title` required	A display name.
`weight` required	A decimal weight for this category's homework (note that all weights associated with a single course cannot exceed a value of 100).
`color`	A valid hex color code choice to determine the color items will be shown on the calendar

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses categories update -p course_group=... -p course=... -p id=... -p title=... -p weight=... -p color=...

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 = ["planner", "coursegroups > courses > categories > update"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
    title: ...,
    weight: ...,
    color: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > categories > update"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
    "title": ...,
    "weight": ...,
    "color": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > categories > delete

DELETE /planner/coursegroups/{course_group}/courses/{course}/categories/{id}/

Delete the given category instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this category.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses categories delete -p course_group=... -p course=... -p id=...

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 = ["planner", "coursegroups > courses > categories > delete"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > categories > delete"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > courseschedules > list

GET /planner/coursegroups/{course_group}/courses/{course}/courseschedules/

Return a list of all course schedule instances for the given course.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses courseschedules list -p course_group=... -p course=...

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 = ["planner", "coursegroups > courses > courseschedules > list"]
var params = {
    course_group: ...,
    course: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > courseschedules > list"]
params = {
    "course_group": ...,
    "course": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > courseschedules > create

POST /planner/coursegroups/{course_group}/courses/{course}/courseschedules/

Create a new course schedule instance for the given course.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.

Request Body

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

Parameter	Description
`days_of_week`	Seven booleans (0 or 1) indicating which days of the week the course is on (week starts on Sunday).
`sun_start_time`	An ISO-8601 time.
`sun_end_time`	An ISO-8601 time.
`mon_start_time`	An ISO-8601 time.
`mon_end_time`	An ISO-8601 time.
`tue_start_time`	An ISO-8601 time.
`tue_end_time`	An ISO-8601 time.
`wed_start_time`	An ISO-8601 time.
`wed_end_time`	An ISO-8601 time.
`thu_start_time`	An ISO-8601 time.
`thu_end_time`	An ISO-8601 time.
`fri_start_time`	An ISO-8601 time.
`fri_end_time`	An ISO-8601 time.
`sat_start_time`	An ISO-8601 time.
`sat_end_time`	An ISO-8601 time.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses courseschedules create -p course_group=... -p course=... -p days_of_week=... -p sun_start_time=... -p sun_end_time=... -p mon_start_time=... -p mon_end_time=... -p tue_start_time=... -p tue_end_time=... -p wed_start_time=... -p wed_end_time=... -p thu_start_time=... -p thu_end_time=... -p fri_start_time=... -p fri_end_time=... -p sat_start_time=... -p sat_end_time=...

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 = ["planner", "coursegroups > courses > courseschedules > create"]
var params = {
    course_group: ...,
    course: ...,
    days_of_week: ...,
    sun_start_time: ...,
    sun_end_time: ...,
    mon_start_time: ...,
    mon_end_time: ...,
    tue_start_time: ...,
    tue_end_time: ...,
    wed_start_time: ...,
    wed_end_time: ...,
    thu_start_time: ...,
    thu_end_time: ...,
    fri_start_time: ...,
    fri_end_time: ...,
    sat_start_time: ...,
    sat_end_time: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > courseschedules > create"]
params = {
    "course_group": ...,
    "course": ...,
    "days_of_week": ...,
    "sun_start_time": ...,
    "sun_end_time": ...,
    "mon_start_time": ...,
    "mon_end_time": ...,
    "tue_start_time": ...,
    "tue_end_time": ...,
    "wed_start_time": ...,
    "wed_end_time": ...,
    "thu_start_time": ...,
    "thu_end_time": ...,
    "fri_start_time": ...,
    "fri_end_time": ...,
    "sat_start_time": ...,
    "sat_end_time": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > courseschedules > read

GET /planner/coursegroups/{course_group}/courses/{course}/courseschedules/{id}/

Return the given course schedule instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this course schedule.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses courseschedules read -p course_group=... -p course=... -p id=...

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 = ["planner", "coursegroups > courses > courseschedules > read"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > courseschedules > read"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > courseschedules > update

PUT /planner/coursegroups/{course_group}/courses/{course}/courseschedules/{id}/

Update the given course schedule instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this course schedule.

Request Body

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

Parameter	Description
`days_of_week`	Seven booleans (0 or 1) indicating which days of the week the course is on (week starts on Sunday).
`sun_start_time`	An ISO-8601 time.
`sun_end_time`	An ISO-8601 time.
`mon_start_time`	An ISO-8601 time.
`mon_end_time`	An ISO-8601 time.
`tue_start_time`	An ISO-8601 time.
`tue_end_time`	An ISO-8601 time.
`wed_start_time`	An ISO-8601 time.
`wed_end_time`	An ISO-8601 time.
`thu_start_time`	An ISO-8601 time.
`thu_end_time`	An ISO-8601 time.
`fri_start_time`	An ISO-8601 time.
`fri_end_time`	An ISO-8601 time.
`sat_start_time`	An ISO-8601 time.
`sat_end_time`	An ISO-8601 time.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses courseschedules update -p course_group=... -p course=... -p id=... -p days_of_week=... -p sun_start_time=... -p sun_end_time=... -p mon_start_time=... -p mon_end_time=... -p tue_start_time=... -p tue_end_time=... -p wed_start_time=... -p wed_end_time=... -p thu_start_time=... -p thu_end_time=... -p fri_start_time=... -p fri_end_time=... -p sat_start_time=... -p sat_end_time=...

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 = ["planner", "coursegroups > courses > courseschedules > update"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
    days_of_week: ...,
    sun_start_time: ...,
    sun_end_time: ...,
    mon_start_time: ...,
    mon_end_time: ...,
    tue_start_time: ...,
    tue_end_time: ...,
    wed_start_time: ...,
    wed_end_time: ...,
    thu_start_time: ...,
    thu_end_time: ...,
    fri_start_time: ...,
    fri_end_time: ...,
    sat_start_time: ...,
    sat_end_time: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > courseschedules > update"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
    "days_of_week": ...,
    "sun_start_time": ...,
    "sun_end_time": ...,
    "mon_start_time": ...,
    "mon_end_time": ...,
    "tue_start_time": ...,
    "tue_end_time": ...,
    "wed_start_time": ...,
    "wed_end_time": ...,
    "thu_start_time": ...,
    "thu_end_time": ...,
    "fri_start_time": ...,
    "fri_end_time": ...,
    "sat_start_time": ...,
    "sat_end_time": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > courseschedules > delete

DELETE /planner/coursegroups/{course_group}/courses/{course}/courseschedules/{id}/

Delete the given course schedule instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this course schedule.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses courseschedules delete -p course_group=... -p course=... -p id=...

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 = ["planner", "coursegroups > courses > courseschedules > delete"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > courseschedules > delete"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > courseschedules > events > list

GET /planner/coursegroups/{course_group}/courses/{course}/courseschedules/events/

Return all course schedules as a list of event instances.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this course schedule.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses courseschedules events list -p course_group=... -p course=... -p id=...

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 = ["planner", "coursegroups > courses > courseschedules > events > list"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > courseschedules > events > list"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > homework > list

GET /planner/coursegroups/{course_group}/courses/{course}/homework/

Return a list of all homework instances for the given course. For convenience, homework instances on a GET are serialized with representations of associated attachments and reminders to avoid the need for redundant API calls.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.

Query Parameters

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

Parameter	Description
`start`
`start__gte`
`end`
`end__lt`
`completed`
`category`

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses homework list -p course_group=... -p course=... -p start=... -p start__gte=... -p end=... -p end__lt=... -p completed=... -p category=...

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 = ["planner", "coursegroups > courses > homework > list"]
var params = {
    course_group: ...,
    course: ...,
    start: ...,
    start__gte: ...,
    end: ...,
    end__lt: ...,
    completed: ...,
    category: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > homework > list"]
params = {
    "course_group": ...,
    "course": ...,
    "start": ...,
    "start__gte": ...,
    "end": ...,
    "end__lt": ...,
    "completed": ...,
    "category": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > homework > create

POST /planner/coursegroups/{course_group}/courses/{course}/homework/

Create a new homework instance for the given course. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.

Request Body

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

Parameter	Description
`title` required	A display name.
`all_day`	Whether or not it is an all day event.
`show_end_time`	Whether or not the end time should be shown on the calendar.
`start` required	An ISO-8601 date.
`end` required	An ISO-8601 date.
`priority`	A priority integer between 0 and 100.
`url`	An optional URL that the calendar item references.
`comments`	An arbitrary string (which may contain HTML formatting).
`current_grade` required	The current grade in fraction form (ex. 25/30).
`completed`	Whether or not the homework has been completed.
`category`	The category with which to associate.
`materials`	A list of materials with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses homework create -p course_group=... -p course=... -p title=... -p all_day=... -p show_end_time=... -p start=... -p end=... -p priority=... -p url=... -p comments=... -p current_grade=... -p completed=... -p category=... -p materials=...

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 = ["planner", "coursegroups > courses > homework > create"]
var params = {
    course_group: ...,
    course: ...,
    title: ...,
    all_day: ...,
    show_end_time: ...,
    start: ...,
    end: ...,
    priority: ...,
    url: ...,
    comments: ...,
    current_grade: ...,
    completed: ...,
    category: ...,
    materials: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > homework > create"]
params = {
    "course_group": ...,
    "course": ...,
    "title": ...,
    "all_day": ...,
    "show_end_time": ...,
    "start": ...,
    "end": ...,
    "priority": ...,
    "url": ...,
    "comments": ...,
    "current_grade": ...,
    "completed": ...,
    "category": ...,
    "materials": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > homework > read

GET /planner/coursegroups/{course_group}/courses/{course}/homework/{id}/

Return the given homework instance. For convenience, homework instances on a GET are serialized with representations of associated attachments and reminders to avoid the need for redundant API calls.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this homework.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses homework read -p course_group=... -p course=... -p id=...

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 = ["planner", "coursegroups > courses > homework > read"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > homework > read"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > homework > update

PUT /planner/coursegroups/{course_group}/courses/{course}/homework/{id}/

Update the given homework instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this homework.

Request Body

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

Parameter	Description
`title` required	A display name.
`all_day`	Whether or not it is an all day event.
`show_end_time`	Whether or not the end time should be shown on the calendar.
`start` required	An ISO-8601 date.
`end` required	An ISO-8601 date.
`priority`	A priority integer between 0 and 100.
`url`	An optional URL that the calendar item references.
`comments`	An arbitrary string (which may contain HTML formatting).
`current_grade` required	The current grade in fraction form (ex. 25/30).
`completed`	Whether or not the homework has been completed.
`category`	The category with which to associate.
`materials`	A list of materials with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses homework update -p course_group=... -p course=... -p id=... -p title=... -p all_day=... -p show_end_time=... -p start=... -p end=... -p priority=... -p url=... -p comments=... -p current_grade=... -p completed=... -p category=... -p materials=...

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 = ["planner", "coursegroups > courses > homework > update"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
    title: ...,
    all_day: ...,
    show_end_time: ...,
    start: ...,
    end: ...,
    priority: ...,
    url: ...,
    comments: ...,
    current_grade: ...,
    completed: ...,
    category: ...,
    materials: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > homework > update"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
    "title": ...,
    "all_day": ...,
    "show_end_time": ...,
    "start": ...,
    "end": ...,
    "priority": ...,
    "url": ...,
    "comments": ...,
    "current_grade": ...,
    "completed": ...,
    "category": ...,
    "materials": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > homework > partial_update

PATCH /planner/coursegroups/{course_group}/courses/{course}/homework/{id}/

Update only the given attributes of the given homework instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this homework.

Request Body

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

Parameter	Description
`title`	A display name.
`all_day`	Whether or not it is an all day event.
`show_end_time`	Whether or not the end time should be shown on the calendar.
`start`	An ISO-8601 date.
`end`	An ISO-8601 date.
`priority`	A priority integer between 0 and 100.
`url`	An optional URL that the calendar item references.
`comments`	An arbitrary string (which may contain HTML formatting).
`current_grade`	The current grade in fraction form (ex. 25/30).
`completed`	Whether or not the homework has been completed.
`category`	The category with which to associate.
`materials`	A list of materials with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses homework partial_update -p course_group=... -p course=... -p id=... -p title=... -p all_day=... -p show_end_time=... -p start=... -p end=... -p priority=... -p url=... -p comments=... -p current_grade=... -p completed=... -p category=... -p materials=...

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 = ["planner", "coursegroups > courses > homework > partial_update"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
    title: ...,
    all_day: ...,
    show_end_time: ...,
    start: ...,
    end: ...,
    priority: ...,
    url: ...,
    comments: ...,
    current_grade: ...,
    completed: ...,
    category: ...,
    materials: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > homework > partial_update"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
    "title": ...,
    "all_day": ...,
    "show_end_time": ...,
    "start": ...,
    "end": ...,
    "priority": ...,
    "url": ...,
    "comments": ...,
    "current_grade": ...,
    "completed": ...,
    "category": ...,
    "materials": ...,
}
result = client.action(schema, action, params=params)

coursegroups > courses > homework > delete

DELETE /planner/coursegroups/{course_group}/courses/{course}/homework/{id}/

Delete the given homework instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course_group` required	The course group with which to associate.
`course` required	The course with which to associate.
`id` required	A unique integer value identifying this homework.

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

# Interact with the API endpoint
$ coreapi action planner coursegroups courses homework delete -p course_group=... -p course=... -p id=...

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 = ["planner", "coursegroups > courses > homework > delete"]
var params = {
    course_group: ...,
    course: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "coursegroups > courses > homework > delete"]
params = {
    "course_group": ...,
    "course": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

courses > list

GET /planner/courses/

Return a list of all course instances for the authenticated user, including course schedule details.

Query Parameters

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

Parameter	Description
`start_date`
`start_date__gte`
`end_date`
`end_date__lte`

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

# Interact with the API endpoint
$ coreapi action planner courses list -p start_date=... -p start_date__gte=... -p end_date=... -p end_date__lte=...

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 = ["planner", "courses > list"]
var params = {
    start_date: ...,
    start_date__gte: ...,
    end_date: ...,
    end_date__lte: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "courses > list"]
params = {
    "start_date": ...,
    "start_date__gte": ...,
    "end_date": ...,
    "end_date__lte": ...,
}
result = client.action(schema, action, params=params)

events > list

GET /planner/events/

Return a list of all event instances for the authenticated user. For convenience, event instances on a GET are serialized with representations of associated attachments and reminders to avoid the need for redundant API calls.

Query Parameters

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

Parameter	Description
`start`
`start__gte`
`end`
`end__lt`
`search`	A search term.
`ordering`	Which field to use when ordering the results.

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

# Interact with the API endpoint
$ coreapi action planner events list -p start=... -p start__gte=... -p end=... -p end__lt=... -p search=... -p ordering=...

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 = ["planner", "events > list"]
var params = {
    start: ...,
    start__gte: ...,
    end: ...,
    end__lt: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "events > list"]
params = {
    "start": ...,
    "start__gte": ...,
    "end": ...,
    "end__lt": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

events > create

POST /planner/events/

Create a new event instance for the authenticated user. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Request Body

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

Parameter	Description
`title` required	A display name.
`all_day`	Whether or not it is an all day event.
`show_end_time`	Whether or not the end time should be shown on the calendar.
`start` required	An ISO-8601 date.
`end` required	An ISO-8601 date.
`priority`	A priority integer between 0 and 100.
`url`	An optional URL that the calendar item references.
`comments`	An arbitrary string (which may contain HTML formatting).
`owner_id`	An arbitrary string identifying the owning resource.

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

# Interact with the API endpoint
$ coreapi action planner events create -p title=... -p all_day=... -p show_end_time=... -p start=... -p end=... -p priority=... -p url=... -p comments=... -p owner_id=...

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 = ["planner", "events > create"]
var params = {
    title: ...,
    all_day: ...,
    show_end_time: ...,
    start: ...,
    end: ...,
    priority: ...,
    url: ...,
    comments: ...,
    owner_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "events > create"]
params = {
    "title": ...,
    "all_day": ...,
    "show_end_time": ...,
    "start": ...,
    "end": ...,
    "priority": ...,
    "url": ...,
    "comments": ...,
    "owner_id": ...,
}
result = client.action(schema, action, params=params)

events > delete_all

DELETE /planner/events/delete/

Delete all events for the authenticated user.

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

# Interact with the API endpoint
$ coreapi action planner events delete_all

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 = ["planner", "events > delete_all"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "events > delete_all"]
result = client.action(schema, action)

events > read

GET /planner/events/{id}/

Return the given event instance. For convenience, event instances on a GET are serialized with representations of associated attachments and reminders to avoid the need for redundant API calls.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this event.

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

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

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 = ["planner", "events > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

events > update

PUT /planner/events/{id}/

Update the given event instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this event.

Request Body

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

Parameter	Description
`title` required	A display name.
`all_day`	Whether or not it is an all day event.
`show_end_time`	Whether or not the end time should be shown on the calendar.
`start` required	An ISO-8601 date.
`end` required	An ISO-8601 date.
`priority`	A priority integer between 0 and 100.
`url`	An optional URL that the calendar item references.
`comments`	An arbitrary string (which may contain HTML formatting).
`owner_id`	An arbitrary string identifying the owning resource.

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

# Interact with the API endpoint
$ coreapi action planner events update -p id=... -p title=... -p all_day=... -p show_end_time=... -p start=... -p end=... -p priority=... -p url=... -p comments=... -p owner_id=...

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 = ["planner", "events > update"]
var params = {
    id: ...,
    title: ...,
    all_day: ...,
    show_end_time: ...,
    start: ...,
    end: ...,
    priority: ...,
    url: ...,
    comments: ...,
    owner_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "events > update"]
params = {
    "id": ...,
    "title": ...,
    "all_day": ...,
    "show_end_time": ...,
    "start": ...,
    "end": ...,
    "priority": ...,
    "url": ...,
    "comments": ...,
    "owner_id": ...,
}
result = client.action(schema, action, params=params)

events > partial_update

PATCH /planner/events/{id}/

Update only the given attributes of the given event instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this event.

Request Body

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

Parameter	Description
`title`	A display name.
`all_day`	Whether or not it is an all day event.
`show_end_time`	Whether or not the end time should be shown on the calendar.
`start`	An ISO-8601 date.
`end`	An ISO-8601 date.
`priority`	A priority integer between 0 and 100.
`url`	An optional URL that the calendar item references.
`comments`	An arbitrary string (which may contain HTML formatting).
`owner_id`	An arbitrary string identifying the owning resource.

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

# Interact with the API endpoint
$ coreapi action planner events partial_update -p id=... -p title=... -p all_day=... -p show_end_time=... -p start=... -p end=... -p priority=... -p url=... -p comments=... -p owner_id=...

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 = ["planner", "events > partial_update"]
var params = {
    id: ...,
    title: ...,
    all_day: ...,
    show_end_time: ...,
    start: ...,
    end: ...,
    priority: ...,
    url: ...,
    comments: ...,
    owner_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "events > partial_update"]
params = {
    "id": ...,
    "title": ...,
    "all_day": ...,
    "show_end_time": ...,
    "start": ...,
    "end": ...,
    "priority": ...,
    "url": ...,
    "comments": ...,
    "owner_id": ...,
}
result = client.action(schema, action, params=params)

events > delete

DELETE /planner/events/{id}/

Delete the given event instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this event.

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

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

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 = ["planner", "events > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

grades > list

GET /planner/grades/

Return the grades for the authenticated user. The result is a list of course groups. Each course group contains a nested list of courses. Each course contains a nested list of categories. Each entity contains three fields: `id`, `overall_grade`, and `grade_points`. `grade_points` represents a list of grades accumulating over time. This is a list made up of individual grade points, each a tuple containing two values of the format [time, grade_at_time].

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

# Interact with the API endpoint
$ coreapi action planner grades list

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 = ["planner", "grades > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "grades > list"]
result = client.action(schema, action)

homework > list

GET /planner/homework/

Return a list of all homework instances for the authenticated user. For convenience, homework instances on a GET are serialized with representations of associated attachments and reminders to avoid the need for redundant API calls.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`course` required	The course with which to associate.
`course_group` required	The course group with which to associate.

Query Parameters

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

Parameter	Description
`start`
`start__gte`
`end`
`end__lt`
`completed`
`category`
`search`	A search term.
`ordering`	Which field to use when ordering the results.

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

# Interact with the API endpoint
$ coreapi action planner homework list -p start=... -p start__gte=... -p end=... -p end__lt=... -p completed=... -p category=... -p search=... -p ordering=... -p course=... -p course_group=...

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 = ["planner", "homework > list"]
var params = {
    start: ...,
    start__gte: ...,
    end: ...,
    end__lt: ...,
    completed: ...,
    category: ...,
    search: ...,
    ordering: ...,
    course: ...,
    course_group: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "homework > list"]
params = {
    "start": ...,
    "start__gte": ...,
    "end": ...,
    "end__lt": ...,
    "completed": ...,
    "category": ...,
    "search": ...,
    "ordering": ...,
    "course": ...,
    "course_group": ...,
}
result = client.action(schema, action, params=params)

materialgroups > list

GET /planner/materialgroups/

Return a list of all material group instances for the authenticated user.

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

# Interact with the API endpoint
$ coreapi action planner materialgroups list

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 = ["planner", "materialgroups > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "materialgroups > list"]
result = client.action(schema, action)

materialgroups > create

POST /planner/materialgroups/

Create a new material group instance for the authenticated user. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Request Body

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

Parameter	Description
`title` required	A display name.
`shown_on_calendar`	Whether or not items should be shown on the calendar.

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

# Interact with the API endpoint
$ coreapi action planner materialgroups create -p title=... -p shown_on_calendar=...

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 = ["planner", "materialgroups > create"]
var params = {
    title: ...,
    shown_on_calendar: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "materialgroups > create"]
params = {
    "title": ...,
    "shown_on_calendar": ...,
}
result = client.action(schema, action, params=params)

materialgroups > read

GET /planner/materialgroups/{id}/

Return the given material group instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this material group.

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

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

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 = ["planner", "materialgroups > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

materialgroups > update

PUT /planner/materialgroups/{id}/

Update the given material group instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this material group.

Request Body

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

Parameter	Description
`title` required	A display name.
`shown_on_calendar`	Whether or not items should be shown on the calendar.

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

# Interact with the API endpoint
$ coreapi action planner materialgroups update -p id=... -p title=... -p shown_on_calendar=...

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 = ["planner", "materialgroups > update"]
var params = {
    id: ...,
    title: ...,
    shown_on_calendar: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "materialgroups > update"]
params = {
    "id": ...,
    "title": ...,
    "shown_on_calendar": ...,
}
result = client.action(schema, action, params=params)

materialgroups > delete

DELETE /planner/materialgroups/{id}/

Delete the given material group instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this material group.

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

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

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 = ["planner", "materialgroups > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

materialgroups > materials > list

GET /planner/materialgroups/{material_group}/materials/

Return a list of all material instances for the given material group.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`material_group` required	The material group with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner materialgroups materials list -p material_group=...

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 = ["planner", "materialgroups > materials > list"]
var params = {
    material_group: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "materialgroups > materials > list"]
params = {
    "material_group": ...,
}
result = client.action(schema, action, params=params)

materialgroups > materials > create

POST /planner/materialgroups/{material_group}/materials/

Create a new material instance for the given material group. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`material_group` required	The material group with which to associate.

Request Body

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

Parameter	Description
`title` required	A display name.
`status`	A valid material status choice.
`condition`	A valid material condition choice.
`website`	A valid URL.
`price`	A price string.
`details`	An arbitrary string (which may contain HTML formatting).
`courses`	A list of courses with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner materialgroups materials create -p material_group=... -p title=... -p status=... -p condition=... -p website=... -p price=... -p details=... -p courses=...

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 = ["planner", "materialgroups > materials > create"]
var params = {
    material_group: ...,
    title: ...,
    status: ...,
    condition: ...,
    website: ...,
    price: ...,
    details: ...,
    courses: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "materialgroups > materials > create"]
params = {
    "material_group": ...,
    "title": ...,
    "status": ...,
    "condition": ...,
    "website": ...,
    "price": ...,
    "details": ...,
    "courses": ...,
}
result = client.action(schema, action, params=params)

materialgroups > materials > read

GET /planner/materialgroups/{material_group}/materials/{id}/

Return the given material instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`material_group` required	The material group with which to associate.
`id` required	A unique integer value identifying this material.

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

# Interact with the API endpoint
$ coreapi action planner materialgroups materials read -p material_group=... -p id=...

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 = ["planner", "materialgroups > materials > read"]
var params = {
    material_group: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

materialgroups > materials > update

PUT /planner/materialgroups/{material_group}/materials/{id}/

Update the given material instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`material_group` required	The material group with which to associate.
`id` required	A unique integer value identifying this material.

Request Body

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

Parameter	Description
`title` required	A display name.
`status`	A valid material status choice.
`condition`	A valid material condition choice.
`website`	A valid URL.
`price`	A price string.
`details`	An arbitrary string (which may contain HTML formatting).
`courses`	A list of courses with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner materialgroups materials update -p material_group=... -p id=... -p title=... -p status=... -p condition=... -p website=... -p price=... -p details=... -p courses=...

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 = ["planner", "materialgroups > materials > update"]
var params = {
    material_group: ...,
    id: ...,
    title: ...,
    status: ...,
    condition: ...,
    website: ...,
    price: ...,
    details: ...,
    courses: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "materialgroups > materials > update"]
params = {
    "material_group": ...,
    "id": ...,
    "title": ...,
    "status": ...,
    "condition": ...,
    "website": ...,
    "price": ...,
    "details": ...,
    "courses": ...,
}
result = client.action(schema, action, params=params)

materialgroups > materials > delete

DELETE /planner/materialgroups/{material_group}/materials/{id}/

Delete the given material instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`material_group` required	The material group with which to associate.
`id` required	A unique integer value identifying this material.

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

# Interact with the API endpoint
$ coreapi action planner materialgroups materials delete -p material_group=... -p id=...

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 = ["planner", "materialgroups > materials > delete"]
var params = {
    material_group: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

materials > list

GET /planner/materials/

Return a list of all material instances for the authenticated user.

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

# Interact with the API endpoint
$ coreapi action planner materials list

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 = ["planner", "materials > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "materials > list"]
result = client.action(schema, action)

reminders > list

GET /planner/reminders/

Return a list of all reminder instances for the authenticated user. For convenience, reminder instances on a GET are serialized to a depth of two to avoid the need for redundant API calls.

Query Parameters

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

Parameter	Description
`event`
`homework`
`type`
`sent`
`start_of_range__lte`

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

# Interact with the API endpoint
$ coreapi action planner reminders list -p event=... -p homework=... -p type=... -p sent=... -p start_of_range__lte=...

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 = ["planner", "reminders > list"]
var params = {
    event: ...,
    homework: ...,
    type: ...,
    sent: ...,
    start_of_range__lte: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "reminders > list"]
params = {
    "event": ...,
    "homework": ...,
    "type": ...,
    "sent": ...,
    "start_of_range__lte": ...,
}
result = client.action(schema, action, params=params)

reminders > create

POST /planner/reminders/

Create a new reminder instance for the authenticated user. For more details pertaining to choice field values, [see here](https://github.com/HeliumEdu/platform/wiki#choices).

Request Body

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

Parameter	Description
`title` required	A display name.
`message` required	A string that will be used as the reminder message (may contain HTML formatting).
`offset`	The number of units (in `offset_type`) from the offset.
`offset_type`	A valid reminder offset type choice.
`type`	A valid reminder type choice.
`sent`	Whether or not the reminder has been sent.
`homework`	The homework with which to associate.
`event`	The event with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner reminders create -p title=... -p message=... -p offset=... -p offset_type=... -p type=... -p sent=... -p homework=... -p event=...

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 = ["planner", "reminders > create"]
var params = {
    title: ...,
    message: ...,
    offset: ...,
    offset_type: ...,
    type: ...,
    sent: ...,
    homework: ...,
    event: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "reminders > create"]
params = {
    "title": ...,
    "message": ...,
    "offset": ...,
    "offset_type": ...,
    "type": ...,
    "sent": ...,
    "homework": ...,
    "event": ...,
}
result = client.action(schema, action, params=params)

reminders > read

GET /planner/reminders/{id}/

Return the given reminder instance. For convenience, reminder instances on a GET are serialized to a depth of two to avoid the need for redundant API calls.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this reminder.

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

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

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 = ["planner", "reminders > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

reminders > update

PUT /planner/reminders/{id}/

Update the given reminder instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this reminder.

Request Body

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

Parameter	Description
`title` required	A display name.
`message` required	A string that will be used as the reminder message (may contain HTML formatting).
`offset`	The number of units (in `offset_type`) from the offset.
`offset_type`	A valid reminder offset type choice.
`type`	A valid reminder type choice.
`sent`	Whether or not the reminder has been sent.
`homework`	The homework with which to associate.
`event`	The event with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner reminders update -p id=... -p title=... -p message=... -p offset=... -p offset_type=... -p type=... -p sent=... -p homework=... -p event=...

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 = ["planner", "reminders > update"]
var params = {
    id: ...,
    title: ...,
    message: ...,
    offset: ...,
    offset_type: ...,
    type: ...,
    sent: ...,
    homework: ...,
    event: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "reminders > update"]
params = {
    "id": ...,
    "title": ...,
    "message": ...,
    "offset": ...,
    "offset_type": ...,
    "type": ...,
    "sent": ...,
    "homework": ...,
    "event": ...,
}
result = client.action(schema, action, params=params)

reminders > partial_update

PATCH /planner/reminders/{id}/

Update only the given attributes of the given reminder instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this reminder.

Request Body

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

Parameter	Description
`title`	A display name.
`message`	A string that will be used as the reminder message (may contain HTML formatting).
`offset`	The number of units (in `offset_type`) from the offset.
`offset_type`	A valid reminder offset type choice.
`type`	A valid reminder type choice.
`sent`	Whether or not the reminder has been sent.
`homework`	The homework with which to associate.
`event`	The event with which to associate.

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

# Interact with the API endpoint
$ coreapi action planner reminders partial_update -p id=... -p title=... -p message=... -p offset=... -p offset_type=... -p type=... -p sent=... -p homework=... -p event=...

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 = ["planner", "reminders > partial_update"]
var params = {
    id: ...,
    title: ...,
    message: ...,
    offset: ...,
    offset_type: ...,
    type: ...,
    sent: ...,
    homework: ...,
    event: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

# Interact with the API endpoint
action = ["planner", "reminders > partial_update"]
params = {
    "id": ...,
    "title": ...,
    "message": ...,
    "offset": ...,
    "offset_type": ...,
    "type": ...,
    "sent": ...,
    "homework": ...,
    "event": ...,
}
result = client.action(schema, action, params=params)

reminders > delete

DELETE /planner/reminders/{id}/

Delete the given reminder instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this reminder.

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

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

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 = ["planner", "reminders > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

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

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

health

GET /health/

Check the health of this node and its dependencies.

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

# Interact with the API endpoint
$ coreapi action health

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

import coreapi

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

# Interact with the API endpoint
action = ["health"]
result = client.action(schema, action)

info

GET /info/

Return version and configuration information about the app.

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

# Interact with the API endpoint
$ coreapi action info

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

import coreapi

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

# Interact with the API endpoint
action = ["info"]
result = client.action(schema, action)

status

GET /status/

Check the status of the system and its dependencies.

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

# Interact with the API endpoint
$ coreapi action status

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

import coreapi

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

# Interact with the API endpoint
action = ["status"]
result = client.action(schema, action)