LEGO

LEGO Er Ganske Oppdelt

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

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

# Install the Python client library
$ pip install coreapi

announcements

list

GET /api/v1/announcements/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action announcements list -p cursor=...

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 = ["announcements", "list"]
var params = {
    cursor: ...,
}
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("/api/")

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

create

POST /api/v1/announcements/

Request Body

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

Parameter	Description
`message` required
`from_group`
`users`
`groups`
`events`
`exclude_waiting_list`
`meetings`
`meeting_invitation_status`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action announcements create -p message=... -p from_group=... -p users=... -p groups=... -p events=... -p exclude_waiting_list=... -p meetings=... -p meeting_invitation_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 = ["announcements", "create"]
var params = {
    message: ...,
    from_group: ...,
    users: ...,
    groups: ...,
    events: ...,
    exclude_waiting_list: ...,
    meetings: ...,
    meeting_invitation_status: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["announcements", "create"]
params = {
    "message": ...,
    "from_group": ...,
    "users": ...,
    "groups": ...,
    "events": ...,
    "exclude_waiting_list": ...,
    "meetings": ...,
    "meeting_invitation_status": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/announcements/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action announcements 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 = ["announcements", "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("/api/")

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

update

PUT /api/v1/announcements/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

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

Parameter	Description
`message` required
`from_group`
`users`
`groups`
`events`
`exclude_waiting_list`
`meetings`
`meeting_invitation_status`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action announcements update -p id=... -p message=... -p from_group=... -p users=... -p groups=... -p events=... -p exclude_waiting_list=... -p meetings=... -p meeting_invitation_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 = ["announcements", "update"]
var params = {
    id: ...,
    message: ...,
    from_group: ...,
    users: ...,
    groups: ...,
    events: ...,
    exclude_waiting_list: ...,
    meetings: ...,
    meeting_invitation_status: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["announcements", "update"]
params = {
    "id": ...,
    "message": ...,
    "from_group": ...,
    "users": ...,
    "groups": ...,
    "events": ...,
    "exclude_waiting_list": ...,
    "meetings": ...,
    "meeting_invitation_status": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/announcements/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

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

Parameter	Description
`message`
`from_group`
`users`
`groups`
`events`
`exclude_waiting_list`
`meetings`
`meeting_invitation_status`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action announcements partial_update -p id=... -p message=... -p from_group=... -p users=... -p groups=... -p events=... -p exclude_waiting_list=... -p meetings=... -p meeting_invitation_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 = ["announcements", "partial_update"]
var params = {
    id: ...,
    message: ...,
    from_group: ...,
    users: ...,
    groups: ...,
    events: ...,
    exclude_waiting_list: ...,
    meetings: ...,
    meeting_invitation_status: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["announcements", "partial_update"]
params = {
    "id": ...,
    "message": ...,
    "from_group": ...,
    "users": ...,
    "groups": ...,
    "events": ...,
    "exclude_waiting_list": ...,
    "meetings": ...,
    "meeting_invitation_status": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/announcements/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action announcements 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 = ["announcements", "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("/api/")

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

send

POST /api/v1/announcements/{id}/send/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

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

Parameter	Description
`message` required
`from_group`
`users`
`groups`
`events`
`exclude_waiting_list`
`meetings`
`meeting_invitation_status`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action announcements send -p id=... -p message=... -p from_group=... -p users=... -p groups=... -p events=... -p exclude_waiting_list=... -p meetings=... -p meeting_invitation_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 = ["announcements", "send"]
var params = {
    id: ...,
    message: ...,
    from_group: ...,
    users: ...,
    groups: ...,
    events: ...,
    exclude_waiting_list: ...,
    meetings: ...,
    meeting_invitation_status: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["announcements", "send"]
params = {
    "id": ...,
    "message": ...,
    "from_group": ...,
    "users": ...,
    "groups": ...,
    "events": ...,
    "exclude_waiting_list": ...,
    "meetings": ...,
    "meeting_invitation_status": ...,
}
result = client.action(schema, action, params=params)

articles

list

GET /api/v1/articles/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`tag`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action articles list -p cursor=... -p tag=...

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 = ["articles", "list"]
var params = {
    cursor: ...,
    tag: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["articles", "list"]
params = {
    "cursor": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/articles/

Request Body

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

Parameter	Description
`title` required
`slug`
`cover`
`cover_placeholder`
`authors` required
`description` required
`tags`
`content` required
`pinned`
`youtube_url`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action articles create -p title=... -p slug=... -p cover=... -p cover_placeholder=... -p authors=... -p description=... -p tags=... -p content=... -p pinned=... -p youtube_url=...

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 = ["articles", "create"]
var params = {
    title: ...,
    slug: ...,
    cover: ...,
    cover_placeholder: ...,
    authors: ...,
    description: ...,
    tags: ...,
    content: ...,
    pinned: ...,
    youtube_url: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["articles", "create"]
params = {
    "title": ...,
    "slug": ...,
    "cover": ...,
    "cover_placeholder": ...,
    "authors": ...,
    "description": ...,
    "tags": ...,
    "content": ...,
    "pinned": ...,
    "youtube_url": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/articles/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`tag`

# Load the schema document
$ coreapi get /api/

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

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 = ["articles", "read"]
var params = {
    id: ...,
    tag: ...,
}
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("/api/")

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

update

PUT /api/v1/articles/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`tag`

Request Body

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

Parameter	Description
`title` required
`slug`
`cover`
`cover_placeholder`
`authors` required
`description` required
`tags`
`content` required
`pinned`
`youtube_url`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action articles update -p id=... -p title=... -p slug=... -p cover=... -p cover_placeholder=... -p authors=... -p description=... -p tags=... -p content=... -p pinned=... -p youtube_url=... -p tag=...

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 = ["articles", "update"]
var params = {
    id: ...,
    title: ...,
    slug: ...,
    cover: ...,
    cover_placeholder: ...,
    authors: ...,
    description: ...,
    tags: ...,
    content: ...,
    pinned: ...,
    youtube_url: ...,
    tag: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["articles", "update"]
params = {
    "id": ...,
    "title": ...,
    "slug": ...,
    "cover": ...,
    "cover_placeholder": ...,
    "authors": ...,
    "description": ...,
    "tags": ...,
    "content": ...,
    "pinned": ...,
    "youtube_url": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/articles/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`tag`

Request Body

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

Parameter	Description
`title`
`slug`
`cover`
`cover_placeholder`
`authors`
`description`
`tags`
`content`
`pinned`
`youtube_url`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action articles partial_update -p id=... -p title=... -p slug=... -p cover=... -p cover_placeholder=... -p authors=... -p description=... -p tags=... -p content=... -p pinned=... -p youtube_url=... -p tag=...

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 = ["articles", "partial_update"]
var params = {
    id: ...,
    title: ...,
    slug: ...,
    cover: ...,
    cover_placeholder: ...,
    authors: ...,
    description: ...,
    tags: ...,
    content: ...,
    pinned: ...,
    youtube_url: ...,
    tag: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["articles", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "slug": ...,
    "cover": ...,
    "cover_placeholder": ...,
    "authors": ...,
    "description": ...,
    "tags": ...,
    "content": ...,
    "pinned": ...,
    "youtube_url": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/articles/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`tag`

# Load the schema document
$ coreapi get /api/

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

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 = ["articles", "delete"]
var params = {
    id: ...,
    tag: ...,
}
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("/api/")

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

bdb

list

GET /api/v1/bdb/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action bdb 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 = ["bdb", "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("/api/")

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

create

POST /api/v1/bdb/

Request Body

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

Parameter	Description
`name` required
`description`
`phone`
`company_type`
`website`
`address`
`payment_mail`
`active`
`admin_comment`
`logo`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action bdb create -p name=... -p description=... -p phone=... -p company_type=... -p website=... -p address=... -p payment_mail=... -p active=... -p admin_comment=... -p logo=...

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 = ["bdb", "create"]
var params = {
    name: ...,
    description: ...,
    phone: ...,
    company_type: ...,
    website: ...,
    address: ...,
    payment_mail: ...,
    active: ...,
    admin_comment: ...,
    logo: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["bdb", "create"]
params = {
    "name": ...,
    "description": ...,
    "phone": ...,
    "company_type": ...,
    "website": ...,
    "address": ...,
    "payment_mail": ...,
    "active": ...,
    "admin_comment": ...,
    "logo": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/bdb/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action bdb 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 = ["bdb", "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("/api/")

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

update

PUT /api/v1/bdb/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`name` required
`description`
`phone`
`company_type`
`website`
`address`
`payment_mail`
`active`
`admin_comment`
`logo`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action bdb update -p id=... -p name=... -p description=... -p phone=... -p company_type=... -p website=... -p address=... -p payment_mail=... -p active=... -p admin_comment=... -p logo=...

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 = ["bdb", "update"]
var params = {
    id: ...,
    name: ...,
    description: ...,
    phone: ...,
    company_type: ...,
    website: ...,
    address: ...,
    payment_mail: ...,
    active: ...,
    admin_comment: ...,
    logo: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["bdb", "update"]
params = {
    "id": ...,
    "name": ...,
    "description": ...,
    "phone": ...,
    "company_type": ...,
    "website": ...,
    "address": ...,
    "payment_mail": ...,
    "active": ...,
    "admin_comment": ...,
    "logo": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/bdb/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`name`
`description`
`phone`
`company_type`
`website`
`address`
`payment_mail`
`active`
`admin_comment`
`logo`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action bdb partial_update -p id=... -p name=... -p description=... -p phone=... -p company_type=... -p website=... -p address=... -p payment_mail=... -p active=... -p admin_comment=... -p logo=...

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 = ["bdb", "partial_update"]
var params = {
    id: ...,
    name: ...,
    description: ...,
    phone: ...,
    company_type: ...,
    website: ...,
    address: ...,
    payment_mail: ...,
    active: ...,
    admin_comment: ...,
    logo: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["bdb", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "description": ...,
    "phone": ...,
    "company_type": ...,
    "website": ...,
    "address": ...,
    "payment_mail": ...,
    "active": ...,
    "admin_comment": ...,
    "logo": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/bdb/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action bdb 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 = ["bdb", "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("/api/")

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

calendar-ical

list

GET /api/v1/calendar-ical/

List all the different icals.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action calendar-ical 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 = ["calendar-ical", "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("/api/")

# Interact with the API endpoint
action = ["calendar-ical", "list"]
result = client.action(schema, action)

events

GET /api/v1/calendar-ical/events/

Event ical route.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action calendar-ical events

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 = ["calendar-ical", "events"]
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("/api/")

# Interact with the API endpoint
action = ["calendar-ical", "events"]
result = client.action(schema, action)

personal

GET /api/v1/calendar-ical/personal/

Personal ical route.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action calendar-ical personal

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 = ["calendar-ical", "personal"]
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("/api/")

# Interact with the API endpoint
action = ["calendar-ical", "personal"]
result = client.action(schema, action)

registrations

GET /api/v1/calendar-ical/registrations/

Registration ical route.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action calendar-ical registrations

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 = ["calendar-ical", "registrations"]
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("/api/")

# Interact with the API endpoint
action = ["calendar-ical", "registrations"]
result = client.action(schema, action)

calendar-token

list

GET /api/v1/calendar-token/

Get ICalToken.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action calendar-token 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 = ["calendar-token", "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("/api/")

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

regenerate

PATCH /api/v1/calendar-token/regenerate/

Regenerate ICalToken.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action calendar-token regenerate

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 = ["calendar-token", "regenerate"]
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("/api/")

# Interact with the API endpoint
action = ["calendar-token", "regenerate"]
result = client.action(schema, action)

comments

create

POST /api/v1/comments/

Request Body

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

Parameter	Description
`text` required
`content_target` required
`parent`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action comments create -p text=... -p content_target=... -p parent=...

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 = ["comments", "create"]
var params = {
    text: ...,
    content_target: ...,
    parent: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["comments", "create"]
params = {
    "text": ...,
    "content_target": ...,
    "parent": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/v1/comments/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`text` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action comments update -p id=... -p text=...

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 = ["comments", "update"]
var params = {
    id: ...,
    text: ...,
}
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("/api/")

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

partial_update

PATCH /api/v1/comments/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`text`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action comments partial_update -p id=... -p text=...

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 = ["comments", "partial_update"]
var params = {
    id: ...,
    text: ...,
}
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("/api/")

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

delete

DELETE /api/v1/comments/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action comments 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 = ["comments", "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("/api/")

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

companies

list

GET /api/v1/companies/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`search`
`show_inactive`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies list -p cursor=... -p search=... -p show_inactive=...

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 = ["companies", "list"]
var params = {
    cursor: ...,
    search: ...,
    show_inactive: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "list"]
params = {
    "cursor": ...,
    "search": ...,
    "show_inactive": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/companies/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`search`
`show_inactive`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies read -p id=... -p search=... -p show_inactive=...

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 = ["companies", "read"]
var params = {
    id: ...,
    search: ...,
    show_inactive: ...,
}
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("/api/")

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

company-contacts > list

GET /api/v1/companies/{company_pk}/company-contacts/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies company-contacts list -p company_pk=... -p cursor=...

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 = ["companies", "company-contacts &gt; list"]
var params = {
    company_pk: ...,
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "company-contacts &gt; list"]
params = {
    "company_pk": ...,
    "cursor": ...,
}
result = client.action(schema, action, params=params)

company-contacts > create

POST /api/v1/companies/{company_pk}/company-contacts/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required

Request Body

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

Parameter	Description
`name` required
`role`
`mail`
`phone`
`mobile`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies company-contacts create -p company_pk=... -p name=... -p role=... -p mail=... -p phone=... -p mobile=...

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 = ["companies", "company-contacts &gt; create"]
var params = {
    company_pk: ...,
    name: ...,
    role: ...,
    mail: ...,
    phone: ...,
    mobile: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "company-contacts &gt; create"]
params = {
    "company_pk": ...,
    "name": ...,
    "role": ...,
    "mail": ...,
    "phone": ...,
    "mobile": ...,
}
result = client.action(schema, action, params=params)

company-contacts > read

GET /api/v1/companies/{company_pk}/company-contacts/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this company contact.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies company-contacts read -p company_pk=... -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 = ["companies", "company-contacts &gt; read"]
var params = {
    company_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["companies", "company-contacts &gt; read"]
params = {
    "company_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

company-contacts > update

PUT /api/v1/companies/{company_pk}/company-contacts/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this company contact.

Request Body

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

Parameter	Description
`name` required
`role`
`mail`
`phone`
`mobile`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies company-contacts update -p company_pk=... -p id=... -p name=... -p role=... -p mail=... -p phone=... -p mobile=...

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 = ["companies", "company-contacts &gt; update"]
var params = {
    company_pk: ...,
    id: ...,
    name: ...,
    role: ...,
    mail: ...,
    phone: ...,
    mobile: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "company-contacts &gt; update"]
params = {
    "company_pk": ...,
    "id": ...,
    "name": ...,
    "role": ...,
    "mail": ...,
    "phone": ...,
    "mobile": ...,
}
result = client.action(schema, action, params=params)

company-contacts > partial_update

PATCH /api/v1/companies/{company_pk}/company-contacts/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this company contact.

Request Body

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

Parameter	Description
`name`
`role`
`mail`
`phone`
`mobile`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies company-contacts partial_update -p company_pk=... -p id=... -p name=... -p role=... -p mail=... -p phone=... -p mobile=...

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 = ["companies", "company-contacts &gt; partial_update"]
var params = {
    company_pk: ...,
    id: ...,
    name: ...,
    role: ...,
    mail: ...,
    phone: ...,
    mobile: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "company-contacts &gt; partial_update"]
params = {
    "company_pk": ...,
    "id": ...,
    "name": ...,
    "role": ...,
    "mail": ...,
    "phone": ...,
    "mobile": ...,
}
result = client.action(schema, action, params=params)

company-contacts > delete

DELETE /api/v1/companies/{company_pk}/company-contacts/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this company contact.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies company-contacts delete -p company_pk=... -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 = ["companies", "company-contacts &gt; delete"]
var params = {
    company_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["companies", "company-contacts &gt; delete"]
params = {
    "company_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

files > list

GET /api/v1/companies/{company_pk}/files/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies files list -p company_pk=... -p cursor=...

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 = ["companies", "files &gt; list"]
var params = {
    company_pk: ...,
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "files &gt; list"]
params = {
    "company_pk": ...,
    "cursor": ...,
}
result = client.action(schema, action, params=params)

files > create

POST /api/v1/companies/{company_pk}/files/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required

Request Body

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

Parameter	Description
`file` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies files create -p company_pk=... -p file=...

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 = ["companies", "files &gt; create"]
var params = {
    company_pk: ...,
    file: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "files &gt; create"]
params = {
    "company_pk": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

files > read

GET /api/v1/companies/{company_pk}/files/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this company file.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies files read -p company_pk=... -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 = ["companies", "files &gt; read"]
var params = {
    company_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["companies", "files &gt; read"]
params = {
    "company_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

files > update

PUT /api/v1/companies/{company_pk}/files/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this company file.

Request Body

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

Parameter	Description
`file` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies files update -p company_pk=... -p id=... -p file=...

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 = ["companies", "files &gt; update"]
var params = {
    company_pk: ...,
    id: ...,
    file: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "files &gt; update"]
params = {
    "company_pk": ...,
    "id": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

files > partial_update

PATCH /api/v1/companies/{company_pk}/files/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this company file.

Request Body

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

Parameter	Description
`file`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies files partial_update -p company_pk=... -p id=... -p file=...

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 = ["companies", "files &gt; partial_update"]
var params = {
    company_pk: ...,
    id: ...,
    file: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "files &gt; partial_update"]
params = {
    "company_pk": ...,
    "id": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

files > delete

DELETE /api/v1/companies/{company_pk}/files/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this company file.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies files delete -p company_pk=... -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 = ["companies", "files &gt; delete"]
var params = {
    company_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["companies", "files &gt; delete"]
params = {
    "company_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

semester-statuses > list

GET /api/v1/companies/{company_pk}/semester-statuses/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies semester-statuses list -p company_pk=... -p cursor=...

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 = ["companies", "semester-statuses &gt; list"]
var params = {
    company_pk: ...,
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "semester-statuses &gt; list"]
params = {
    "company_pk": ...,
    "cursor": ...,
}
result = client.action(schema, action, params=params)

semester-statuses > create

POST /api/v1/companies/{company_pk}/semester-statuses/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required

Request Body

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

Parameter	Description
`semester` required
`contacted_status`
`contract`
`statistics`
`evaluation`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies semester-statuses create -p company_pk=... -p semester=... -p contacted_status=... -p contract=... -p statistics=... -p evaluation=...

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 = ["companies", "semester-statuses &gt; create"]
var params = {
    company_pk: ...,
    semester: ...,
    contacted_status: ...,
    contract: ...,
    statistics: ...,
    evaluation: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "semester-statuses &gt; create"]
params = {
    "company_pk": ...,
    "semester": ...,
    "contacted_status": ...,
    "contract": ...,
    "statistics": ...,
    "evaluation": ...,
}
result = client.action(schema, action, params=params)

semester-statuses > read

GET /api/v1/companies/{company_pk}/semester-statuses/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this semester status.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies semester-statuses read -p company_pk=... -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 = ["companies", "semester-statuses &gt; read"]
var params = {
    company_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["companies", "semester-statuses &gt; read"]
params = {
    "company_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

semester-statuses > update

PUT /api/v1/companies/{company_pk}/semester-statuses/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this semester status.

Request Body

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

Parameter	Description
`semester` required
`contacted_status`
`contract`
`statistics`
`evaluation`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies semester-statuses update -p company_pk=... -p id=... -p semester=... -p contacted_status=... -p contract=... -p statistics=... -p evaluation=...

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 = ["companies", "semester-statuses &gt; update"]
var params = {
    company_pk: ...,
    id: ...,
    semester: ...,
    contacted_status: ...,
    contract: ...,
    statistics: ...,
    evaluation: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "semester-statuses &gt; update"]
params = {
    "company_pk": ...,
    "id": ...,
    "semester": ...,
    "contacted_status": ...,
    "contract": ...,
    "statistics": ...,
    "evaluation": ...,
}
result = client.action(schema, action, params=params)

semester-statuses > partial_update

PATCH /api/v1/companies/{company_pk}/semester-statuses/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this semester status.

Request Body

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

Parameter	Description
`semester`
`contacted_status`
`contract`
`statistics`
`evaluation`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies semester-statuses partial_update -p company_pk=... -p id=... -p semester=... -p contacted_status=... -p contract=... -p statistics=... -p evaluation=...

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 = ["companies", "semester-statuses &gt; partial_update"]
var params = {
    company_pk: ...,
    id: ...,
    semester: ...,
    contacted_status: ...,
    contract: ...,
    statistics: ...,
    evaluation: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["companies", "semester-statuses &gt; partial_update"]
params = {
    "company_pk": ...,
    "id": ...,
    "semester": ...,
    "contacted_status": ...,
    "contract": ...,
    "statistics": ...,
    "evaluation": ...,
}
result = client.action(schema, action, params=params)

semester-statuses > delete

DELETE /api/v1/companies/{company_pk}/semester-statuses/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_pk` required
`id` required	A unique integer value identifying this semester status.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies semester-statuses delete -p company_pk=... -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 = ["companies", "semester-statuses &gt; delete"]
var params = {
    company_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["companies", "semester-statuses &gt; delete"]
params = {
    "company_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

company-interests

list

GET /api/v1/company-interests/

Used by new companies to register interest in Abakus and our services.

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`semesters`
`events`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-interests list -p cursor=... -p semesters=... -p events=...

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 = ["company-interests", "list"]
var params = {
    cursor: ...,
    semesters: ...,
    events: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["company-interests", "list"]
params = {
    "cursor": ...,
    "semesters": ...,
    "events": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/company-interests/

Used by new companies to register interest in Abakus and our services.

Request Body

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

Parameter	Description
`company_name`
`company`
`contact_person` required
`mail` required
`phone`
`semesters`
`events`
`other_offers`
`collaborations`
`company_type`
`target_grades`
`participant_range_start`
`participant_range_end`
`comment`
`course_comment`
`breakfast_talk_comment`
`other_event_comment`
`startup_comment`
`company_to_company_comment`
`lunch_presentation_comment`
`company_presentation_comment`
`bedex_comment`
`company_course_themes`
`office_in_trondheim`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-interests create -p company_name=... -p company=... -p contact_person=... -p mail=... -p phone=... -p semesters=... -p events=... -p other_offers=... -p collaborations=... -p company_type=... -p target_grades=... -p participant_range_start=... -p participant_range_end=... -p comment=... -p course_comment=... -p breakfast_talk_comment=... -p other_event_comment=... -p startup_comment=... -p company_to_company_comment=... -p lunch_presentation_comment=... -p company_presentation_comment=... -p bedex_comment=... -p company_course_themes=... -p office_in_trondheim=...

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 = ["company-interests", "create"]
var params = {
    company_name: ...,
    company: ...,
    contact_person: ...,
    mail: ...,
    phone: ...,
    semesters: ...,
    events: ...,
    other_offers: ...,
    collaborations: ...,
    company_type: ...,
    target_grades: ...,
    participant_range_start: ...,
    participant_range_end: ...,
    comment: ...,
    course_comment: ...,
    breakfast_talk_comment: ...,
    other_event_comment: ...,
    startup_comment: ...,
    company_to_company_comment: ...,
    lunch_presentation_comment: ...,
    company_presentation_comment: ...,
    bedex_comment: ...,
    company_course_themes: ...,
    office_in_trondheim: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["company-interests", "create"]
params = {
    "company_name": ...,
    "company": ...,
    "contact_person": ...,
    "mail": ...,
    "phone": ...,
    "semesters": ...,
    "events": ...,
    "other_offers": ...,
    "collaborations": ...,
    "company_type": ...,
    "target_grades": ...,
    "participant_range_start": ...,
    "participant_range_end": ...,
    "comment": ...,
    "course_comment": ...,
    "breakfast_talk_comment": ...,
    "other_event_comment": ...,
    "startup_comment": ...,
    "company_to_company_comment": ...,
    "lunch_presentation_comment": ...,
    "company_presentation_comment": ...,
    "bedex_comment": ...,
    "company_course_themes": ...,
    "office_in_trondheim": ...,
}
result = client.action(schema, action, params=params)

csv

GET /api/v1/company-interests/csv/

Used by new companies to register interest in Abakus and our services.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-interests csv

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 = ["company-interests", "csv"]
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("/api/")

# Interact with the API endpoint
action = ["company-interests", "csv"]
result = client.action(schema, action)

read

GET /api/v1/company-interests/{id}/

Used by new companies to register interest in Abakus and our services.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`semesters`
`events`

# Load the schema document
$ coreapi get /api/

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

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 = ["company-interests", "read"]
var params = {
    id: ...,
    semesters: ...,
    events: ...,
}
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("/api/")

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

update

PUT /api/v1/company-interests/{id}/

Used by new companies to register interest in Abakus and our services.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`semesters`
`events`

Request Body

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

Parameter	Description
`company_name`
`company`
`contact_person` required
`mail` required
`phone`
`semesters`
`events`
`other_offers`
`collaborations`
`company_type`
`target_grades`
`participant_range_start`
`participant_range_end`
`comment`
`course_comment`
`breakfast_talk_comment`
`other_event_comment`
`startup_comment`
`company_to_company_comment`
`lunch_presentation_comment`
`company_presentation_comment`
`bedex_comment`
`company_course_themes`
`office_in_trondheim`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-interests update -p id=... -p company_name=... -p company=... -p contact_person=... -p mail=... -p phone=... -p semesters=... -p events=... -p other_offers=... -p collaborations=... -p company_type=... -p target_grades=... -p participant_range_start=... -p participant_range_end=... -p comment=... -p course_comment=... -p breakfast_talk_comment=... -p other_event_comment=... -p startup_comment=... -p company_to_company_comment=... -p lunch_presentation_comment=... -p company_presentation_comment=... -p bedex_comment=... -p company_course_themes=... -p office_in_trondheim=... -p semesters=... -p events=...

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 = ["company-interests", "update"]
var params = {
    id: ...,
    company_name: ...,
    company: ...,
    contact_person: ...,
    mail: ...,
    phone: ...,
    semesters: ...,
    events: ...,
    other_offers: ...,
    collaborations: ...,
    company_type: ...,
    target_grades: ...,
    participant_range_start: ...,
    participant_range_end: ...,
    comment: ...,
    course_comment: ...,
    breakfast_talk_comment: ...,
    other_event_comment: ...,
    startup_comment: ...,
    company_to_company_comment: ...,
    lunch_presentation_comment: ...,
    company_presentation_comment: ...,
    bedex_comment: ...,
    company_course_themes: ...,
    office_in_trondheim: ...,
    semesters: ...,
    events: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["company-interests", "update"]
params = {
    "id": ...,
    "company_name": ...,
    "company": ...,
    "contact_person": ...,
    "mail": ...,
    "phone": ...,
    "semesters": ...,
    "events": ...,
    "other_offers": ...,
    "collaborations": ...,
    "company_type": ...,
    "target_grades": ...,
    "participant_range_start": ...,
    "participant_range_end": ...,
    "comment": ...,
    "course_comment": ...,
    "breakfast_talk_comment": ...,
    "other_event_comment": ...,
    "startup_comment": ...,
    "company_to_company_comment": ...,
    "lunch_presentation_comment": ...,
    "company_presentation_comment": ...,
    "bedex_comment": ...,
    "company_course_themes": ...,
    "office_in_trondheim": ...,
    "semesters": ...,
    "events": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/company-interests/{id}/

Used by new companies to register interest in Abakus and our services.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`semesters`
`events`

Request Body

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

Parameter	Description
`company_name`
`company`
`contact_person`
`mail`
`phone`
`semesters`
`events`
`other_offers`
`collaborations`
`company_type`
`target_grades`
`participant_range_start`
`participant_range_end`
`comment`
`course_comment`
`breakfast_talk_comment`
`other_event_comment`
`startup_comment`
`company_to_company_comment`
`lunch_presentation_comment`
`company_presentation_comment`
`bedex_comment`
`company_course_themes`
`office_in_trondheim`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-interests partial_update -p id=... -p company_name=... -p company=... -p contact_person=... -p mail=... -p phone=... -p semesters=... -p events=... -p other_offers=... -p collaborations=... -p company_type=... -p target_grades=... -p participant_range_start=... -p participant_range_end=... -p comment=... -p course_comment=... -p breakfast_talk_comment=... -p other_event_comment=... -p startup_comment=... -p company_to_company_comment=... -p lunch_presentation_comment=... -p company_presentation_comment=... -p bedex_comment=... -p company_course_themes=... -p office_in_trondheim=... -p semesters=... -p events=...

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 = ["company-interests", "partial_update"]
var params = {
    id: ...,
    company_name: ...,
    company: ...,
    contact_person: ...,
    mail: ...,
    phone: ...,
    semesters: ...,
    events: ...,
    other_offers: ...,
    collaborations: ...,
    company_type: ...,
    target_grades: ...,
    participant_range_start: ...,
    participant_range_end: ...,
    comment: ...,
    course_comment: ...,
    breakfast_talk_comment: ...,
    other_event_comment: ...,
    startup_comment: ...,
    company_to_company_comment: ...,
    lunch_presentation_comment: ...,
    company_presentation_comment: ...,
    bedex_comment: ...,
    company_course_themes: ...,
    office_in_trondheim: ...,
    semesters: ...,
    events: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["company-interests", "partial_update"]
params = {
    "id": ...,
    "company_name": ...,
    "company": ...,
    "contact_person": ...,
    "mail": ...,
    "phone": ...,
    "semesters": ...,
    "events": ...,
    "other_offers": ...,
    "collaborations": ...,
    "company_type": ...,
    "target_grades": ...,
    "participant_range_start": ...,
    "participant_range_end": ...,
    "comment": ...,
    "course_comment": ...,
    "breakfast_talk_comment": ...,
    "other_event_comment": ...,
    "startup_comment": ...,
    "company_to_company_comment": ...,
    "lunch_presentation_comment": ...,
    "company_presentation_comment": ...,
    "bedex_comment": ...,
    "company_course_themes": ...,
    "office_in_trondheim": ...,
    "semesters": ...,
    "events": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/company-interests/{id}/

Used by new companies to register interest in Abakus and our services.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`semesters`
`events`

# Load the schema document
$ coreapi get /api/

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

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 = ["company-interests", "delete"]
var params = {
    id: ...,
    semesters: ...,
    events: ...,
}
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("/api/")

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

company-semesters

list

GET /api/v1/company-semesters/

Query Parameters

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

Parameter	Description
`company_interest`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-semesters list -p company_interest=...

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 = ["company-semesters", "list"]
var params = {
    company_interest: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["company-semesters", "list"]
params = {
    "company_interest": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/company-semesters/

Request Body

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

Parameter	Description
`year` required
`semester` required
`active_interest_form`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-semesters create -p year=... -p semester=... -p active_interest_form=...

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 = ["company-semesters", "create"]
var params = {
    year: ...,
    semester: ...,
    active_interest_form: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["company-semesters", "create"]
params = {
    "year": ...,
    "semester": ...,
    "active_interest_form": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/company-semesters/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`company_interest`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-semesters read -p id=... -p company_interest=...

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 = ["company-semesters", "read"]
var params = {
    id: ...,
    company_interest: ...,
}
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("/api/")

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

update

PUT /api/v1/company-semesters/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`company_interest`

Request Body

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

Parameter	Description
`year` required
`semester` required
`active_interest_form`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-semesters update -p id=... -p year=... -p semester=... -p active_interest_form=... -p company_interest=...

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 = ["company-semesters", "update"]
var params = {
    id: ...,
    year: ...,
    semester: ...,
    active_interest_form: ...,
    company_interest: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["company-semesters", "update"]
params = {
    "id": ...,
    "year": ...,
    "semester": ...,
    "active_interest_form": ...,
    "company_interest": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/company-semesters/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`company_interest`

Request Body

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

Parameter	Description
`year`
`semester`
`active_interest_form`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-semesters partial_update -p id=... -p year=... -p semester=... -p active_interest_form=... -p company_interest=...

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 = ["company-semesters", "partial_update"]
var params = {
    id: ...,
    year: ...,
    semester: ...,
    active_interest_form: ...,
    company_interest: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["company-semesters", "partial_update"]
params = {
    "id": ...,
    "year": ...,
    "semester": ...,
    "active_interest_form": ...,
    "company_interest": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/company-semesters/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`company_interest`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action company-semesters delete -p id=... -p company_interest=...

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 = ["company-semesters", "delete"]
var params = {
    id: ...,
    company_interest: ...,
}
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("/api/")

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

contact-form

create

POST /api/v1/contact-form/

Request Body

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

Parameter	Description
`title` required
`message` required
`anonymous` required
`captcha_response` required
`recipient_group` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action contact-form create -p title=... -p message=... -p anonymous=... -p captcha_response=... -p recipient_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 = ["contact-form", "create"]
var params = {
    title: ...,
    message: ...,
    anonymous: ...,
    captcha_response: ...,
    recipient_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("/api/")

# Interact with the API endpoint
action = ["contact-form", "create"]
params = {
    "title": ...,
    "message": ...,
    "anonymous": ...,
    "captcha_response": ...,
    "recipient_group": ...,
}
result = client.action(schema, action, params=params)

device-apns

list

GET /api/v1/device-apns/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-apns list -p cursor=...

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 = ["device-apns", "list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["device-apns", "list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/device-apns/

Request Body

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

Parameter	Description
`name`
`application_id`	Opaque application identity, should be filled in for multiple key/certificate access
`registration_id` required
`device_id`	UUID / UIDevice.identifierForVendor()
`active`	Inactive devices will not be sent notifications

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-apns create -p name=... -p application_id=... -p registration_id=... -p device_id=... -p active=...

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 = ["device-apns", "create"]
var params = {
    name: ...,
    application_id: ...,
    registration_id: ...,
    device_id: ...,
    active: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["device-apns", "create"]
params = {
    "name": ...,
    "application_id": ...,
    "registration_id": ...,
    "device_id": ...,
    "active": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/device-apns/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-apns read -p registration_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 = ["device-apns", "read"]
var params = {
    registration_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("/api/")

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

update

PUT /api/v1/device-apns/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

Request Body

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

Parameter	Description
`name`
`application_id`	Opaque application identity, should be filled in for multiple key/certificate access
`registration_id` required
`device_id`	UUID / UIDevice.identifierForVendor()
`active`	Inactive devices will not be sent notifications

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-apns update -p registration_id=... -p name=... -p application_id=... -p registration_id=... -p device_id=... -p active=...

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 = ["device-apns", "update"]
var params = {
    registration_id: ...,
    name: ...,
    application_id: ...,
    registration_id: ...,
    device_id: ...,
    active: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["device-apns", "update"]
params = {
    "registration_id": ...,
    "name": ...,
    "application_id": ...,
    "registration_id": ...,
    "device_id": ...,
    "active": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/device-apns/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

Request Body

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

Parameter	Description
`name`
`application_id`	Opaque application identity, should be filled in for multiple key/certificate access
`registration_id`
`device_id`	UUID / UIDevice.identifierForVendor()
`active`	Inactive devices will not be sent notifications

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-apns partial_update -p registration_id=... -p name=... -p application_id=... -p registration_id=... -p device_id=... -p active=...

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 = ["device-apns", "partial_update"]
var params = {
    registration_id: ...,
    name: ...,
    application_id: ...,
    registration_id: ...,
    device_id: ...,
    active: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["device-apns", "partial_update"]
params = {
    "registration_id": ...,
    "name": ...,
    "application_id": ...,
    "registration_id": ...,
    "device_id": ...,
    "active": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/device-apns/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-apns delete -p registration_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 = ["device-apns", "delete"]
var params = {
    registration_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("/api/")

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

device-gcm

list

GET /api/v1/device-gcm/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-gcm list -p cursor=...

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 = ["device-gcm", "list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["device-gcm", "list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/device-gcm/

Request Body

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

Parameter	Description
`id`
`name`
`registration_id` required
`device_id`	ANDROID_ID / TelephonyManager.getDeviceId() (e.g: 0x01)
`active`	Inactive devices will not be sent notifications
`cloud_message_type`	You should choose FCM or GCM
`application_id`	Opaque application identity, should be filled in for multiple key/certificate access

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-gcm create -p id=... -p name=... -p registration_id=... -p device_id=... -p active=... -p cloud_message_type=... -p application_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 = ["device-gcm", "create"]
var params = {
    id: ...,
    name: ...,
    registration_id: ...,
    device_id: ...,
    active: ...,
    cloud_message_type: ...,
    application_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("/api/")

# Interact with the API endpoint
action = ["device-gcm", "create"]
params = {
    "id": ...,
    "name": ...,
    "registration_id": ...,
    "device_id": ...,
    "active": ...,
    "cloud_message_type": ...,
    "application_id": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/device-gcm/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-gcm read -p registration_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 = ["device-gcm", "read"]
var params = {
    registration_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("/api/")

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

update

PUT /api/v1/device-gcm/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

Request Body

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

Parameter	Description
`id`
`name`
`registration_id` required
`device_id`	ANDROID_ID / TelephonyManager.getDeviceId() (e.g: 0x01)
`active`	Inactive devices will not be sent notifications
`cloud_message_type`	You should choose FCM or GCM
`application_id`	Opaque application identity, should be filled in for multiple key/certificate access

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-gcm update -p registration_id=... -p id=... -p name=... -p registration_id=... -p device_id=... -p active=... -p cloud_message_type=... -p application_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 = ["device-gcm", "update"]
var params = {
    registration_id: ...,
    id: ...,
    name: ...,
    registration_id: ...,
    device_id: ...,
    active: ...,
    cloud_message_type: ...,
    application_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("/api/")

# Interact with the API endpoint
action = ["device-gcm", "update"]
params = {
    "registration_id": ...,
    "id": ...,
    "name": ...,
    "registration_id": ...,
    "device_id": ...,
    "active": ...,
    "cloud_message_type": ...,
    "application_id": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/device-gcm/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

Request Body

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

Parameter	Description
`id`
`name`
`registration_id`
`device_id`	ANDROID_ID / TelephonyManager.getDeviceId() (e.g: 0x01)
`active`	Inactive devices will not be sent notifications
`cloud_message_type`	You should choose FCM or GCM
`application_id`	Opaque application identity, should be filled in for multiple key/certificate access

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-gcm partial_update -p registration_id=... -p id=... -p name=... -p registration_id=... -p device_id=... -p active=... -p cloud_message_type=... -p application_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 = ["device-gcm", "partial_update"]
var params = {
    registration_id: ...,
    id: ...,
    name: ...,
    registration_id: ...,
    device_id: ...,
    active: ...,
    cloud_message_type: ...,
    application_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("/api/")

# Interact with the API endpoint
action = ["device-gcm", "partial_update"]
params = {
    "registration_id": ...,
    "id": ...,
    "name": ...,
    "registration_id": ...,
    "device_id": ...,
    "active": ...,
    "cloud_message_type": ...,
    "application_id": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/device-gcm/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action device-gcm delete -p registration_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 = ["device-gcm", "delete"]
var params = {
    registration_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("/api/")

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

email-lists

list

GET /api/v1/email-lists/

Destroy are disabled. The external_sync don't support group destroy either!

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`name`
`email`
`requireInternalAddress`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-lists list -p cursor=... -p name=... -p email=... -p requireInternalAddress=...

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 = ["email-lists", "list"]
var params = {
    cursor: ...,
    name: ...,
    email: ...,
    requireInternalAddress: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["email-lists", "list"]
params = {
    "cursor": ...,
    "name": ...,
    "email": ...,
    "requireInternalAddress": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/email-lists/

Destroy are disabled. The external_sync don't support group destroy either!

Request Body

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

Parameter	Description
`name` required
`email` required
`users`
`groups`
`group_roles`
`require_internal_address`	Only allow users with emails from our internal domain, @abakus.no
`additional_emails`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-lists create -p name=... -p email=... -p users=... -p groups=... -p group_roles=... -p require_internal_address=... -p additional_emails=...

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 = ["email-lists", "create"]
var params = {
    name: ...,
    email: ...,
    users: ...,
    groups: ...,
    group_roles: ...,
    require_internal_address: ...,
    additional_emails: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["email-lists", "create"]
params = {
    "name": ...,
    "email": ...,
    "users": ...,
    "groups": ...,
    "group_roles": ...,
    "require_internal_address": ...,
    "additional_emails": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/email-lists/{id}/

Destroy are disabled. The external_sync don't support group destroy either!

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`name`
`email`
`requireInternalAddress`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-lists read -p id=... -p name=... -p email=... -p requireInternalAddress=...

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 = ["email-lists", "read"]
var params = {
    id: ...,
    name: ...,
    email: ...,
    requireInternalAddress: ...,
}
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("/api/")

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

update

PUT /api/v1/email-lists/{id}/

Destroy are disabled. The external_sync don't support group destroy either!

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`name`
`email`
`requireInternalAddress`

Request Body

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

Parameter	Description
`name` required
`users`
`groups`
`group_roles`
`require_internal_address`	Only allow users with emails from our internal domain, @abakus.no
`additional_emails`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-lists update -p id=... -p name=... -p users=... -p groups=... -p group_roles=... -p require_internal_address=... -p additional_emails=... -p name=... -p email=... -p requireInternalAddress=...

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 = ["email-lists", "update"]
var params = {
    id: ...,
    name: ...,
    users: ...,
    groups: ...,
    group_roles: ...,
    require_internal_address: ...,
    additional_emails: ...,
    name: ...,
    email: ...,
    requireInternalAddress: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["email-lists", "update"]
params = {
    "id": ...,
    "name": ...,
    "users": ...,
    "groups": ...,
    "group_roles": ...,
    "require_internal_address": ...,
    "additional_emails": ...,
    "name": ...,
    "email": ...,
    "requireInternalAddress": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/email-lists/{id}/

Destroy are disabled. The external_sync don't support group destroy either!

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`name`
`email`
`requireInternalAddress`

Request Body

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

Parameter	Description
`name`
`users`
`groups`
`group_roles`
`require_internal_address`	Only allow users with emails from our internal domain, @abakus.no
`additional_emails`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-lists partial_update -p id=... -p name=... -p users=... -p groups=... -p group_roles=... -p require_internal_address=... -p additional_emails=... -p name=... -p email=... -p requireInternalAddress=...

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 = ["email-lists", "partial_update"]
var params = {
    id: ...,
    name: ...,
    users: ...,
    groups: ...,
    group_roles: ...,
    require_internal_address: ...,
    additional_emails: ...,
    name: ...,
    email: ...,
    requireInternalAddress: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["email-lists", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "users": ...,
    "groups": ...,
    "group_roles": ...,
    "require_internal_address": ...,
    "additional_emails": ...,
    "name": ...,
    "email": ...,
    "requireInternalAddress": ...,
}
result = client.action(schema, action, params=params)

email-users

list

GET /api/v1/email-users/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`email`
`enabled`
`userUsername`
`userFullname`
`userGrade`
`userGroups`	Multiple values may be separated by commas.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-users list -p cursor=... -p email=... -p enabled=... -p userUsername=... -p userFullname=... -p userGrade=... -p userGroups=...

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 = ["email-users", "list"]
var params = {
    cursor: ...,
    email: ...,
    enabled: ...,
    userUsername: ...,
    userFullname: ...,
    userGrade: ...,
    userGroups: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["email-users", "list"]
params = {
    "cursor": ...,
    "email": ...,
    "enabled": ...,
    "userUsername": ...,
    "userFullname": ...,
    "userGrade": ...,
    "userGroups": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/email-users/

Request Body

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

Parameter	Description
`user` required
`internal_email` required
`internal_email_enabled` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-users create -p user=... -p internal_email=... -p internal_email_enabled=...

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 = ["email-users", "create"]
var params = {
    user: ...,
    internal_email: ...,
    internal_email_enabled: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["email-users", "create"]
params = {
    "user": ...,
    "internal_email": ...,
    "internal_email_enabled": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/email-users/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`email`
`enabled`
`userUsername`
`userFullname`
`userGrade`
`userGroups`	Multiple values may be separated by commas.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-users read -p id=... -p email=... -p enabled=... -p userUsername=... -p userFullname=... -p userGrade=... -p userGroups=...

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 = ["email-users", "read"]
var params = {
    id: ...,
    email: ...,
    enabled: ...,
    userUsername: ...,
    userFullname: ...,
    userGrade: ...,
    userGroups: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["email-users", "read"]
params = {
    "id": ...,
    "email": ...,
    "enabled": ...,
    "userUsername": ...,
    "userFullname": ...,
    "userGrade": ...,
    "userGroups": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/v1/email-users/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`email`
`enabled`
`userUsername`
`userFullname`
`userGrade`
`userGroups`	Multiple values may be separated by commas.

Request Body

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

Parameter	Description
`internal_email` required
`internal_email_enabled`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-users update -p id=... -p internal_email=... -p internal_email_enabled=... -p email=... -p enabled=... -p userUsername=... -p userFullname=... -p userGrade=... -p userGroups=...

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 = ["email-users", "update"]
var params = {
    id: ...,
    internal_email: ...,
    internal_email_enabled: ...,
    email: ...,
    enabled: ...,
    userUsername: ...,
    userFullname: ...,
    userGrade: ...,
    userGroups: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["email-users", "update"]
params = {
    "id": ...,
    "internal_email": ...,
    "internal_email_enabled": ...,
    "email": ...,
    "enabled": ...,
    "userUsername": ...,
    "userFullname": ...,
    "userGrade": ...,
    "userGroups": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/email-users/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`email`
`enabled`
`userUsername`
`userFullname`
`userGrade`
`userGroups`	Multiple values may be separated by commas.

Request Body

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

Parameter	Description
`internal_email`
`internal_email_enabled`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action email-users partial_update -p id=... -p internal_email=... -p internal_email_enabled=... -p email=... -p enabled=... -p userUsername=... -p userFullname=... -p userGrade=... -p userGroups=...

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 = ["email-users", "partial_update"]
var params = {
    id: ...,
    internal_email: ...,
    internal_email_enabled: ...,
    email: ...,
    enabled: ...,
    userUsername: ...,
    userFullname: ...,
    userGrade: ...,
    userGroups: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["email-users", "partial_update"]
params = {
    "id": ...,
    "internal_email": ...,
    "internal_email_enabled": ...,
    "email": ...,
    "enabled": ...,
    "userUsername": ...,
    "userFullname": ...,
    "userGrade": ...,
    "userGroups": ...,
}
result = client.action(schema, action, params=params)

emojis

list

GET /api/v1/emojis/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action emojis 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 = ["emojis", "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("/api/")

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

create

POST /api/v1/emojis/

Request Body

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

Parameter	Description
`short_code` required
`keywords` required
`unicode_string` required
`fitzpatrick_scale` required
`category` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action emojis create -p short_code=... -p keywords=... -p unicode_string=... -p fitzpatrick_scale=... -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 = ["emojis", "create"]
var params = {
    short_code: ...,
    keywords: ...,
    unicode_string: ...,
    fitzpatrick_scale: ...,
    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("/api/")

# Interact with the API endpoint
action = ["emojis", "create"]
params = {
    "short_code": ...,
    "keywords": ...,
    "unicode_string": ...,
    "fitzpatrick_scale": ...,
    "category": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/emojis/{short_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`short_code` required	A unique value identifying this emoji.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action emojis read -p short_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 = ["emojis", "read"]
var params = {
    short_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("/api/")

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

update

PUT /api/v1/emojis/{short_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`short_code` required	A unique value identifying this emoji.

Request Body

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

Parameter	Description
`short_code` required
`keywords` required
`unicode_string` required
`fitzpatrick_scale` required
`category` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action emojis update -p short_code=... -p short_code=... -p keywords=... -p unicode_string=... -p fitzpatrick_scale=... -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 = ["emojis", "update"]
var params = {
    short_code: ...,
    short_code: ...,
    keywords: ...,
    unicode_string: ...,
    fitzpatrick_scale: ...,
    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("/api/")

# Interact with the API endpoint
action = ["emojis", "update"]
params = {
    "short_code": ...,
    "short_code": ...,
    "keywords": ...,
    "unicode_string": ...,
    "fitzpatrick_scale": ...,
    "category": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/emojis/{short_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`short_code` required	A unique value identifying this emoji.

Request Body

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

Parameter	Description
`short_code`
`keywords`
`unicode_string`
`fitzpatrick_scale`
`category`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action emojis partial_update -p short_code=... -p short_code=... -p keywords=... -p unicode_string=... -p fitzpatrick_scale=... -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 = ["emojis", "partial_update"]
var params = {
    short_code: ...,
    short_code: ...,
    keywords: ...,
    unicode_string: ...,
    fitzpatrick_scale: ...,
    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("/api/")

# Interact with the API endpoint
action = ["emojis", "partial_update"]
params = {
    "short_code": ...,
    "short_code": ...,
    "keywords": ...,
    "unicode_string": ...,
    "fitzpatrick_scale": ...,
    "category": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/emojis/{short_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`short_code` required	A unique value identifying this emoji.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action emojis delete -p short_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 = ["emojis", "delete"]
var params = {
    short_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("/api/")

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

events

list

GET /api/v1/events/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`date_after`
`date_before`
`company`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events list -p cursor=... -p date_after=... -p date_before=... -p company=... -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 = ["events", "list"]
var params = {
    cursor: ...,
    date_after: ...,
    date_before: ...,
    company: ...,
    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("/api/")

# Interact with the API endpoint
action = ["events", "list"]
params = {
    "cursor": ...,
    "date_after": ...,
    "date_before": ...,
    "company": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/events/

Request Body

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

Parameter	Description
`title` required
`cover`
`description` required
`text` required
`company`
`responsible_group`
`feedback_description`
`feedback_required`
`event_type` required
`event_status_type`
`location` required
`is_priced`
`price_member`
`price_guest`
`use_stripe`
`payment_due_date`
`start_time` required
`end_time` required
`merge_time`
`use_captcha`
`tags`
`pools`
`unregistration_deadline`
`unregistration_deadline_hours`
`pinned`
`use_consent`
`heed_penalties`
`registration_deadline_hours`
`youtube_url`
`mazemap_poi`
`responsible_users`
`is_foreign_language`
`can_edit_users`
`can_view_groups`
`can_edit_groups`
`require_auth`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events create -p title=... -p cover=... -p description=... -p text=... -p company=... -p responsible_group=... -p feedback_description=... -p feedback_required=... -p event_type=... -p event_status_type=... -p location=... -p is_priced=... -p price_member=... -p price_guest=... -p use_stripe=... -p payment_due_date=... -p start_time=... -p end_time=... -p merge_time=... -p use_captcha=... -p tags=... -p pools=... -p unregistration_deadline=... -p unregistration_deadline_hours=... -p pinned=... -p use_consent=... -p heed_penalties=... -p registration_deadline_hours=... -p youtube_url=... -p mazemap_poi=... -p responsible_users=... -p is_foreign_language=... -p can_edit_users=... -p can_view_groups=... -p can_edit_groups=... -p require_auth=...

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 = ["events", "create"]
var params = {
    title: ...,
    cover: ...,
    description: ...,
    text: ...,
    company: ...,
    responsible_group: ...,
    feedback_description: ...,
    feedback_required: ...,
    event_type: ...,
    event_status_type: ...,
    location: ...,
    is_priced: ...,
    price_member: ...,
    price_guest: ...,
    use_stripe: ...,
    payment_due_date: ...,
    start_time: ...,
    end_time: ...,
    merge_time: ...,
    use_captcha: ...,
    tags: ...,
    pools: ...,
    unregistration_deadline: ...,
    unregistration_deadline_hours: ...,
    pinned: ...,
    use_consent: ...,
    heed_penalties: ...,
    registration_deadline_hours: ...,
    youtube_url: ...,
    mazemap_poi: ...,
    responsible_users: ...,
    is_foreign_language: ...,
    can_edit_users: ...,
    can_view_groups: ...,
    can_edit_groups: ...,
    require_auth: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "create"]
params = {
    "title": ...,
    "cover": ...,
    "description": ...,
    "text": ...,
    "company": ...,
    "responsible_group": ...,
    "feedback_description": ...,
    "feedback_required": ...,
    "event_type": ...,
    "event_status_type": ...,
    "location": ...,
    "is_priced": ...,
    "price_member": ...,
    "price_guest": ...,
    "use_stripe": ...,
    "payment_due_date": ...,
    "start_time": ...,
    "end_time": ...,
    "merge_time": ...,
    "use_captcha": ...,
    "tags": ...,
    "pools": ...,
    "unregistration_deadline": ...,
    "unregistration_deadline_hours": ...,
    "pinned": ...,
    "use_consent": ...,
    "heed_penalties": ...,
    "registration_deadline_hours": ...,
    "youtube_url": ...,
    "mazemap_poi": ...,
    "responsible_users": ...,
    "is_foreign_language": ...,
    "can_edit_users": ...,
    "can_view_groups": ...,
    "can_edit_groups": ...,
    "require_auth": ...,
}
result = client.action(schema, action, params=params)

cover_image_gallery

GET /api/v1/events/cover_image_gallery/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events cover_image_gallery

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 = ["events", "cover_image_gallery"]
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("/api/")

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

GET /api/v1/events/previous/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events previous

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 = ["events", "previous"]
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("/api/")

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

upcoming

GET /api/v1/events/upcoming/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events upcoming

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 = ["events", "upcoming"]
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("/api/")

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

read

GET /api/v1/events/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`date_after`
`date_before`
`company`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events read -p id=... -p date_after=... -p date_before=... -p company=... -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 = ["events", "read"]
var params = {
    id: ...,
    date_after: ...,
    date_before: ...,
    company: ...,
    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("/api/")

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

update

PUT /api/v1/events/{id}/

If the capacity of the event increases we have to bump waiting users.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`date_after`
`date_before`
`company`
`ordering`	Which field to use when ordering the results.

Request Body

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

Parameter	Description
`title` required
`cover`
`description` required
`text` required
`company`
`responsible_group`
`feedback_description`
`feedback_required`
`event_type` required
`event_status_type`
`location` required
`is_priced`
`price_member`
`price_guest`
`use_stripe`
`payment_due_date`
`start_time` required
`end_time` required
`merge_time`
`use_captcha`
`tags`
`pools`
`unregistration_deadline`
`unregistration_deadline_hours`
`pinned`
`use_consent`
`heed_penalties`
`registration_deadline_hours`
`youtube_url`
`mazemap_poi`
`responsible_users`
`is_foreign_language`
`can_edit_users`
`can_view_groups`
`can_edit_groups`
`require_auth`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events update -p id=... -p title=... -p cover=... -p description=... -p text=... -p company=... -p responsible_group=... -p feedback_description=... -p feedback_required=... -p event_type=... -p event_status_type=... -p location=... -p is_priced=... -p price_member=... -p price_guest=... -p use_stripe=... -p payment_due_date=... -p start_time=... -p end_time=... -p merge_time=... -p use_captcha=... -p tags=... -p pools=... -p unregistration_deadline=... -p unregistration_deadline_hours=... -p pinned=... -p use_consent=... -p heed_penalties=... -p registration_deadline_hours=... -p youtube_url=... -p mazemap_poi=... -p responsible_users=... -p is_foreign_language=... -p can_edit_users=... -p can_view_groups=... -p can_edit_groups=... -p require_auth=... -p date_after=... -p date_before=... -p company=... -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 = ["events", "update"]
var params = {
    id: ...,
    title: ...,
    cover: ...,
    description: ...,
    text: ...,
    company: ...,
    responsible_group: ...,
    feedback_description: ...,
    feedback_required: ...,
    event_type: ...,
    event_status_type: ...,
    location: ...,
    is_priced: ...,
    price_member: ...,
    price_guest: ...,
    use_stripe: ...,
    payment_due_date: ...,
    start_time: ...,
    end_time: ...,
    merge_time: ...,
    use_captcha: ...,
    tags: ...,
    pools: ...,
    unregistration_deadline: ...,
    unregistration_deadline_hours: ...,
    pinned: ...,
    use_consent: ...,
    heed_penalties: ...,
    registration_deadline_hours: ...,
    youtube_url: ...,
    mazemap_poi: ...,
    responsible_users: ...,
    is_foreign_language: ...,
    can_edit_users: ...,
    can_view_groups: ...,
    can_edit_groups: ...,
    require_auth: ...,
    date_after: ...,
    date_before: ...,
    company: ...,
    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("/api/")

# Interact with the API endpoint
action = ["events", "update"]
params = {
    "id": ...,
    "title": ...,
    "cover": ...,
    "description": ...,
    "text": ...,
    "company": ...,
    "responsible_group": ...,
    "feedback_description": ...,
    "feedback_required": ...,
    "event_type": ...,
    "event_status_type": ...,
    "location": ...,
    "is_priced": ...,
    "price_member": ...,
    "price_guest": ...,
    "use_stripe": ...,
    "payment_due_date": ...,
    "start_time": ...,
    "end_time": ...,
    "merge_time": ...,
    "use_captcha": ...,
    "tags": ...,
    "pools": ...,
    "unregistration_deadline": ...,
    "unregistration_deadline_hours": ...,
    "pinned": ...,
    "use_consent": ...,
    "heed_penalties": ...,
    "registration_deadline_hours": ...,
    "youtube_url": ...,
    "mazemap_poi": ...,
    "responsible_users": ...,
    "is_foreign_language": ...,
    "can_edit_users": ...,
    "can_view_groups": ...,
    "can_edit_groups": ...,
    "require_auth": ...,
    "date_after": ...,
    "date_before": ...,
    "company": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/events/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`date_after`
`date_before`
`company`
`ordering`	Which field to use when ordering the results.

Request Body

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

Parameter	Description
`title`
`cover`
`description`
`text`
`company`
`responsible_group`
`feedback_description`
`feedback_required`
`event_type`
`event_status_type`
`location`
`is_priced`
`price_member`
`price_guest`
`use_stripe`
`payment_due_date`
`start_time`
`end_time`
`merge_time`
`use_captcha`
`tags`
`pools`
`unregistration_deadline`
`unregistration_deadline_hours`
`pinned`
`use_consent`
`heed_penalties`
`registration_deadline_hours`
`youtube_url`
`mazemap_poi`
`responsible_users`
`is_foreign_language`
`can_edit_users`
`can_view_groups`
`can_edit_groups`
`require_auth`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events partial_update -p id=... -p title=... -p cover=... -p description=... -p text=... -p company=... -p responsible_group=... -p feedback_description=... -p feedback_required=... -p event_type=... -p event_status_type=... -p location=... -p is_priced=... -p price_member=... -p price_guest=... -p use_stripe=... -p payment_due_date=... -p start_time=... -p end_time=... -p merge_time=... -p use_captcha=... -p tags=... -p pools=... -p unregistration_deadline=... -p unregistration_deadline_hours=... -p pinned=... -p use_consent=... -p heed_penalties=... -p registration_deadline_hours=... -p youtube_url=... -p mazemap_poi=... -p responsible_users=... -p is_foreign_language=... -p can_edit_users=... -p can_view_groups=... -p can_edit_groups=... -p require_auth=... -p date_after=... -p date_before=... -p company=... -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 = ["events", "partial_update"]
var params = {
    id: ...,
    title: ...,
    cover: ...,
    description: ...,
    text: ...,
    company: ...,
    responsible_group: ...,
    feedback_description: ...,
    feedback_required: ...,
    event_type: ...,
    event_status_type: ...,
    location: ...,
    is_priced: ...,
    price_member: ...,
    price_guest: ...,
    use_stripe: ...,
    payment_due_date: ...,
    start_time: ...,
    end_time: ...,
    merge_time: ...,
    use_captcha: ...,
    tags: ...,
    pools: ...,
    unregistration_deadline: ...,
    unregistration_deadline_hours: ...,
    pinned: ...,
    use_consent: ...,
    heed_penalties: ...,
    registration_deadline_hours: ...,
    youtube_url: ...,
    mazemap_poi: ...,
    responsible_users: ...,
    is_foreign_language: ...,
    can_edit_users: ...,
    can_view_groups: ...,
    can_edit_groups: ...,
    require_auth: ...,
    date_after: ...,
    date_before: ...,
    company: ...,
    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("/api/")

# Interact with the API endpoint
action = ["events", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "cover": ...,
    "description": ...,
    "text": ...,
    "company": ...,
    "responsible_group": ...,
    "feedback_description": ...,
    "feedback_required": ...,
    "event_type": ...,
    "event_status_type": ...,
    "location": ...,
    "is_priced": ...,
    "price_member": ...,
    "price_guest": ...,
    "use_stripe": ...,
    "payment_due_date": ...,
    "start_time": ...,
    "end_time": ...,
    "merge_time": ...,
    "use_captcha": ...,
    "tags": ...,
    "pools": ...,
    "unregistration_deadline": ...,
    "unregistration_deadline_hours": ...,
    "pinned": ...,
    "use_consent": ...,
    "heed_penalties": ...,
    "registration_deadline_hours": ...,
    "youtube_url": ...,
    "mazemap_poi": ...,
    "responsible_users": ...,
    "is_foreign_language": ...,
    "can_edit_users": ...,
    "can_view_groups": ...,
    "can_edit_groups": ...,
    "require_auth": ...,
    "date_after": ...,
    "date_before": ...,
    "company": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/events/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`date_after`
`date_before`
`company`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events delete -p id=... -p date_after=... -p date_before=... -p company=... -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 = ["events", "delete"]
var params = {
    id: ...,
    date_after: ...,
    date_before: ...,
    company: ...,
    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("/api/")

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

administrate

GET /api/v1/events/{id}/administrate/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events administrate -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 = ["events", "administrate"]
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("/api/")

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

allergies

GET /api/v1/events/{id}/allergies/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events allergies -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 = ["events", "allergies"]
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("/api/")

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

payment

POST /api/v1/events/{id}/payment/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events payment -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 = ["events", "payment"]
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("/api/")

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

statistics

GET /api/v1/events/{id}/statistics/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events statistics -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 = ["events", "statistics"]
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("/api/")

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

pools > create

POST /api/v1/events/{event_pk}/pools/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event_pk` required

Request Body

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

Parameter	Description
`id`
`name` required
`capacity`
`activation_date` required
`permission_groups` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events pools create -p event_pk=... -p id=... -p name=... -p capacity=... -p activation_date=... -p permission_groups=...

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 = ["events", "pools &gt; create"]
var params = {
    event_pk: ...,
    id: ...,
    name: ...,
    capacity: ...,
    activation_date: ...,
    permission_groups: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "pools &gt; create"]
params = {
    "event_pk": ...,
    "id": ...,
    "name": ...,
    "capacity": ...,
    "activation_date": ...,
    "permission_groups": ...,
}
result = client.action(schema, action, params=params)

pools > update

PUT /api/v1/events/{event_pk}/pools/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`id`
`name` required
`capacity`
`activation_date` required
`permission_groups` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events pools update -p event_pk=... -p id=... -p id=... -p name=... -p capacity=... -p activation_date=... -p permission_groups=...

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 = ["events", "pools &gt; update"]
var params = {
    event_pk: ...,
    id: ...,
    id: ...,
    name: ...,
    capacity: ...,
    activation_date: ...,
    permission_groups: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "pools &gt; update"]
params = {
    "event_pk": ...,
    "id": ...,
    "id": ...,
    "name": ...,
    "capacity": ...,
    "activation_date": ...,
    "permission_groups": ...,
}
result = client.action(schema, action, params=params)

pools > partial_update

PATCH /api/v1/events/{event_pk}/pools/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`id`
`name`
`capacity`
`activation_date`
`permission_groups`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events pools partial_update -p event_pk=... -p id=... -p id=... -p name=... -p capacity=... -p activation_date=... -p permission_groups=...

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 = ["events", "pools &gt; partial_update"]
var params = {
    event_pk: ...,
    id: ...,
    id: ...,
    name: ...,
    capacity: ...,
    activation_date: ...,
    permission_groups: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "pools &gt; partial_update"]
params = {
    "event_pk": ...,
    "id": ...,
    "id": ...,
    "name": ...,
    "capacity": ...,
    "activation_date": ...,
    "permission_groups": ...,
}
result = client.action(schema, action, params=params)

pools > delete

DELETE /api/v1/events/{event_pk}/pools/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events pools delete -p event_pk=... -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 = ["events", "pools &gt; delete"]
var params = {
    event_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["events", "pools &gt; delete"]
params = {
    "event_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

registration_search > create

POST /api/v1/events/{event_pk}/registration_search/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event_pk` required

Request Body

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

Parameter	Description
`username` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events registration_search create -p event_pk=... -p username=...

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 = ["events", "registration_search &gt; create"]
var params = {
    event_pk: ...,
    username: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "registration_search &gt; create"]
params = {
    "event_pk": ...,
    "username": ...,
}
result = client.action(schema, action, params=params)

registrations > create

POST /api/v1/events/{event_pk}/registrations/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event_pk` required

Request Body

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

Parameter	Description
`feedback`
`presence`
`captcha_response`
`payment_status`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events registrations create -p event_pk=... -p feedback=... -p presence=... -p captcha_response=... -p payment_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 = ["events", "registrations &gt; create"]
var params = {
    event_pk: ...,
    feedback: ...,
    presence: ...,
    captcha_response: ...,
    payment_status: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "registrations &gt; create"]
params = {
    "event_pk": ...,
    "feedback": ...,
    "presence": ...,
    "captcha_response": ...,
    "payment_status": ...,
}
result = client.action(schema, action, params=params)

registrations > admin_register

POST /api/v1/events/{event_pk}/registrations/admin_register/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event_pk` required

Request Body

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

Parameter	Description
`user` required
`pool`
`feedback`
`admin_registration_reason` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events registrations admin_register -p event_pk=... -p user=... -p pool=... -p feedback=... -p admin_registration_reason=...

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 = ["events", "registrations &gt; admin_register"]
var params = {
    event_pk: ...,
    user: ...,
    pool: ...,
    feedback: ...,
    admin_registration_reason: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "registrations &gt; admin_register"]
params = {
    "event_pk": ...,
    "user": ...,
    "pool": ...,
    "feedback": ...,
    "admin_registration_reason": ...,
}
result = client.action(schema, action, params=params)

registrations > admin_unregister

POST /api/v1/events/{event_pk}/registrations/admin_unregister/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event_pk` required

Request Body

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

Parameter	Description
`user` required
`admin_unregistration_reason` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events registrations admin_unregister -p event_pk=... -p user=... -p admin_unregistration_reason=...

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 = ["events", "registrations &gt; admin_unregister"]
var params = {
    event_pk: ...,
    user: ...,
    admin_unregistration_reason: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "registrations &gt; admin_unregister"]
params = {
    "event_pk": ...,
    "user": ...,
    "admin_unregistration_reason": ...,
}
result = client.action(schema, action, params=params)

registrations > read

GET /api/v1/events/{event_pk}/registrations/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event_pk` required
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events registrations read -p event_pk=... -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 = ["events", "registrations &gt; read"]
var params = {
    event_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["events", "registrations &gt; read"]
params = {
    "event_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

registrations > update

PUT /api/v1/events/{event_pk}/registrations/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event_pk` required
`id` required

Request Body

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

Parameter	Description
`feedback`
`presence`
`captcha_response`
`payment_status`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events registrations update -p event_pk=... -p id=... -p feedback=... -p presence=... -p captcha_response=... -p payment_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 = ["events", "registrations &gt; update"]
var params = {
    event_pk: ...,
    id: ...,
    feedback: ...,
    presence: ...,
    captcha_response: ...,
    payment_status: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "registrations &gt; update"]
params = {
    "event_pk": ...,
    "id": ...,
    "feedback": ...,
    "presence": ...,
    "captcha_response": ...,
    "payment_status": ...,
}
result = client.action(schema, action, params=params)

registrations > partial_update

PATCH /api/v1/events/{event_pk}/registrations/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event_pk` required
`id` required

Request Body

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

Parameter	Description
`feedback`
`presence`
`captcha_response`
`payment_status`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events registrations partial_update -p event_pk=... -p id=... -p feedback=... -p presence=... -p captcha_response=... -p payment_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 = ["events", "registrations &gt; partial_update"]
var params = {
    event_pk: ...,
    id: ...,
    feedback: ...,
    presence: ...,
    captcha_response: ...,
    payment_status: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["events", "registrations &gt; partial_update"]
params = {
    "event_pk": ...,
    "id": ...,
    "feedback": ...,
    "presence": ...,
    "captcha_response": ...,
    "payment_status": ...,
}
result = client.action(schema, action, params=params)

registrations > delete

DELETE /api/v1/events/{event_pk}/registrations/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event_pk` required
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action events registrations delete -p event_pk=... -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 = ["events", "registrations &gt; delete"]
var params = {
    event_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["events", "registrations &gt; delete"]
params = {
    "event_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

feed-notifications

list

GET /api/v1/feed-notifications/

Notifications feed based on request.user

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action feed-notifications list -p cursor=...

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-notifications", "list"]
var params = {
    cursor: ...,
}
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("/api/")

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

mark_all

POST /api/v1/feed-notifications/mark_all/

This function marks all activities in a NotificationFeed as seen or/and red.

Request Body

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

Parameter	Description
`seen`
`read`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action feed-notifications mark_all -p seen=... -p 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 = ["feed-notifications", "mark_all"]
var params = {
    seen: ...,
    read: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["feed-notifications", "mark_all"]
params = {
    "seen": ...,
    "read": ...,
}
result = client.action(schema, action, params=params)

notification_data

GET /api/v1/feed-notifications/notification_data/

Notifications feed based on request.user

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action feed-notifications notification_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 = ["feed-notifications", "notification_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("/api/")

# Interact with the API endpoint
action = ["feed-notifications", "notification_data"]
result = client.action(schema, action)

mark

POST /api/v1/feed-notifications/{id}/mark/

Mark a single notification as read or seen.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

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

Parameter	Description
`seen`
`read`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action feed-notifications mark -p id=... -p seen=... -p 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 = ["feed-notifications", "mark"]
var params = {
    id: ...,
    seen: ...,
    read: ...,
}
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("/api/")

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

feed-personal

list

GET /api/v1/feed-personal/

Personal user timeline, based on request.user

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action feed-personal list -p cursor=...

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-personal", "list"]
var params = {
    cursor: ...,
}
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("/api/")

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

feed-user

list

GET /api/v1/feed-user/{user_pk}/

Public events produced by users. This feed should not contain private information! This feed uses a url param to decide which feed to retrieve.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_pk` required

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action feed-user list -p user_pk=... -p cursor=...

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-user", "list"]
var params = {
    user_pk: ...,
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["feed-user", "list"]
params = {
    "user_pk": ...,
    "cursor": ...,
}
result = client.action(schema, action, params=params)

files

create

POST /api/v1/files/

Upload new file. This method returns instructions to the client on how to upload the file.

Request Body

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

Parameter	Description
`key` required
`public` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action files create -p key=... -p public=...

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 = ["files", "create"]
var params = {
    key: ...,
    public: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["files", "create"]
params = {
    "key": ...,
    "public": ...,
}
result = client.action(schema, action, params=params)

imagegallery

PATCH /api/v1/files/{key}/imagegallery/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`key` required	A unique value identifying this file.

Request Body

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

Parameter	Description
`key`
`public`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action files imagegallery -p key=... -p key=... -p public=...

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 = ["files", "imagegallery"]
var params = {
    key: ...,
    key: ...,
    public: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["files", "imagegallery"]
params = {
    "key": ...,
    "key": ...,
    "public": ...,
}
result = client.action(schema, action, params=params)

upload_success

GET /api/v1/files/{key}/upload_success/

The client is redirected to this view when a upload succeeds. This view will inform the client with necessary data to change a file on a instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`key` required	A unique value identifying this file.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action files upload_success -p key=...

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 = ["files", "upload_success"]
var params = {
    key: ...,
}
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("/api/")

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

followers-company

list

GET /api/v1/followers-company/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`target`
`follower`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action followers-company list -p cursor=... -p target=... -p follower=...

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 = ["followers-company", "list"]
var params = {
    cursor: ...,
    target: ...,
    follower: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["followers-company", "list"]
params = {
    "cursor": ...,
    "target": ...,
    "follower": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/followers-company/

Request Body

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

Parameter	Description
`target` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action followers-company create -p target=...

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 = ["followers-company", "create"]
var params = {
    target: ...,
}
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("/api/")

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

delete

DELETE /api/v1/followers-company/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`target`
`follower`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action followers-company delete -p id=... -p target=... -p follower=...

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 = ["followers-company", "delete"]
var params = {
    id: ...,
    target: ...,
    follower: ...,
}
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("/api/")

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

followers-event

list

GET /api/v1/followers-event/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`target`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action followers-event list -p cursor=... -p target=...

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 = ["followers-event", "list"]
var params = {
    cursor: ...,
    target: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["followers-event", "list"]
params = {
    "cursor": ...,
    "target": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/followers-event/

Request Body

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

Parameter	Description
`target` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action followers-event create -p target=...

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 = ["followers-event", "create"]
var params = {
    target: ...,
}
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("/api/")

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

delete

DELETE /api/v1/followers-event/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`target`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action followers-event delete -p id=... -p target=...

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 = ["followers-event", "delete"]
var params = {
    id: ...,
    target: ...,
}
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("/api/")

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

followers-user

list

GET /api/v1/followers-user/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`target`
`follower`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action followers-user list -p cursor=... -p target=... -p follower=...

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 = ["followers-user", "list"]
var params = {
    cursor: ...,
    target: ...,
    follower: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["followers-user", "list"]
params = {
    "cursor": ...,
    "target": ...,
    "follower": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/followers-user/

Request Body

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

Parameter	Description
`target` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action followers-user create -p target=...

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 = ["followers-user", "create"]
var params = {
    target: ...,
}
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("/api/")

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

delete

DELETE /api/v1/followers-user/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`target`
`follower`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action followers-user delete -p id=... -p target=... -p follower=...

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 = ["followers-user", "delete"]
var params = {
    id: ...,
    target: ...,
    follower: ...,
}
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("/api/")

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

forums

list

GET /api/v1/forums/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums list -p cursor=...

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 = ["forums", "list"]
var params = {
    cursor: ...,
}
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("/api/")

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

create

POST /api/v1/forums/

Request Body

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

Parameter	Description
`title` required
`description` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums create -p title=... -p description=...

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 = ["forums", "create"]
var params = {
    title: ...,
    description: ...,
}
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("/api/")

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

read

GET /api/v1/forums/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums 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 = ["forums", "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("/api/")

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

update

PUT /api/v1/forums/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title` required
`description` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums update -p id=... -p title=... -p description=...

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 = ["forums", "update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
}
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("/api/")

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

partial_update

PATCH /api/v1/forums/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title`
`description`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums partial_update -p id=... -p title=... -p description=...

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 = ["forums", "partial_update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["forums", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "description": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/forums/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums 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 = ["forums", "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("/api/")

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

threads > list

GET /api/v1/forums/{forum_pk}/threads/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`forum_pk` required

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums threads list -p forum_pk=... -p cursor=...

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 = ["forums", "threads &gt; list"]
var params = {
    forum_pk: ...,
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["forums", "threads &gt; list"]
params = {
    "forum_pk": ...,
    "cursor": ...,
}
result = client.action(schema, action, params=params)

threads > create

POST /api/v1/forums/{forum_pk}/threads/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`forum_pk` required

Request Body

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

Parameter	Description
`title` required
`content` required
`forum` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums threads create -p forum_pk=... -p title=... -p content=... -p forum=...

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 = ["forums", "threads &gt; create"]
var params = {
    forum_pk: ...,
    title: ...,
    content: ...,
    forum: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["forums", "threads &gt; create"]
params = {
    "forum_pk": ...,
    "title": ...,
    "content": ...,
    "forum": ...,
}
result = client.action(schema, action, params=params)

threads > read

GET /api/v1/forums/{forum_pk}/threads/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums threads read -p forum_pk=... -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 = ["forums", "threads &gt; read"]
var params = {
    forum_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["forums", "threads &gt; read"]
params = {
    "forum_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

threads > update

PUT /api/v1/forums/{forum_pk}/threads/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title` required
`content` required
`forum` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums threads update -p forum_pk=... -p id=... -p title=... -p content=... -p forum=...

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 = ["forums", "threads &gt; update"]
var params = {
    forum_pk: ...,
    id: ...,
    title: ...,
    content: ...,
    forum: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["forums", "threads &gt; update"]
params = {
    "forum_pk": ...,
    "id": ...,
    "title": ...,
    "content": ...,
    "forum": ...,
}
result = client.action(schema, action, params=params)

threads > partial_update

PATCH /api/v1/forums/{forum_pk}/threads/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title`
`content`
`forum`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums threads partial_update -p forum_pk=... -p id=... -p title=... -p content=... -p forum=...

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 = ["forums", "threads &gt; partial_update"]
var params = {
    forum_pk: ...,
    id: ...,
    title: ...,
    content: ...,
    forum: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["forums", "threads &gt; partial_update"]
params = {
    "forum_pk": ...,
    "id": ...,
    "title": ...,
    "content": ...,
    "forum": ...,
}
result = client.action(schema, action, params=params)

threads > delete

DELETE /api/v1/forums/{forum_pk}/threads/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action forums threads delete -p forum_pk=... -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 = ["forums", "threads &gt; delete"]
var params = {
    forum_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["forums", "threads &gt; delete"]
params = {
    "forum_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

frontpage

list

GET /api/v1/frontpage/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action frontpage 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 = ["frontpage", "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("/api/")

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

galleries

list

GET /api/v1/galleries/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`date_after`
`date_before`
`event`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries list -p cursor=... -p date_after=... -p date_before=... -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 = ["galleries", "list"]
var params = {
    cursor: ...,
    date_after: ...,
    date_before: ...,
    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("/api/")

# Interact with the API endpoint
action = ["galleries", "list"]
params = {
    "cursor": ...,
    "date_after": ...,
    "date_before": ...,
    "event": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/galleries/

Request Body

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

Parameter	Description
`title` required
`description`
`location` required
`taken_at`
`event`
`photographers` required
`cover`
`public_metadata`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries create -p title=... -p description=... -p location=... -p taken_at=... -p event=... -p photographers=... -p cover=... -p public_metadata=...

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 = ["galleries", "create"]
var params = {
    title: ...,
    description: ...,
    location: ...,
    taken_at: ...,
    event: ...,
    photographers: ...,
    cover: ...,
    public_metadata: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["galleries", "create"]
params = {
    "title": ...,
    "description": ...,
    "location": ...,
    "taken_at": ...,
    "event": ...,
    "photographers": ...,
    "cover": ...,
    "public_metadata": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/galleries/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`date_after`
`date_before`
`event`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries read -p id=... -p date_after=... -p date_before=... -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 = ["galleries", "read"]
var params = {
    id: ...,
    date_after: ...,
    date_before: ...,
    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("/api/")

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

update

PUT /api/v1/galleries/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`date_after`
`date_before`
`event`

Request Body

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

Parameter	Description
`title` required
`description`
`location` required
`taken_at`
`event`
`photographers` required
`cover`
`public_metadata`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries update -p id=... -p title=... -p description=... -p location=... -p taken_at=... -p event=... -p photographers=... -p cover=... -p public_metadata=... -p date_after=... -p date_before=... -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 = ["galleries", "update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
    location: ...,
    taken_at: ...,
    event: ...,
    photographers: ...,
    cover: ...,
    public_metadata: ...,
    date_after: ...,
    date_before: ...,
    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("/api/")

# Interact with the API endpoint
action = ["galleries", "update"]
params = {
    "id": ...,
    "title": ...,
    "description": ...,
    "location": ...,
    "taken_at": ...,
    "event": ...,
    "photographers": ...,
    "cover": ...,
    "public_metadata": ...,
    "date_after": ...,
    "date_before": ...,
    "event": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/galleries/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`date_after`
`date_before`
`event`

Request Body

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

Parameter	Description
`title`
`description`
`location`
`taken_at`
`event`
`photographers`
`cover`
`public_metadata`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries partial_update -p id=... -p title=... -p description=... -p location=... -p taken_at=... -p event=... -p photographers=... -p cover=... -p public_metadata=... -p date_after=... -p date_before=... -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 = ["galleries", "partial_update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
    location: ...,
    taken_at: ...,
    event: ...,
    photographers: ...,
    cover: ...,
    public_metadata: ...,
    date_after: ...,
    date_before: ...,
    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("/api/")

# Interact with the API endpoint
action = ["galleries", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "description": ...,
    "location": ...,
    "taken_at": ...,
    "event": ...,
    "photographers": ...,
    "cover": ...,
    "public_metadata": ...,
    "date_after": ...,
    "date_before": ...,
    "event": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/galleries/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`date_after`
`date_before`
`event`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries delete -p id=... -p date_after=... -p date_before=... -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 = ["galleries", "delete"]
var params = {
    id: ...,
    date_after: ...,
    date_before: ...,
    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("/api/")

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

metadata

GET /api/v1/galleries/{id}/metadata/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries metadata -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 = ["galleries", "metadata"]
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("/api/")

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

pictures > list

GET /api/v1/galleries/{gallery_pk}/pictures/

Nested viewset used to manage pictures in a gallery.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`gallery_pk` required

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries pictures list -p gallery_pk=... -p cursor=...

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 = ["galleries", "pictures &gt; list"]
var params = {
    gallery_pk: ...,
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["galleries", "pictures &gt; list"]
params = {
    "gallery_pk": ...,
    "cursor": ...,
}
result = client.action(schema, action, params=params)

pictures > create

POST /api/v1/galleries/{gallery_pk}/pictures/

Nested viewset used to manage pictures in a gallery.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`gallery_pk` required

Request Body

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

Parameter	Description
`description`
`taggees`
`active`
`file` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries pictures create -p gallery_pk=... -p description=... -p taggees=... -p active=... -p file=...

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 = ["galleries", "pictures &gt; create"]
var params = {
    gallery_pk: ...,
    description: ...,
    taggees: ...,
    active: ...,
    file: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["galleries", "pictures &gt; create"]
params = {
    "gallery_pk": ...,
    "description": ...,
    "taggees": ...,
    "active": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

pictures > read

GET /api/v1/galleries/{gallery_pk}/pictures/{id}/

Nested viewset used to manage pictures in a gallery.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`gallery_pk` required
`id` required	A unique integer value identifying this gallery picture.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries pictures read -p gallery_pk=... -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 = ["galleries", "pictures &gt; read"]
var params = {
    gallery_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["galleries", "pictures &gt; read"]
params = {
    "gallery_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

pictures > update

PUT /api/v1/galleries/{gallery_pk}/pictures/{id}/

Nested viewset used to manage pictures in a gallery.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`gallery_pk` required
`id` required	A unique integer value identifying this gallery picture.

Request Body

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

Parameter	Description
`description`
`taggees`
`active`
`file` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries pictures update -p gallery_pk=... -p id=... -p description=... -p taggees=... -p active=... -p file=...

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 = ["galleries", "pictures &gt; update"]
var params = {
    gallery_pk: ...,
    id: ...,
    description: ...,
    taggees: ...,
    active: ...,
    file: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["galleries", "pictures &gt; update"]
params = {
    "gallery_pk": ...,
    "id": ...,
    "description": ...,
    "taggees": ...,
    "active": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

pictures > partial_update

PATCH /api/v1/galleries/{gallery_pk}/pictures/{id}/

Nested viewset used to manage pictures in a gallery.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`gallery_pk` required
`id` required	A unique integer value identifying this gallery picture.

Request Body

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

Parameter	Description
`description`
`taggees`
`active`
`file`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries pictures partial_update -p gallery_pk=... -p id=... -p description=... -p taggees=... -p active=... -p file=...

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 = ["galleries", "pictures &gt; partial_update"]
var params = {
    gallery_pk: ...,
    id: ...,
    description: ...,
    taggees: ...,
    active: ...,
    file: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["galleries", "pictures &gt; partial_update"]
params = {
    "gallery_pk": ...,
    "id": ...,
    "description": ...,
    "taggees": ...,
    "active": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

pictures > delete

DELETE /api/v1/galleries/{gallery_pk}/pictures/{id}/

Nested viewset used to manage pictures in a gallery.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`gallery_pk` required
`id` required	A unique integer value identifying this gallery picture.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action galleries pictures delete -p gallery_pk=... -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 = ["galleries", "pictures &gt; delete"]
var params = {
    gallery_pk: ...,
    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("/api/")

# Interact with the API endpoint
action = ["galleries", "pictures &gt; delete"]
params = {
    "gallery_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

groups

list

GET /api/v1/groups/

Query Parameters

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

Parameter	Description
`type`	Multiple values may be separated by commas.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups list -p type=...

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 = ["groups", "list"]
var params = {
    type: ...,
}
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("/api/")

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

create

POST /api/v1/groups/

Request Body

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

Parameter	Description
`name` required
`description`
`contact_email`
`parent`
`permissions`
`type`
`text`
`logo`
`show_badge`
`active`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups create -p name=... -p description=... -p contact_email=... -p parent=... -p permissions=... -p type=... -p text=... -p logo=... -p show_badge=... -p active=...

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 = ["groups", "create"]
var params = {
    name: ...,
    description: ...,
    contact_email: ...,
    parent: ...,
    permissions: ...,
    type: ...,
    text: ...,
    logo: ...,
    show_badge: ...,
    active: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["groups", "create"]
params = {
    "name": ...,
    "description": ...,
    "contact_email": ...,
    "parent": ...,
    "permissions": ...,
    "type": ...,
    "text": ...,
    "logo": ...,
    "show_badge": ...,
    "active": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/groups/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`type`	Multiple values may be separated by commas.

# Load the schema document
$ coreapi get /api/

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

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 = ["groups", "read"]
var params = {
    id: ...,
    type: ...,
}
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("/api/")

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

update

PUT /api/v1/groups/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`type`	Multiple values may be separated by commas.

Request Body

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

Parameter	Description
`name` required
`description`
`contact_email`
`parent`
`permissions`
`type`
`text`
`logo`
`show_badge`
`active`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups update -p id=... -p name=... -p description=... -p contact_email=... -p parent=... -p permissions=... -p type=... -p text=... -p logo=... -p show_badge=... -p active=... -p type=...

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 = ["groups", "update"]
var params = {
    id: ...,
    name: ...,
    description: ...,
    contact_email: ...,
    parent: ...,
    permissions: ...,
    type: ...,
    text: ...,
    logo: ...,
    show_badge: ...,
    active: ...,
    type: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["groups", "update"]
params = {
    "id": ...,
    "name": ...,
    "description": ...,
    "contact_email": ...,
    "parent": ...,
    "permissions": ...,
    "type": ...,
    "text": ...,
    "logo": ...,
    "show_badge": ...,
    "active": ...,
    "type": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/groups/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`type`	Multiple values may be separated by commas.

Request Body

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

Parameter	Description
`name`
`description`
`contact_email`
`parent`
`permissions`
`type`
`text`
`logo`
`show_badge`
`active`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups partial_update -p id=... -p name=... -p description=... -p contact_email=... -p parent=... -p permissions=... -p type=... -p text=... -p logo=... -p show_badge=... -p active=... -p type=...

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 = ["groups", "partial_update"]
var params = {
    id: ...,
    name: ...,
    description: ...,
    contact_email: ...,
    parent: ...,
    permissions: ...,
    type: ...,
    text: ...,
    logo: ...,
    show_badge: ...,
    active: ...,
    type: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["groups", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "description": ...,
    "contact_email": ...,
    "parent": ...,
    "permissions": ...,
    "type": ...,
    "text": ...,
    "logo": ...,
    "show_badge": ...,
    "active": ...,
    "type": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/groups/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`type`	Multiple values may be separated by commas.

# Load the schema document
$ coreapi get /api/

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

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 = ["groups", "delete"]
var params = {
    id: ...,
    type: ...,
}
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("/api/")

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

memberships > list

GET /api/v1/groups/{group_pk}/memberships/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`group_pk` required

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`role`	Multiple values may be separated by commas.
`userUsername`
`abakusGroupName`
`userFullname`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups memberships list -p group_pk=... -p cursor=... -p role=... -p userUsername=... -p abakusGroupName=... -p userFullname=... -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 = ["groups", "memberships &gt; list"]
var params = {
    group_pk: ...,
    cursor: ...,
    role: ...,
    userUsername: ...,
    abakusGroupName: ...,
    userFullname: ...,
    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("/api/")

# Interact with the API endpoint
action = ["groups", "memberships &gt; list"]
params = {
    "group_pk": ...,
    "cursor": ...,
    "role": ...,
    "userUsername": ...,
    "abakusGroupName": ...,
    "userFullname": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

memberships > create

POST /api/v1/groups/{group_pk}/memberships/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`group_pk` required

Request Body

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

Parameter	Description
`user` required
`role`
`is_active`
`email_lists_enabled`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups memberships create -p group_pk=... -p user=... -p role=... -p is_active=... -p email_lists_enabled=...

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 = ["groups", "memberships &gt; create"]
var params = {
    group_pk: ...,
    user: ...,
    role: ...,
    is_active: ...,
    email_lists_enabled: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["groups", "memberships &gt; create"]
params = {
    "group_pk": ...,
    "user": ...,
    "role": ...,
    "is_active": ...,
    "email_lists_enabled": ...,
}
result = client.action(schema, action, params=params)

memberships > read

GET /api/v1/groups/{group_pk}/memberships/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`group_pk` required
`id` required

Query Parameters

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

Parameter	Description
`role`	Multiple values may be separated by commas.
`userUsername`
`abakusGroupName`
`userFullname`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups memberships read -p group_pk=... -p id=... -p role=... -p userUsername=... -p abakusGroupName=... -p userFullname=... -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 = ["groups", "memberships &gt; read"]
var params = {
    group_pk: ...,
    id: ...,
    role: ...,
    userUsername: ...,
    abakusGroupName: ...,
    userFullname: ...,
    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("/api/")

# Interact with the API endpoint
action = ["groups", "memberships &gt; read"]
params = {
    "group_pk": ...,
    "id": ...,
    "role": ...,
    "userUsername": ...,
    "abakusGroupName": ...,
    "userFullname": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

memberships > update

PUT /api/v1/groups/{group_pk}/memberships/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`group_pk` required
`id` required

Query Parameters

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

Parameter	Description
`role`	Multiple values may be separated by commas.
`userUsername`
`abakusGroupName`
`userFullname`
`ordering`	Which field to use when ordering the results.

Request Body

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

Parameter	Description
`user` required
`role`
`is_active`
`email_lists_enabled`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups memberships update -p group_pk=... -p id=... -p user=... -p role=... -p is_active=... -p email_lists_enabled=... -p role=... -p userUsername=... -p abakusGroupName=... -p userFullname=... -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 = ["groups", "memberships &gt; update"]
var params = {
    group_pk: ...,
    id: ...,
    user: ...,
    role: ...,
    is_active: ...,
    email_lists_enabled: ...,
    role: ...,
    userUsername: ...,
    abakusGroupName: ...,
    userFullname: ...,
    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("/api/")

# Interact with the API endpoint
action = ["groups", "memberships &gt; update"]
params = {
    "group_pk": ...,
    "id": ...,
    "user": ...,
    "role": ...,
    "is_active": ...,
    "email_lists_enabled": ...,
    "role": ...,
    "userUsername": ...,
    "abakusGroupName": ...,
    "userFullname": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

memberships > partial_update

PATCH /api/v1/groups/{group_pk}/memberships/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`group_pk` required
`id` required

Query Parameters

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

Parameter	Description
`role`	Multiple values may be separated by commas.
`userUsername`
`abakusGroupName`
`userFullname`
`ordering`	Which field to use when ordering the results.

Request Body

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

Parameter	Description
`user`
`role`
`is_active`
`email_lists_enabled`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups memberships partial_update -p group_pk=... -p id=... -p user=... -p role=... -p is_active=... -p email_lists_enabled=... -p role=... -p userUsername=... -p abakusGroupName=... -p userFullname=... -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 = ["groups", "memberships &gt; partial_update"]
var params = {
    group_pk: ...,
    id: ...,
    user: ...,
    role: ...,
    is_active: ...,
    email_lists_enabled: ...,
    role: ...,
    userUsername: ...,
    abakusGroupName: ...,
    userFullname: ...,
    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("/api/")

# Interact with the API endpoint
action = ["groups", "memberships &gt; partial_update"]
params = {
    "group_pk": ...,
    "id": ...,
    "user": ...,
    "role": ...,
    "is_active": ...,
    "email_lists_enabled": ...,
    "role": ...,
    "userUsername": ...,
    "abakusGroupName": ...,
    "userFullname": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

memberships > delete

DELETE /api/v1/groups/{group_pk}/memberships/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`group_pk` required
`id` required

Query Parameters

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

Parameter	Description
`role`	Multiple values may be separated by commas.
`userUsername`
`abakusGroupName`
`userFullname`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action groups memberships delete -p group_pk=... -p id=... -p role=... -p userUsername=... -p abakusGroupName=... -p userFullname=... -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 = ["groups", "memberships &gt; delete"]
var params = {
    group_pk: ...,
    id: ...,
    role: ...,
    userUsername: ...,
    abakusGroupName: ...,
    userFullname: ...,
    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("/api/")

# Interact with the API endpoint
action = ["groups", "memberships &gt; delete"]
params = {
    "group_pk": ...,
    "id": ...,
    "role": ...,
    "userUsername": ...,
    "abakusGroupName": ...,
    "userFullname": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

joblistings

list

GET /api/v1/joblistings/

Query Parameters

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

Parameter	Description
`company`
`created_after`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action joblistings list -p company=... -p created_after=...

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 = ["joblistings", "list"]
var params = {
    company: ...,
    created_after: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["joblistings", "list"]
params = {
    "company": ...,
    "created_after": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/joblistings/

Request Body

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

Parameter	Description
`title` required
`text` required
`company` required
`responsible`
`contact_mail`
`description` required
`deadline`
`visible_from` required
`visible_to` required
`job_type` required
`workplaces` required
`from_year`
`to_year`
`application_url`
`youtube_url`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action joblistings create -p title=... -p text=... -p company=... -p responsible=... -p contact_mail=... -p description=... -p deadline=... -p visible_from=... -p visible_to=... -p job_type=... -p workplaces=... -p from_year=... -p to_year=... -p application_url=... -p youtube_url=...

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 = ["joblistings", "create"]
var params = {
    title: ...,
    text: ...,
    company: ...,
    responsible: ...,
    contact_mail: ...,
    description: ...,
    deadline: ...,
    visible_from: ...,
    visible_to: ...,
    job_type: ...,
    workplaces: ...,
    from_year: ...,
    to_year: ...,
    application_url: ...,
    youtube_url: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["joblistings", "create"]
params = {
    "title": ...,
    "text": ...,
    "company": ...,
    "responsible": ...,
    "contact_mail": ...,
    "description": ...,
    "deadline": ...,
    "visible_from": ...,
    "visible_to": ...,
    "job_type": ...,
    "workplaces": ...,
    "from_year": ...,
    "to_year": ...,
    "application_url": ...,
    "youtube_url": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/joblistings/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`company`
`created_after`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action joblistings read -p id=... -p company=... -p created_after=...

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 = ["joblistings", "read"]
var params = {
    id: ...,
    company: ...,
    created_after: ...,
}
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("/api/")

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

update

PUT /api/v1/joblistings/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`company`
`created_after`

Request Body

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

Parameter	Description
`title` required
`text` required
`company` required
`responsible`
`contact_mail`
`description` required
`deadline`
`visible_from` required
`visible_to` required
`job_type` required
`workplaces` required
`from_year`
`to_year`
`application_url`
`youtube_url`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action joblistings update -p id=... -p title=... -p text=... -p company=... -p responsible=... -p contact_mail=... -p description=... -p deadline=... -p visible_from=... -p visible_to=... -p job_type=... -p workplaces=... -p from_year=... -p to_year=... -p application_url=... -p youtube_url=... -p company=... -p created_after=...

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 = ["joblistings", "update"]
var params = {
    id: ...,
    title: ...,
    text: ...,
    company: ...,
    responsible: ...,
    contact_mail: ...,
    description: ...,
    deadline: ...,
    visible_from: ...,
    visible_to: ...,
    job_type: ...,
    workplaces: ...,
    from_year: ...,
    to_year: ...,
    application_url: ...,
    youtube_url: ...,
    company: ...,
    created_after: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["joblistings", "update"]
params = {
    "id": ...,
    "title": ...,
    "text": ...,
    "company": ...,
    "responsible": ...,
    "contact_mail": ...,
    "description": ...,
    "deadline": ...,
    "visible_from": ...,
    "visible_to": ...,
    "job_type": ...,
    "workplaces": ...,
    "from_year": ...,
    "to_year": ...,
    "application_url": ...,
    "youtube_url": ...,
    "company": ...,
    "created_after": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/joblistings/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`company`
`created_after`

Request Body

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

Parameter	Description
`title`
`text`
`company`
`responsible`
`contact_mail`
`description`
`deadline`
`visible_from`
`visible_to`
`job_type`
`workplaces`
`from_year`
`to_year`
`application_url`
`youtube_url`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action joblistings partial_update -p id=... -p title=... -p text=... -p company=... -p responsible=... -p contact_mail=... -p description=... -p deadline=... -p visible_from=... -p visible_to=... -p job_type=... -p workplaces=... -p from_year=... -p to_year=... -p application_url=... -p youtube_url=... -p company=... -p created_after=...

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 = ["joblistings", "partial_update"]
var params = {
    id: ...,
    title: ...,
    text: ...,
    company: ...,
    responsible: ...,
    contact_mail: ...,
    description: ...,
    deadline: ...,
    visible_from: ...,
    visible_to: ...,
    job_type: ...,
    workplaces: ...,
    from_year: ...,
    to_year: ...,
    application_url: ...,
    youtube_url: ...,
    company: ...,
    created_after: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["joblistings", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "text": ...,
    "company": ...,
    "responsible": ...,
    "contact_mail": ...,
    "description": ...,
    "deadline": ...,
    "visible_from": ...,
    "visible_to": ...,
    "job_type": ...,
    "workplaces": ...,
    "from_year": ...,
    "to_year": ...,
    "application_url": ...,
    "youtube_url": ...,
    "company": ...,
    "created_after": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/joblistings/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`company`
`created_after`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action joblistings delete -p id=... -p company=... -p created_after=...

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 = ["joblistings", "delete"]
var params = {
    id: ...,
    company: ...,
    created_after: ...,
}
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("/api/")

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

lending

objects > list

GET /api/v1/lending/objects/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action lending objects list -p cursor=...

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 = ["lending", "objects &gt; list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["lending", "objects &gt; list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

objects > create

POST /api/v1/lending/objects/

Request Body

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

Parameter	Description
`title` required
`description`
`image`
`location`
`can_edit_users`
`can_view_groups`
`can_edit_groups`
`require_auth`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action lending objects create -p title=... -p description=... -p image=... -p location=... -p can_edit_users=... -p can_view_groups=... -p can_edit_groups=... -p require_auth=...

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 = ["lending", "objects &gt; create"]
var params = {
    title: ...,
    description: ...,
    image: ...,
    location: ...,
    can_edit_users: ...,
    can_view_groups: ...,
    can_edit_groups: ...,
    require_auth: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["lending", "objects &gt; create"]
params = {
    "title": ...,
    "description": ...,
    "image": ...,
    "location": ...,
    "can_edit_users": ...,
    "can_view_groups": ...,
    "can_edit_groups": ...,
    "require_auth": ...,
}
result = client.action(schema, action, params=params)

objects > read

GET /api/v1/lending/objects/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action lending objects 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 = ["lending", "objects &gt; 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("/api/")

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

objects > update

PUT /api/v1/lending/objects/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title` required
`description`
`image`
`location`
`can_edit_users`
`can_view_groups`
`can_edit_groups`
`require_auth`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action lending objects update -p id=... -p title=... -p description=... -p image=... -p location=... -p can_edit_users=... -p can_view_groups=... -p can_edit_groups=... -p require_auth=...

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 = ["lending", "objects &gt; update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
    image: ...,
    location: ...,
    can_edit_users: ...,
    can_view_groups: ...,
    can_edit_groups: ...,
    require_auth: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["lending", "objects &gt; update"]
params = {
    "id": ...,
    "title": ...,
    "description": ...,
    "image": ...,
    "location": ...,
    "can_edit_users": ...,
    "can_view_groups": ...,
    "can_edit_groups": ...,
    "require_auth": ...,
}
result = client.action(schema, action, params=params)

objects > partial_update

PATCH /api/v1/lending/objects/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title`
`description`
`image`
`location`
`can_edit_users`
`can_view_groups`
`can_edit_groups`
`require_auth`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action lending objects partial_update -p id=... -p title=... -p description=... -p image=... -p location=... -p can_edit_users=... -p can_view_groups=... -p can_edit_groups=... -p require_auth=...

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 = ["lending", "objects &gt; partial_update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
    image: ...,
    location: ...,
    can_edit_users: ...,
    can_view_groups: ...,
    can_edit_groups: ...,
    require_auth: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["lending", "objects &gt; partial_update"]
params = {
    "id": ...,
    "title": ...,
    "description": ...,
    "image": ...,
    "location": ...,
    "can_edit_users": ...,
    "can_view_groups": ...,
    "can_edit_groups": ...,
    "require_auth": ...,
}
result = client.action(schema, action, params=params)

objects > delete

DELETE /api/v1/lending/objects/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action lending objects 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 = ["lending", "objects &gt; 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("/api/")

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

meeting-token

list

GET /api/v1/meeting-token/

Accept or reject invitation

Reject or accept invitation to meeting. It is genereated when user is invited to a meeting, and sendt in the invitation email.

To accept: accept/?token=yourtoken

To reject: reject/?token=yourtoken

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meeting-token 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 = ["meeting-token", "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("/api/")

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

accept

POST /api/v1/meeting-token/accept/

Accept or reject invitation

Reject or accept invitation to meeting. It is genereated when user is invited to a meeting, and sendt in the invitation email.

To accept: accept/?token=yourtoken

To reject: reject/?token=yourtoken

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meeting-token accept

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 = ["meeting-token", "accept"]
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("/api/")

# Interact with the API endpoint
action = ["meeting-token", "accept"]
result = client.action(schema, action)

reject

POST /api/v1/meeting-token/reject/

Accept or reject invitation

Reject or accept invitation to meeting. It is genereated when user is invited to a meeting, and sendt in the invitation email.

To accept: accept/?token=yourtoken

To reject: reject/?token=yourtoken

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meeting-token reject

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 = ["meeting-token", "reject"]
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("/api/")

# Interact with the API endpoint
action = ["meeting-token", "reject"]
result = client.action(schema, action)

meetings

list

GET /api/v1/meetings/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`date_after`
`date_before`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings list -p cursor=... -p date_after=... -p date_before=...

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 = ["meetings", "list"]
var params = {
    cursor: ...,
    date_after: ...,
    date_before: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["meetings", "list"]
params = {
    "cursor": ...,
    "date_after": ...,
    "date_before": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/meetings/

Request Body

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

Parameter	Description
`description`
`title` required
`location` required
`start_time` required
`end_time`
`report` required
`report_author`
`mazemap_poi`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings create -p description=... -p title=... -p location=... -p start_time=... -p end_time=... -p report=... -p report_author=... -p mazemap_poi=...

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 = ["meetings", "create"]
var params = {
    description: ...,
    title: ...,
    location: ...,
    start_time: ...,
    end_time: ...,
    report: ...,
    report_author: ...,
    mazemap_poi: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["meetings", "create"]
params = {
    "description": ...,
    "title": ...,
    "location": ...,
    "start_time": ...,
    "end_time": ...,
    "report": ...,
    "report_author": ...,
    "mazemap_poi": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/meetings/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`date_after`
`date_before`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings read -p id=... -p date_after=... -p date_before=...

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 = ["meetings", "read"]
var params = {
    id: ...,
    date_after: ...,
    date_before: ...,
}
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("/api/")

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

update

PUT /api/v1/meetings/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`date_after`
`date_before`

Request Body

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

Parameter	Description
`description`
`title` required
`location` required
`start_time` required
`end_time`
`report` required
`report_author`
`mazemap_poi`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings update -p id=... -p description=... -p title=... -p location=... -p start_time=... -p end_time=... -p report=... -p report_author=... -p mazemap_poi=... -p date_after=... -p date_before=...

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 = ["meetings", "update"]
var params = {
    id: ...,
    description: ...,
    title: ...,
    location: ...,
    start_time: ...,
    end_time: ...,
    report: ...,
    report_author: ...,
    mazemap_poi: ...,
    date_after: ...,
    date_before: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["meetings", "update"]
params = {
    "id": ...,
    "description": ...,
    "title": ...,
    "location": ...,
    "start_time": ...,
    "end_time": ...,
    "report": ...,
    "report_author": ...,
    "mazemap_poi": ...,
    "date_after": ...,
    "date_before": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/meetings/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`date_after`
`date_before`

Request Body

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

Parameter	Description
`description`
`title`
`location`
`start_time`
`end_time`
`report`
`report_author`
`mazemap_poi`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings partial_update -p id=... -p description=... -p title=... -p location=... -p start_time=... -p end_time=... -p report=... -p report_author=... -p mazemap_poi=... -p date_after=... -p date_before=...

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 = ["meetings", "partial_update"]
var params = {
    id: ...,
    description: ...,
    title: ...,
    location: ...,
    start_time: ...,
    end_time: ...,
    report: ...,
    report_author: ...,
    mazemap_poi: ...,
    date_after: ...,
    date_before: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["meetings", "partial_update"]
params = {
    "id": ...,
    "description": ...,
    "title": ...,
    "location": ...,
    "start_time": ...,
    "end_time": ...,
    "report": ...,
    "report_author": ...,
    "mazemap_poi": ...,
    "date_after": ...,
    "date_before": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/meetings/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`date_after`
`date_before`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings delete -p id=... -p date_after=... -p date_before=...

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 = ["meetings", "delete"]
var params = {
    id: ...,
    date_after: ...,
    date_before: ...,
}
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("/api/")

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

bulk_invite

POST /api/v1/meetings/{id}/bulk_invite/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

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

Parameter	Description
`users`
`groups`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings bulk_invite -p id=... -p users=... -p groups=...

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 = ["meetings", "bulk_invite"]
var params = {
    id: ...,
    users: ...,
    groups: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["meetings", "bulk_invite"]
params = {
    "id": ...,
    "users": ...,
    "groups": ...,
}
result = client.action(schema, action, params=params)

invite_group

POST /api/v1/meetings/{id}/invite_group/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

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

Parameter	Description
`group` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings invite_group -p id=... -p 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 = ["meetings", "invite_group"]
var params = {
    id: ...,
    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("/api/")

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

invite_user

POST /api/v1/meetings/{id}/invite_user/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

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

Parameter	Description
`user` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings invite_user -p id=... -p user=...

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 = ["meetings", "invite_user"]
var params = {
    id: ...,
    user: ...,
}
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("/api/")

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

invitations > list

GET /api/v1/meetings/{meeting_pk}/invitations/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`meeting_pk` required

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings invitations list -p meeting_pk=... -p cursor=...

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 = ["meetings", "invitations &gt; list"]
var params = {
    meeting_pk: ...,
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["meetings", "invitations &gt; list"]
params = {
    "meeting_pk": ...,
    "cursor": ...,
}
result = client.action(schema, action, params=params)

invitations > create

POST /api/v1/meetings/{meeting_pk}/invitations/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`meeting_pk` required

Request Body

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

Parameter	Description
`user` required
`status` required
`meeting` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings invitations create -p meeting_pk=... -p user=... -p status=... -p meeting=...

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 = ["meetings", "invitations &gt; create"]
var params = {
    meeting_pk: ...,
    user: ...,
    status: ...,
    meeting: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["meetings", "invitations &gt; create"]
params = {
    "meeting_pk": ...,
    "user": ...,
    "status": ...,
    "meeting": ...,
}
result = client.action(schema, action, params=params)

invitations > read

GET /api/v1/meetings/{meeting_pk}/invitations/{user__id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`meeting_pk` required
`user__id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings invitations read -p meeting_pk=... -p user__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 = ["meetings", "invitations &gt; read"]
var params = {
    meeting_pk: ...,
    user__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("/api/")

# Interact with the API endpoint
action = ["meetings", "invitations &gt; read"]
params = {
    "meeting_pk": ...,
    "user__id": ...,
}
result = client.action(schema, action, params=params)

invitations > update

PUT /api/v1/meetings/{meeting_pk}/invitations/{user__id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`meeting_pk` required
`user__id` required

Request Body

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

Parameter	Description
`status`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings invitations update -p meeting_pk=... -p user__id=... -p 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 = ["meetings", "invitations &gt; update"]
var params = {
    meeting_pk: ...,
    user__id: ...,
    status: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["meetings", "invitations &gt; update"]
params = {
    "meeting_pk": ...,
    "user__id": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

invitations > partial_update

PATCH /api/v1/meetings/{meeting_pk}/invitations/{user__id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`meeting_pk` required
`user__id` required

Request Body

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

Parameter	Description
`status`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings invitations partial_update -p meeting_pk=... -p user__id=... -p 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 = ["meetings", "invitations &gt; partial_update"]
var params = {
    meeting_pk: ...,
    user__id: ...,
    status: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["meetings", "invitations &gt; partial_update"]
params = {
    "meeting_pk": ...,
    "user__id": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

invitations > delete

DELETE /api/v1/meetings/{meeting_pk}/invitations/{user__id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`meeting_pk` required
`user__id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action meetings invitations delete -p meeting_pk=... -p user__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 = ["meetings", "invitations &gt; delete"]
var params = {
    meeting_pk: ...,
    user__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("/api/")

# Interact with the API endpoint
action = ["meetings", "invitations &gt; delete"]
params = {
    "meeting_pk": ...,
    "user__id": ...,
}
result = client.action(schema, action, params=params)

membership-history

list

GET /api/v1/membership-history/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`user`
`abakus_group`
`role`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action membership-history list -p cursor=... -p user=... -p abakus_group=... -p role=...

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 = ["membership-history", "list"]
var params = {
    cursor: ...,
    user: ...,
    abakus_group: ...,
    role: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["membership-history", "list"]
params = {
    "cursor": ...,
    "user": ...,
    "abakus_group": ...,
    "role": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/membership-history/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`user`
`abakus_group`
`role`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action membership-history read -p id=... -p user=... -p abakus_group=... -p role=...

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 = ["membership-history", "read"]
var params = {
    id: ...,
    user: ...,
    abakus_group: ...,
    role: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["membership-history", "read"]
params = {
    "id": ...,
    "user": ...,
    "abakus_group": ...,
    "role": ...,
}
result = client.action(schema, action, params=params)

notification-settings

list

GET /api/v1/notification-settings/

List all existing settings.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action notification-settings 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 = ["notification-settings", "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("/api/")

# Interact with the API endpoint
action = ["notification-settings", "list"]
result = client.action(schema, action)

create

POST /api/v1/notification-settings/

Lookup or create a new settings object and save it with the provided parameters.

Request Body

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

Parameter	Description
`notification_type` required
`enabled`
`channels`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action notification-settings create -p notification_type=... -p enabled=... -p channels=...

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 = ["notification-settings", "create"]
var params = {
    notification_type: ...,
    enabled: ...,
    channels: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["notification-settings", "create"]
params = {
    "notification_type": ...,
    "enabled": ...,
    "channels": ...,
}
result = client.action(schema, action, params=params)

alternatives

GET /api/v1/notification-settings/alternatives/

Return a list of all possible notification_types and channels.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action notification-settings alternatives

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 = ["notification-settings", "alternatives"]
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("/api/")

# Interact with the API endpoint
action = ["notification-settings", "alternatives"]
result = client.action(schema, action)

oauth2-access-tokens

list

GET /api/v1/oauth2-access-tokens/

List grants or access-tokens the current user has created.

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oauth2-access-tokens list -p cursor=...

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 = ["oauth2-access-tokens", "list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["oauth2-access-tokens", "list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/oauth2-access-tokens/{id}/

Delete an access token created by the user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oauth2-access-tokens 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 = ["oauth2-access-tokens", "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("/api/")

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

oauth2-applications

list

GET /api/v1/oauth2-applications/

List all applications the current user us responsible for.

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oauth2-applications list -p cursor=...

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 = ["oauth2-applications", "list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["oauth2-applications", "list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/oauth2-applications/

Request Body

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

Parameter	Description
`name`
`description`
`redirect_uris`	Allowed URIs list, space separated

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oauth2-applications create -p name=... -p description=... -p redirect_uris=...

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 = ["oauth2-applications", "create"]
var params = {
    name: ...,
    description: ...,
    redirect_uris: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["oauth2-applications", "create"]
params = {
    "name": ...,
    "description": ...,
    "redirect_uris": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/oauth2-applications/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oauth2-applications 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 = ["oauth2-applications", "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("/api/")

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

update

PUT /api/v1/oauth2-applications/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`name`
`description`
`redirect_uris`	Allowed URIs list, space separated

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oauth2-applications update -p id=... -p name=... -p description=... -p redirect_uris=...

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 = ["oauth2-applications", "update"]
var params = {
    id: ...,
    name: ...,
    description: ...,
    redirect_uris: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["oauth2-applications", "update"]
params = {
    "id": ...,
    "name": ...,
    "description": ...,
    "redirect_uris": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/oauth2-applications/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`name`
`description`
`redirect_uris`	Allowed URIs list, space separated

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oauth2-applications partial_update -p id=... -p name=... -p description=... -p redirect_uris=...

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 = ["oauth2-applications", "partial_update"]
var params = {
    id: ...,
    name: ...,
    description: ...,
    redirect_uris: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["oauth2-applications", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "description": ...,
    "redirect_uris": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/oauth2-applications/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oauth2-applications 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 = ["oauth2-applications", "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("/api/")

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

oidc

authorize

GET /api/v1/oidc/authorize/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oidc authorize

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 = ["oidc", "authorize"]
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("/api/")

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

validate

GET /api/v1/oidc/validate/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action oidc validate

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 = ["oidc", "validate"]
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("/api/")

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

pages

list

GET /api/v1/pages/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action pages 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 = ["pages", "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("/api/")

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

create

POST /api/v1/pages/

Request Body

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

Parameter	Description
`title` required
`slug`
`content` required
`picture`
`picture_placeholder`
`category`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action pages create -p title=... -p slug=... -p content=... -p picture=... -p picture_placeholder=... -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 = ["pages", "create"]
var params = {
    title: ...,
    slug: ...,
    content: ...,
    picture: ...,
    picture_placeholder: ...,
    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("/api/")

# Interact with the API endpoint
action = ["pages", "create"]
params = {
    "title": ...,
    "slug": ...,
    "content": ...,
    "picture": ...,
    "picture_placeholder": ...,
    "category": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/pages/{slug}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action pages read -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 = ["pages", "read"]
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("/api/")

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

update

PUT /api/v1/pages/{slug}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

Request Body

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

Parameter	Description
`title` required
`slug`
`content` required
`picture`
`picture_placeholder`
`category`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action pages update -p slug=... -p title=... -p slug=... -p content=... -p picture=... -p picture_placeholder=... -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 = ["pages", "update"]
var params = {
    slug: ...,
    title: ...,
    slug: ...,
    content: ...,
    picture: ...,
    picture_placeholder: ...,
    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("/api/")

# Interact with the API endpoint
action = ["pages", "update"]
params = {
    "slug": ...,
    "title": ...,
    "slug": ...,
    "content": ...,
    "picture": ...,
    "picture_placeholder": ...,
    "category": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/pages/{slug}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

Request Body

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

Parameter	Description
`title`
`slug`
`content`
`picture`
`picture_placeholder`
`category`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action pages partial_update -p slug=... -p title=... -p slug=... -p content=... -p picture=... -p picture_placeholder=... -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 = ["pages", "partial_update"]
var params = {
    slug: ...,
    title: ...,
    slug: ...,
    content: ...,
    picture: ...,
    picture_placeholder: ...,
    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("/api/")

# Interact with the API endpoint
action = ["pages", "partial_update"]
params = {
    "slug": ...,
    "title": ...,
    "slug": ...,
    "content": ...,
    "picture": ...,
    "picture_placeholder": ...,
    "category": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/pages/{slug}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action pages delete -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 = ["pages", "delete"]
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("/api/")

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

password-change

create

POST /api/v1/password-change/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action password-change create

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 = ["password-change", "create"]
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("/api/")

# Interact with the API endpoint
action = ["password-change", "create"]
result = client.action(schema, action)

password-reset-perform

create

POST /api/v1/password-reset-perform/

Request Body

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

Parameter	Description
`token` required
`password` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action password-reset-perform create -p token=... -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 = ["password-reset-perform", "create"]
var params = {
    token: ...,
    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("/api/")

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

password-reset-request

create

POST /api/v1/password-reset-request/

Request Body

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

Parameter	Description
`email` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action password-reset-request create -p email=...

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 = ["password-reset-request", "create"]
var params = {
    email: ...,
}
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("/api/")

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

penalties

list

GET /api/v1/penalties/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`user`
`source_event`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action penalties list -p cursor=... -p user=... -p source_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 = ["penalties", "list"]
var params = {
    cursor: ...,
    user: ...,
    source_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("/api/")

# Interact with the API endpoint
action = ["penalties", "list"]
params = {
    "cursor": ...,
    "user": ...,
    "source_event": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/penalties/

Request Body

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

Parameter	Description
`user` required
`reason` required
`weight`
`source_event`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action penalties create -p user=... -p reason=... -p weight=... -p source_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 = ["penalties", "create"]
var params = {
    user: ...,
    reason: ...,
    weight: ...,
    source_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("/api/")

# Interact with the API endpoint
action = ["penalties", "create"]
params = {
    "user": ...,
    "reason": ...,
    "weight": ...,
    "source_event": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/penalties/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`user`
`source_event`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action penalties delete -p id=... -p user=... -p source_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 = ["penalties", "delete"]
var params = {
    id: ...,
    user: ...,
    source_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("/api/")

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

podcasts

list

GET /api/v1/podcasts/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action podcasts list -p cursor=...

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 = ["podcasts", "list"]
var params = {
    cursor: ...,
}
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("/api/")

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

create

POST /api/v1/podcasts/

Request Body

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

Parameter	Description
`source` required
`description` required
`authors` required
`thanks` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action podcasts create -p source=... -p description=... -p authors=... -p thanks=...

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 = ["podcasts", "create"]
var params = {
    source: ...,
    description: ...,
    authors: ...,
    thanks: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["podcasts", "create"]
params = {
    "source": ...,
    "description": ...,
    "authors": ...,
    "thanks": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/podcasts/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action podcasts 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 = ["podcasts", "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("/api/")

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

update

PUT /api/v1/podcasts/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`source` required
`description` required
`authors` required
`thanks` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action podcasts update -p id=... -p source=... -p description=... -p authors=... -p thanks=...

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 = ["podcasts", "update"]
var params = {
    id: ...,
    source: ...,
    description: ...,
    authors: ...,
    thanks: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["podcasts", "update"]
params = {
    "id": ...,
    "source": ...,
    "description": ...,
    "authors": ...,
    "thanks": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/podcasts/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`source`
`description`
`authors`
`thanks`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action podcasts partial_update -p id=... -p source=... -p description=... -p authors=... -p thanks=...

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 = ["podcasts", "partial_update"]
var params = {
    id: ...,
    source: ...,
    description: ...,
    authors: ...,
    thanks: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["podcasts", "partial_update"]
params = {
    "id": ...,
    "source": ...,
    "description": ...,
    "authors": ...,
    "thanks": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/podcasts/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action podcasts 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 = ["podcasts", "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("/api/")

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

polls

list

GET /api/v1/polls/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action polls list -p cursor=...

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 = ["polls", "list"]
var params = {
    cursor: ...,
}
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("/api/")

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

create

POST /api/v1/polls/

Request Body

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

Parameter	Description
`title` required
`description`
`options` required
`results_hidden`
`tags`
`pinned`
`valid_until`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action polls create -p title=... -p description=... -p options=... -p results_hidden=... -p tags=... -p pinned=... -p valid_until=...

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 = ["polls", "create"]
var params = {
    title: ...,
    description: ...,
    options: ...,
    results_hidden: ...,
    tags: ...,
    pinned: ...,
    valid_until: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["polls", "create"]
params = {
    "title": ...,
    "description": ...,
    "options": ...,
    "results_hidden": ...,
    "tags": ...,
    "pinned": ...,
    "valid_until": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/polls/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action polls 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 = ["polls", "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("/api/")

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

update

PUT /api/v1/polls/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title` required
`description`
`options` required
`results_hidden`
`tags`
`pinned`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action polls update -p id=... -p title=... -p description=... -p options=... -p results_hidden=... -p tags=... -p pinned=...

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 = ["polls", "update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
    options: ...,
    results_hidden: ...,
    tags: ...,
    pinned: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["polls", "update"]
params = {
    "id": ...,
    "title": ...,
    "description": ...,
    "options": ...,
    "results_hidden": ...,
    "tags": ...,
    "pinned": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/polls/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title`
`description`
`options`
`results_hidden`
`tags`
`pinned`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action polls partial_update -p id=... -p title=... -p description=... -p options=... -p results_hidden=... -p tags=... -p pinned=...

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 = ["polls", "partial_update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
    options: ...,
    results_hidden: ...,
    tags: ...,
    pinned: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["polls", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "description": ...,
    "options": ...,
    "results_hidden": ...,
    "tags": ...,
    "pinned": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/polls/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action polls 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 = ["polls", "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("/api/")

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

vote

POST /api/v1/polls/{id}/vote/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`valid_until`
`title` required
`description`
`options` required
`results_hidden`
`tags`
`pinned`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action polls vote -p id=... -p valid_until=... -p title=... -p description=... -p options=... -p results_hidden=... -p tags=... -p pinned=...

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 = ["polls", "vote"]
var params = {
    id: ...,
    valid_until: ...,
    title: ...,
    description: ...,
    options: ...,
    results_hidden: ...,
    tags: ...,
    pinned: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["polls", "vote"]
params = {
    "id": ...,
    "valid_until": ...,
    "title": ...,
    "description": ...,
    "options": ...,
    "results_hidden": ...,
    "tags": ...,
    "pinned": ...,
}
result = client.action(schema, action, params=params)

quotes

list

GET /api/v1/quotes/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`approved`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action quotes list -p cursor=... -p approved=... -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 = ["quotes", "list"]
var params = {
    cursor: ...,
    approved: ...,
    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("/api/")

# Interact with the API endpoint
action = ["quotes", "list"]
params = {
    "cursor": ...,
    "approved": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/quotes/

Request Body

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

Parameter	Description
`text` required
`source` required
`approved`
`tags`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action quotes create -p text=... -p source=... -p approved=... -p tags=...

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 = ["quotes", "create"]
var params = {
    text: ...,
    source: ...,
    approved: ...,
    tags: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["quotes", "create"]
params = {
    "text": ...,
    "source": ...,
    "approved": ...,
    "tags": ...,
}
result = client.action(schema, action, params=params)

random

GET /api/v1/quotes/random/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action quotes random

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 = ["quotes", "random"]
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("/api/")

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

read

GET /api/v1/quotes/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`approved`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action quotes read -p id=... -p approved=... -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 = ["quotes", "read"]
var params = {
    id: ...,
    approved: ...,
    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("/api/")

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

update

PUT /api/v1/quotes/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`approved`
`ordering`	Which field to use when ordering the results.

Request Body

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

Parameter	Description
`text` required
`source` required
`approved`
`tags`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action quotes update -p id=... -p text=... -p source=... -p approved=... -p tags=... -p approved=... -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 = ["quotes", "update"]
var params = {
    id: ...,
    text: ...,
    source: ...,
    approved: ...,
    tags: ...,
    approved: ...,
    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("/api/")

# Interact with the API endpoint
action = ["quotes", "update"]
params = {
    "id": ...,
    "text": ...,
    "source": ...,
    "approved": ...,
    "tags": ...,
    "approved": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/quotes/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`approved`
`ordering`	Which field to use when ordering the results.

Request Body

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

Parameter	Description
`text`
`source`
`approved`
`tags`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action quotes partial_update -p id=... -p text=... -p source=... -p approved=... -p tags=... -p approved=... -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 = ["quotes", "partial_update"]
var params = {
    id: ...,
    text: ...,
    source: ...,
    approved: ...,
    tags: ...,
    approved: ...,
    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("/api/")

# Interact with the API endpoint
action = ["quotes", "partial_update"]
params = {
    "id": ...,
    "text": ...,
    "source": ...,
    "approved": ...,
    "tags": ...,
    "approved": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/quotes/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`approved`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action quotes delete -p id=... -p approved=... -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 = ["quotes", "delete"]
var params = {
    id: ...,
    approved: ...,
    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("/api/")

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

approve

PUT /api/v1/quotes/{id}/approve/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`text` required
`source` required
`approved`
`tags`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action quotes approve -p id=... -p text=... -p source=... -p approved=... -p tags=...

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 = ["quotes", "approve"]
var params = {
    id: ...,
    text: ...,
    source: ...,
    approved: ...,
    tags: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["quotes", "approve"]
params = {
    "id": ...,
    "text": ...,
    "source": ...,
    "approved": ...,
    "tags": ...,
}
result = client.action(schema, action, params=params)

unapprove

PUT /api/v1/quotes/{id}/unapprove/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`text` required
`source` required
`approved`
`tags`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action quotes unapprove -p id=... -p text=... -p source=... -p approved=... -p tags=...

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 = ["quotes", "unapprove"]
var params = {
    id: ...,
    text: ...,
    source: ...,
    approved: ...,
    tags: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["quotes", "unapprove"]
params = {
    "id": ...,
    "text": ...,
    "source": ...,
    "approved": ...,
    "tags": ...,
}
result = client.action(schema, action, params=params)

reactions

create

POST /api/v1/reactions/

Request Body

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

Parameter	Description
`emoji` required
`content_target` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action reactions create -p emoji=... -p content_target=...

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 = ["reactions", "create"]
var params = {
    emoji: ...,
    content_target: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["reactions", "create"]
params = {
    "emoji": ...,
    "content_target": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/reactions/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action reactions 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 = ["reactions", "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("/api/")

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

restricted-mail

list

GET /api/v1/restricted-mail/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`from_address`
`hide_sender`
`token`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action restricted-mail list -p cursor=... -p from_address=... -p hide_sender=... -p token=...

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 = ["restricted-mail", "list"]
var params = {
    cursor: ...,
    from_address: ...,
    hide_sender: ...,
    token: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["restricted-mail", "list"]
params = {
    "cursor": ...,
    "from_address": ...,
    "hide_sender": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/restricted-mail/

Request Body

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

Parameter	Description
`from_address` required
`hide_sender`
`weekly`
`users`
`groups`
`events`
`meetings`
`raw_addresses`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action restricted-mail create -p from_address=... -p hide_sender=... -p weekly=... -p users=... -p groups=... -p events=... -p meetings=... -p raw_addresses=...

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 = ["restricted-mail", "create"]
var params = {
    from_address: ...,
    hide_sender: ...,
    weekly: ...,
    users: ...,
    groups: ...,
    events: ...,
    meetings: ...,
    raw_addresses: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["restricted-mail", "create"]
params = {
    "from_address": ...,
    "hide_sender": ...,
    "weekly": ...,
    "users": ...,
    "groups": ...,
    "events": ...,
    "meetings": ...,
    "raw_addresses": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/restricted-mail/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`from_address`
`hide_sender`
`token`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action restricted-mail read -p id=... -p from_address=... -p hide_sender=... -p token=...

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 = ["restricted-mail", "read"]
var params = {
    id: ...,
    from_address: ...,
    hide_sender: ...,
    token: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["restricted-mail", "read"]
params = {
    "id": ...,
    "from_address": ...,
    "hide_sender": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

token

GET /api/v1/restricted-mail/{id}/token/

Download the token belonging to a restricted mail. This token has to be attached to the restricted mail for authentication.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action restricted-mail token -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 = ["restricted-mail", "token"]
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("/api/")

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

search-autocomplete

create

POST /api/v1/search-autocomplete/

Post { 'query': query, 'types': [content_type] } to this endpoint.

types is optional.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action search-autocomplete create

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 = ["search-autocomplete", "create"]
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("/api/")

# Interact with the API endpoint
action = ["search-autocomplete", "create"]
result = client.action(schema, action)

search-search

create

POST /api/v1/search-search/

Post { 'query': query, 'types': [content_type], 'filters': { event_type: ['party', 'course']} } to this endpoint.

types and filters is optional.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action search-search create

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 = ["search-search", "create"]
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("/api/")

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

site-meta

list

GET /api/v1/site-meta/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action site-meta 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 = ["site-meta", "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("/api/")

# Interact with the API endpoint
action = ["site-meta", "list"]
result = client.action(schema, action)

survey-results

read

GET /api/v1/survey-results/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action survey-results 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 = ["survey-results", "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("/api/")

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

survey-templates

list

GET /api/v1/survey-templates/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action survey-templates list -p cursor=...

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 = ["survey-templates", "list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["survey-templates", "list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/survey-templates/{template_type}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`template_type` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action survey-templates read -p template_type=...

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 = ["survey-templates", "read"]
var params = {
    template_type: ...,
}
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("/api/")

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

surveys

list

GET /api/v1/surveys/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.
`event`
`company`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys list -p cursor=... -p event=... -p company=...

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 = ["surveys", "list"]
var params = {
    cursor: ...,
    event: ...,
    company: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "list"]
params = {
    "cursor": ...,
    "event": ...,
    "company": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/surveys/

Request Body

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

Parameter	Description
`title` required
`active_from`
`template_type`
`event` required
`questions`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys create -p title=... -p active_from=... -p template_type=... -p event=... -p questions=...

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 = ["surveys", "create"]
var params = {
    title: ...,
    active_from: ...,
    template_type: ...,
    event: ...,
    questions: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "create"]
params = {
    "title": ...,
    "active_from": ...,
    "template_type": ...,
    "event": ...,
    "questions": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/surveys/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`event`
`company`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys read -p id=... -p event=... -p company=...

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 = ["surveys", "read"]
var params = {
    id: ...,
    event: ...,
    company: ...,
}
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("/api/")

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

update

PUT /api/v1/surveys/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`event`
`company`

Request Body

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

Parameter	Description
`title` required
`active_from`
`template_type`
`event` required
`questions`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys update -p id=... -p title=... -p active_from=... -p template_type=... -p event=... -p questions=... -p event=... -p company=...

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 = ["surveys", "update"]
var params = {
    id: ...,
    title: ...,
    active_from: ...,
    template_type: ...,
    event: ...,
    questions: ...,
    event: ...,
    company: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "update"]
params = {
    "id": ...,
    "title": ...,
    "active_from": ...,
    "template_type": ...,
    "event": ...,
    "questions": ...,
    "event": ...,
    "company": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/surveys/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`event`
`company`

Request Body

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

Parameter	Description
`title`
`active_from`
`template_type`
`event`
`questions`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys partial_update -p id=... -p title=... -p active_from=... -p template_type=... -p event=... -p questions=... -p event=... -p company=...

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 = ["surveys", "partial_update"]
var params = {
    id: ...,
    title: ...,
    active_from: ...,
    template_type: ...,
    event: ...,
    questions: ...,
    event: ...,
    company: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "active_from": ...,
    "template_type": ...,
    "event": ...,
    "questions": ...,
    "event": ...,
    "company": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/surveys/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`event`
`company`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys delete -p id=... -p event=... -p company=...

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 = ["surveys", "delete"]
var params = {
    id: ...,
    event: ...,
    company: ...,
}
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("/api/")

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

csv

GET /api/v1/surveys/{id}/csv/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys csv -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 = ["surveys", "csv"]
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("/api/")

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

hide

POST /api/v1/surveys/{id}/hide/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title` required
`active_from`
`event` required
`template_type`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys hide -p id=... -p title=... -p active_from=... -p event=... -p template_type=...

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 = ["surveys", "hide"]
var params = {
    id: ...,
    title: ...,
    active_from: ...,
    event: ...,
    template_type: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "hide"]
params = {
    "id": ...,
    "title": ...,
    "active_from": ...,
    "event": ...,
    "template_type": ...,
}
result = client.action(schema, action, params=params)

pdf

GET /api/v1/surveys/{id}/pdf/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys pdf -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 = ["surveys", "pdf"]
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("/api/")

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

POST /api/v1/surveys/{id}/share/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title` required
`active_from`
`event` required
`template_type`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys share -p id=... -p title=... -p active_from=... -p event=... -p template_type=...

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 = ["surveys", "share"]
var params = {
    id: ...,
    title: ...,
    active_from: ...,
    event: ...,
    template_type: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "share"]
params = {
    "id": ...,
    "title": ...,
    "active_from": ...,
    "event": ...,
    "template_type": ...,
}
result = client.action(schema, action, params=params)

submissions > list

GET /api/v1/surveys/{survey_pk}/submissions/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`survey_pk` required

Query Parameters

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

Parameter	Description
`user`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys submissions list -p survey_pk=... -p user=...

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 = ["surveys", "submissions &gt; list"]
var params = {
    survey_pk: ...,
    user: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "submissions &gt; list"]
params = {
    "survey_pk": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

submissions > create

POST /api/v1/surveys/{survey_pk}/submissions/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`survey_pk` required

Request Body

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

Parameter	Description
`user` required
`answers` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys submissions create -p survey_pk=... -p user=... -p answers=...

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 = ["surveys", "submissions &gt; create"]
var params = {
    survey_pk: ...,
    user: ...,
    answers: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "submissions &gt; create"]
params = {
    "survey_pk": ...,
    "user": ...,
    "answers": ...,
}
result = client.action(schema, action, params=params)

submissions > read

GET /api/v1/surveys/{survey_pk}/submissions/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`user`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys submissions read -p survey_pk=... -p id=... -p user=...

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 = ["surveys", "submissions &gt; read"]
var params = {
    survey_pk: ...,
    id: ...,
    user: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "submissions &gt; read"]
params = {
    "survey_pk": ...,
    "id": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

submissions > update

PUT /api/v1/surveys/{survey_pk}/submissions/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`user`

Request Body

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

Parameter	Description
`user` required
`answers` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys submissions update -p survey_pk=... -p id=... -p user=... -p answers=... -p user=...

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 = ["surveys", "submissions &gt; update"]
var params = {
    survey_pk: ...,
    id: ...,
    user: ...,
    answers: ...,
    user: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "submissions &gt; update"]
params = {
    "survey_pk": ...,
    "id": ...,
    "user": ...,
    "answers": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

submissions > partial_update

PATCH /api/v1/surveys/{survey_pk}/submissions/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`user`

Request Body

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

Parameter	Description
`user`
`answers`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys submissions partial_update -p survey_pk=... -p id=... -p user=... -p answers=... -p user=...

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 = ["surveys", "submissions &gt; partial_update"]
var params = {
    survey_pk: ...,
    id: ...,
    user: ...,
    answers: ...,
    user: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "submissions &gt; partial_update"]
params = {
    "survey_pk": ...,
    "id": ...,
    "user": ...,
    "answers": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

submissions > delete

DELETE /api/v1/surveys/{survey_pk}/submissions/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`user`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys submissions delete -p survey_pk=... -p id=... -p user=...

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 = ["surveys", "submissions &gt; delete"]
var params = {
    survey_pk: ...,
    id: ...,
    user: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "submissions &gt; delete"]
params = {
    "survey_pk": ...,
    "id": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

submissions > hide

POST /api/v1/surveys/{survey_pk}/submissions/{id}/hide/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`survey` required
`answers` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys submissions hide -p survey_pk=... -p id=... -p survey=... -p answers=...

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 = ["surveys", "submissions &gt; hide"]
var params = {
    survey_pk: ...,
    id: ...,
    survey: ...,
    answers: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "submissions &gt; hide"]
params = {
    "survey_pk": ...,
    "id": ...,
    "survey": ...,
    "answers": ...,
}
result = client.action(schema, action, params=params)

submissions > show

POST /api/v1/surveys/{survey_pk}/submissions/{id}/show/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`survey` required
`answers` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action surveys submissions show -p survey_pk=... -p id=... -p survey=... -p answers=...

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 = ["surveys", "submissions &gt; show"]
var params = {
    survey_pk: ...,
    id: ...,
    survey: ...,
    answers: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["surveys", "submissions &gt; show"]
params = {
    "survey_pk": ...,
    "id": ...,
    "survey": ...,
    "answers": ...,
}
result = client.action(schema, action, params=params)

threads

list

GET /api/v1/threads/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action threads list -p cursor=...

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 = ["threads", "list"]
var params = {
    cursor: ...,
}
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("/api/")

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

create

POST /api/v1/threads/

Request Body

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

Parameter	Description
`title` required
`content` required
`forum` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action threads create -p title=... -p content=... -p forum=...

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 = ["threads", "create"]
var params = {
    title: ...,
    content: ...,
    forum: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["threads", "create"]
params = {
    "title": ...,
    "content": ...,
    "forum": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/threads/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action threads 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 = ["threads", "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("/api/")

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

update

PUT /api/v1/threads/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title` required
`content` required
`forum` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action threads update -p id=... -p title=... -p content=... -p forum=...

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 = ["threads", "update"]
var params = {
    id: ...,
    title: ...,
    content: ...,
    forum: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["threads", "update"]
params = {
    "id": ...,
    "title": ...,
    "content": ...,
    "forum": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/threads/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`title`
`content`
`forum`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action threads partial_update -p id=... -p title=... -p content=... -p forum=...

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 = ["threads", "partial_update"]
var params = {
    id: ...,
    title: ...,
    content: ...,
    forum: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["threads", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "content": ...,
    "forum": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/threads/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action threads 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 = ["threads", "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("/api/")

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

user-delete

create

POST /api/v1/user-delete/

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action user-delete create

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 = ["user-delete", "create"]
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("/api/")

# Interact with the API endpoint
action = ["user-delete", "create"]
result = client.action(schema, action)

users

list

GET /api/v1/users/

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users list -p cursor=...

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 = ["users", "list"]
var params = {
    cursor: ...,
}
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("/api/")

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

create

POST /api/v1/users/

Attempts to register a new user based on the registration token.

Request Body

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

Parameter	Description
`username` required	Required. 50 characters or fewer. Letters, digits and _ only.
`first_name` required
`last_name` required
`gender` required
`password` required
`allergies`
`phone_number`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users create -p username=... -p first_name=... -p last_name=... -p gender=... -p password=... -p allergies=... -p phone_number=...

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 = ["users", "create"]
var params = {
    username: ...,
    first_name: ...,
    last_name: ...,
    gender: ...,
    password: ...,
    allergies: ...,
    phone_number: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["users", "create"]
params = {
    "username": ...,
    "first_name": ...,
    "last_name": ...,
    "gender": ...,
    "password": ...,
    "allergies": ...,
    "phone_number": ...,
}
result = client.action(schema, action, params=params)

me

GET /api/v1/users/me/

Read-only endpoint used to retrieve information about the authenticated user.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users me

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 = ["users", "me"]
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("/api/")

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

oauth2_userdata

GET /api/v1/users/oauth2_userdata/

Read-only endpoint used to retrieve information about the authenticated user.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users oauth2_userdata

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 = ["users", "oauth2_userdata"]
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("/api/")

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

read

GET /api/v1/users/{username}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 50 characters or fewer. Letters, digits and _ only.

# Load the schema document
$ coreapi get /api/

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

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 = ["users", "read"]
var params = {
    username: ...,
}
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("/api/")

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

update

PUT /api/v1/users/{username}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 50 characters or fewer. Letters, digits and _ only.

Request Body

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

Parameter	Description
`first_name` required
`last_name` required
`gender` required
`profile_picture`
`profile_picture_placeholder`
`github_username`	Enter a valid username.
`linkedin_id`	Enter a valid LinkedIn ID.
`abakus_groups` required
`past_memberships` required
`memberships` required
`achievements` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users update -p username=... -p first_name=... -p last_name=... -p gender=... -p profile_picture=... -p profile_picture_placeholder=... -p github_username=... -p linkedin_id=... -p abakus_groups=... -p past_memberships=... -p memberships=... -p achievements=...

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 = ["users", "update"]
var params = {
    username: ...,
    first_name: ...,
    last_name: ...,
    gender: ...,
    profile_picture: ...,
    profile_picture_placeholder: ...,
    github_username: ...,
    linkedin_id: ...,
    abakus_groups: ...,
    past_memberships: ...,
    memberships: ...,
    achievements: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["users", "update"]
params = {
    "username": ...,
    "first_name": ...,
    "last_name": ...,
    "gender": ...,
    "profile_picture": ...,
    "profile_picture_placeholder": ...,
    "github_username": ...,
    "linkedin_id": ...,
    "abakus_groups": ...,
    "past_memberships": ...,
    "memberships": ...,
    "achievements": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v1/users/{username}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 50 characters or fewer. Letters, digits and _ only.

Request Body

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

Parameter	Description
`first_name`
`last_name`
`gender`
`profile_picture`
`profile_picture_placeholder`
`github_username`	Enter a valid username.
`linkedin_id`	Enter a valid LinkedIn ID.
`abakus_groups`
`past_memberships`
`memberships`
`achievements`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users partial_update -p username=... -p first_name=... -p last_name=... -p gender=... -p profile_picture=... -p profile_picture_placeholder=... -p github_username=... -p linkedin_id=... -p abakus_groups=... -p past_memberships=... -p memberships=... -p achievements=...

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 = ["users", "partial_update"]
var params = {
    username: ...,
    first_name: ...,
    last_name: ...,
    gender: ...,
    profile_picture: ...,
    profile_picture_placeholder: ...,
    github_username: ...,
    linkedin_id: ...,
    abakus_groups: ...,
    past_memberships: ...,
    memberships: ...,
    achievements: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["users", "partial_update"]
params = {
    "username": ...,
    "first_name": ...,
    "last_name": ...,
    "gender": ...,
    "profile_picture": ...,
    "profile_picture_placeholder": ...,
    "github_username": ...,
    "linkedin_id": ...,
    "abakus_groups": ...,
    "past_memberships": ...,
    "memberships": ...,
    "achievements": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v1/users/{username}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 50 characters or fewer. Letters, digits and _ only.

# Load the schema document
$ coreapi get /api/

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

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 = ["users", "delete"]
var params = {
    username: ...,
}
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("/api/")

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

change_grade

POST /api/v1/users/{username}/change_grade/

Attempts to change the grade of the user based selected input

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 50 characters or fewer. Letters, digits and _ only.

Request Body

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

Parameter	Description
`group` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users change_grade -p username=... -p 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 = ["users", "change_grade"]
var params = {
    username: ...,
    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("/api/")

# Interact with the API endpoint
action = ["users", "change_grade"]
params = {
    "username": ...,
    "group": ...,
}
result = client.action(schema, action, params=params)

update_photo_consent

POST /api/v1/users/{username}/update_photo_consent/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 50 characters or fewer. Letters, digits and _ only.

Request Body

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

Parameter	Description
`user` required
`year` required
`semester` required
`domain` required
`is_consenting`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users update_photo_consent -p username=... -p user=... -p year=... -p semester=... -p domain=... -p is_consenting=...

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 = ["users", "update_photo_consent"]
var params = {
    username: ...,
    user: ...,
    year: ...,
    semester: ...,
    domain: ...,
    is_consenting: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["users", "update_photo_consent"]
params = {
    "username": ...,
    "user": ...,
    "year": ...,
    "semester": ...,
    "domain": ...,
    "is_consenting": ...,
}
result = client.action(schema, action, params=params)

users-registration-request

list

GET /api/v1/users-registration-request/

Validates a registration token.

The request errors out if the token has expired or is invalid. Request URL: GET /api/v1/users/registration/?token=

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users-registration-request list -p cursor=...

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 = ["users-registration-request", "list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["users-registration-request", "list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v1/users-registration-request/

Attempts to create a registration token and email it to the user.

Request Body

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

Parameter	Description
`email` required
`captcha_response` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action users-registration-request create -p email=... -p captcha_response=...

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 = ["users-registration-request", "create"]
var params = {
    email: ...,
    captcha_response: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["users-registration-request", "create"]
params = {
    "email": ...,
    "captcha_response": ...,
}
result = client.action(schema, action, params=params)

webhooks-stripe

create

POST /api/v1/webhooks-stripe/

Request Body

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

Parameter	Description
`id` required
`type` required

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action webhooks-stripe create -p id=... -p type=...

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 = ["webhooks-stripe", "create"]
var params = {
    id: ...,
    type: ...,
}
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("/api/")

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