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`
`meetings`

# 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 meetings=...

var coreapi = window.coreapi  // Loaded by `coreapi.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: ...,
    meetings: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is 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": ...,
    "meetings": ...,
}
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`
`meetings`

# 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 meetings=...

var coreapi = window.coreapi  // Loaded by `coreapi.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: ...,
    meetings: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is 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": ...,
    "meetings": ...,
}
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`
`meetings`

# 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 meetings=...

var coreapi = window.coreapi  // Loaded by `coreapi.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: ...,
    meetings: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is 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": ...,
    "meetings": ...,
}
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`
`meetings`

# 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 meetings=...

var coreapi = window.coreapi  // Loaded by `coreapi.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: ...,
    meetings: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is 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": ...,
    "meetings": ...,
}
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
`student_contact`
`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 student_contact=... -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: ...,
    student_contact: ...,
    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": ...,
    "student_contact": ...,
    "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
`student_contact`
`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 student_contact=... -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: ...,
    student_contact: ...,
    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": ...,
    "student_contact": ...,
    "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`
`student_contact`
`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 student_contact=... -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: ...,
    student_contact: ...,
    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": ...,
    "student_contact": ...,
    "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.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies 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 = ["companies", "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 = ["companies", "list"]
params = {
    "cursor": ...,
}
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.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action companies 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 = ["companies", "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 = ["companies", "read"]
params = {
    "id": ...,
}
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`
`userCommittee`

# 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 userCommittee=...

var coreapi = window.coreapi  // Loaded by `coreapi.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: ...,
    userCommittee: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is 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": ...,
    "userCommittee": ...,
}
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`
`userCommittee`

# 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 userCommittee=...

var coreapi = window.coreapi  // Loaded by `coreapi.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: ...,
    userCommittee: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is 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": ...,
    "userCommittee": ...,
}
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`
`userCommittee`

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 userCommittee=...

var coreapi = window.coreapi  // Loaded by `coreapi.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: ...,
    userCommittee: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is 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": ...,
    "userCommittee": ...,
}
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`
`userCommittee`

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 userCommittee=...

var coreapi = window.coreapi  // Loaded by `coreapi.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: ...,
    userCommittee: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is 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": ...,
    "userCommittee": ...,
}
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`
`use_contact_tracing`
`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=...