API BSG

# 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="/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

api

action-type > list

GET /api/action-type/

Description:

List of available action types.

NOTE:
- Available only for logged users.
Return:

List of action types (id, name, description).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api action-type &gt; 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 = ["api", "action-type &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "action-type &gt; list"]
result = client.action(schema, action)

action-type > read

GET /api/action-type/{id}/

Description:

Retrieve specific action type.

NOTE:
- Available only for logged users.
Return:

Action type (id, name, description) or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

app_menu > list

GET /api/app_menu/

Description:

Tree of active app menus.
Return:

Tree of app menus (title, item[id], url, title_translation[list of name translation {language, text}], child_menus_data[app menu]).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api app_menu &gt; 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 = ["api", "app_menu &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "app_menu &gt; list"]
result = client.action(schema, action)

area > list

GET /api/area/

Description:

List of active areas.

NOTE:
- Available only for logged users.
Return:

List of areas (id, name, name_full, description, type_data{id,name,description}, country, adress, logo[url to image], name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}]).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api area &gt; 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 = ["api", "area &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "area &gt; list"]
result = client.action(schema, action)

area > read

GET /api/area/{id}/

Description:

Retrieve the specific active area.

NOTE:
- Available only for logged users.
Return:

Area (id, name, name_full, description, type_data{id,name,description}, country, adress, logo_url[url], name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}]) or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

area-type > list

GET /api/area-type/

Description:

List of available area types.

NOTE:
- Available only for logged users.
Return:

List of area types (id, name, description).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api area-type &gt; 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 = ["api", "area-type &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "area-type &gt; list"]
result = client.action(schema, action)

area-type > read

GET /api/area-type/{id}/

Description:

Retrieve specific area type.

NOTE:
- Available only for logged users.
Return:

Area type (id, name, description) or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

badge > list

GET /api/badge/

Description:

List of active badges.

NOTE:
- Available only for logged users.
Return:

List of areas (id, name, name_full, description, resources_data [resource{id, name, type, type_name, file_url, translation_data{language, file_url}}], description_translation[list of name translation {language, text}]).

Query Parameters

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

Parameter	Description
`id`	Id of badge
`name`	Name of badge

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api badge &gt; list -p id=... -p name=...

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

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

// Interact with the API endpoint
var action = ["api", "badge &gt; list"]
var params = {
    id: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "badge &gt; list"]
params = {
    "id": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

country > list

GET /api/country/

Description:

List of countries.

NOTE:
- Available only for logged users.
Return:

List of countries (id, key, value).

EXAMPLE: (1, "PL", "Polska")

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api country &gt; 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 = ["api", "country &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "country &gt; list"]
result = client.action(schema, action)

country > read

GET /api/country/{id}/

Description:

Retrieve specific country.

NOTE:
- Available only for logged users.
Return:

Country (id, key, value) or if not found: "detail": "Not found.".

EXAMPLE: (1, "PL", "Polska")

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

events > list

GET /api/events/

Description:

List of current authenticated user events.

NOTE:
- Available only for logged users.
Return:

List of events (id, action_type, user[id], date, description, achievements_data, item, route, item_resource, language). If event fullfiled some active rules then 'achievements_data' dict is fulfilled {items_data:[], avatar_data, badges_data:[], points, texts_data:[], congratulation_items_data: []}

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api events &gt; 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 = ["api", "events &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "events &gt; list"]
result = client.action(schema, action)

events > create

POST /api/events/

Description:

Register an event of action in the area location or musemum, for the current authenticated user.

NOTE:
- Available only for logged users.
- In description field you may send variables with value in format [variable=value] example: [game_result=300] *
Return:

Event (id, action_type, user[id], date, description, achievements_data, item, route, item_resource, language). If event fullfiled some active rules then 'achievements_data' dict is fulfilled {items_data:[], avatar_data, badges_data:[], points, texts_data:[], congratulation_items_data: []}

Request Body

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

Parameter	Description
`action_type` required	An unique string value identifying action type.
`description`	Info about an event
`item`	A unique integer value identifying item.
`route`	A unique integer value identifying route.
`item_resource`	A unique integer value identifying item resource.
`language`	A unique integer value identifying language.

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api events &gt; create -p action_type=... -p description=... -p item=... -p route=... -p item_resource=... -p language=...

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

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

// Interact with the API endpoint
var action = ["api", "events &gt; create"]
var params = {
    action_type: ...,
    description: ...,
    item: ...,
    route: ...,
    item_resource: ...,
    language: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "events &gt; create"]
params = {
    "action_type": ...,
    "description": ...,
    "item": ...,
    "route": ...,
    "item_resource": ...,
    "language": ...,
}
result = client.action(schema, action, params=params)

events > read

GET /api/events/{id}/

Description:

Retrieve specific event for the current authenticated user.

NOTE:
- Available only for logged users.
Return:

Event (id, action_type, user[id], date, description, achievements_data, item, route, item_resource, language) or if not found: "detail": "Not found.". If event fullfiled some active rules then 'achievements_data' dict is fulfilled {items_data:[], avatar_data, badges_data:[], points, texts_data:[], congratulation_items_data: []}

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

item > list

GET /api/item/

Description:

List of available active items.

NOTE:
- Available only for logged users.
- Available only active.
Return:

List of items (id, name, name_full, description, type id, type_data{id,name,description}, kind, kind_data{id,name,description}, locations id [], resources_data [resource{id, name, type, type_name, file_url, translation_data{language, file_url}}], next_item(item id), child_items_data [items], quiz[id], survey[id], qr_code [data], latitude [24,16], longitude [24,16], name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}], x(integer), y(integer), fullscreen(boolean), zoomout(boolean)).

Query Parameters

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

Parameter	Description
`id`	Id of item
`name`	Name of item
`type__id`	Id of type
`type__name`	Name of type
`kind__id`	Id of kind
`kind__name`	Name of kind
`item_locations__location__id`	Id of item location
`item_locations__location__name`	Name of item location
`item_tags__tag__name`	Name of item tag
`parent_item__item__id`	Id of parent item
`type__id`	Id of type
`type__name`	Name of type
`item_routes__route__id`	Id of route
`item_routes__route__name`	Name of route
`item_locations__default`	Id of item location

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api item &gt; list -p id=... -p name=... -p type__id=... -p type__name=... -p kind__id=... -p kind__name=... -p item_locations__location__id=... -p item_locations__location__name=... -p item_tags__tag__name=... -p parent_item__item__id=... -p type__id=... -p type__name=... -p item_routes__route__id=... -p item_routes__route__name=... -p item_locations__default=...

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

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

// Interact with the API endpoint
var action = ["api", "item &gt; list"]
var params = {
    id: ...,
    name: ...,
    type__id: ...,
    type__name: ...,
    kind__id: ...,
    kind__name: ...,
    item_locations__location__id: ...,
    item_locations__location__name: ...,
    item_tags__tag__name: ...,
    parent_item__item__id: ...,
    type__id: ...,
    type__name: ...,
    item_routes__route__id: ...,
    item_routes__route__name: ...,
    item_locations__default: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "item &gt; list"]
params = {
    "id": ...,
    "name": ...,
    "type__id": ...,
    "type__name": ...,
    "kind__id": ...,
    "kind__name": ...,
    "item_locations__location__id": ...,
    "item_locations__location__name": ...,
    "item_tags__tag__name": ...,
    "parent_item__item__id": ...,
    "type__id": ...,
    "type__name": ...,
    "item_routes__route__id": ...,
    "item_routes__route__name": ...,
    "item_locations__default": ...,
}
result = client.action(schema, action, params=params)

item-kind > list

GET /api/item-kind/

Description:

List of available item kinds.

NOTE:
- Available only for logged users.
Return:

List of item kinds (id, name, description).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api item-kind &gt; 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 = ["api", "item-kind &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "item-kind &gt; list"]
result = client.action(schema, action)

item-kind > read

GET /api/item-kind/{id}/

Description:

Retrieve specific item kind.

NOTE:
- Available only for logged users.
Return:

Item kind (id, name, description) or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

item-type > list

GET /api/item-type/

Description:

List of available item types.

NOTE:
- Available only for logged users.
Return:

List of item types (id, name, description).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api item-type &gt; 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 = ["api", "item-type &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "item-type &gt; list"]
result = client.action(schema, action)

item-type > read

GET /api/item-type/{id}/

Description:

Retrieve specific item type.

NOTE:
- Available only for logged users.
Return:

Item type (id, name, description) or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

GET /api/language/

Description:

List of languages.
Return:

List of languages (id, key, value).

EXAMPLE: (1, "PL", "polski")

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api language &gt; 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 = ["api", "language &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "language &gt; list"]
result = client.action(schema, action)

language > read

GET /api/language/{id}/

Description:

Retrieve specific language.
Return:

Language (id, key, value) or if not found: "detail": "Not found.".

EXAMPLE: (1, "PL", "polski")

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

locations > list

GET /api/locations/

Description:

List of available locations.

NOTE:
- Available only for logged users.
- Available only active.
Return:

List of locations (id, name, name_full, description, type_data{id,name,description}, areas[area], routes[route], resources_data [resource{id, name, type, type_name, file_url, translation_data{language, file_url}}], quiz[id], survey[id], qr_code [data], latitude [24,16], longitude [24,16], name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}], x(integer), y(integer), default_screen (item_id), screens(itme id of type screen)).

Query Parameters

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

Parameter	Description
`id`	Id of location
`name`	Name of location
`location_routes__route__id`	Id of location route
`location_routes__route__name`	Name of location route

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api locations &gt; list -p id=... -p name=... -p location_routes__route__id=... -p location_routes__route__name=...

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

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

// Interact with the API endpoint
var action = ["api", "locations &gt; list"]
var params = {
    id: ...,
    name: ...,
    location_routes__route__id: ...,
    location_routes__route__name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "locations &gt; list"]
params = {
    "id": ...,
    "name": ...,
    "location_routes__route__id": ...,
    "location_routes__route__name": ...,
}
result = client.action(schema, action, params=params)

locations-type > list

GET /api/locations-type/

Description:

List of available location types.

NOTE:
- Available only for logged users.
Return:

List of location types (id, name, description).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api locations-type &gt; 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 = ["api", "locations-type &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "locations-type &gt; list"]
result = client.action(schema, action)

locations-type > read

GET /api/locations-type/{id}/

Description:

Retrieve specific location type.

NOTE:
- Available only for logged users.
Return:

Location type (id, name, description) or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

quiz > list

GET /api/quiz/

Description:

List of available Quizzes.

NOTE:
- Only that quizzes are available, that are related to the connnected to the application (sending request).
- Field 'name_translation' is a collection.
- Field 'name_full_translation' is a collection.
- Field 'description_translation' is a collection.
- Available only for logged users.
- Available only active.
- Available with area application for token application.
Return:

List of quizzes (id, name, name_full, description, location, item, language[], name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}]).

Query Parameters

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

Parameter	Description
`location__id`	Id of location
`item__id`	Id of item

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "quiz &gt; list"]
params = {
    "location__id": ...,
    "item__id": ...,
}
result = client.action(schema, action, params=params)

quiz > read

GET /api/quiz/{id}/

Description:

Retrieve specific quiz.

NOTE:
- Only that quizzes are available, that are related to the connnected to the application (sending request).
- Field 'name_translation' is a collection.
- Field 'name_full_translation' is a collection.
- Field 'description_translation' is a collection.
- Field 'questions_data' is a collection.
- Field 'options_data' is a collection.
- Field 'file_url' url to BLOB.
- Available only for logged users.
- Available only active.
- Available with area application for token application.
Return:

Quiz (id, name, name_full, description, location, item, language[], name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}], questions_data [{id, no, type, description, file_url, description_translation [list of description translation {language, text}], options_data [{id, no, description, file_url, description_translation [[list of description translation {language, text}]]]}]}). or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`location__id`	Id of location
`item__id`	Id of item

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "quiz &gt; read"]
params = {
    "id": ...,
    "location__id": ...,
    "item__id": ...,
}
result = client.action(schema, action, params=params)

quiz-answer > create

POST /api/quiz-answer/

Description:

Save, check answer and return answer data.

NOTE:
- Field 'options_selected_data' is a collection of selected options.
- Field 'question_data' represents the complete set of data about the question.
- Field 'file_url' url to BLOB.
- Available only for logged users.
- Available only active.
- Available with location/item for area token application.
Return:

Answer {id, fulfillment id, question id, value, correct, options_selected_data [{id,no,description,file_url, description_translation}], question_data {id,no,type,description,value_type,file_url, options_data[{id,no,description,file_url,correct}], correct_value}, event}

Request Body

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

Parameter	Description
`fulfillment` required
`question` required
`value`
`options_data`
`event`

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api quiz-answer &gt; create -p fulfillment=... -p question=... -p value=... -p options_data=... -p event=...

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

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

// Interact with the API endpoint
var action = ["api", "quiz-answer &gt; create"]
var params = {
    fulfillment: ...,
    question: ...,
    value: ...,
    options_data: ...,
    event: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "quiz-answer &gt; create"]
params = {
    "fulfillment": ...,
    "question": ...,
    "value": ...,
    "options_data": ...,
    "event": ...,
}
result = client.action(schema, action, params=params)

quiz-fulfillment > list

GET /api/quiz-fulfillment/

Description:

List of user quiz fulfillemts.

NOTE:
- Only that fulfillments are available, that are related to logged user.
- Available only for logged users.
- Available only fulfillments for active quzi.
Return:

List of fulfillments (id, quiz(id), user(id), date_add, all_answers_sent(bool), answers_data[answer]).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api quiz-fulfillment &gt; 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 = ["api", "quiz-fulfillment &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "quiz-fulfillment &gt; list"]
result = client.action(schema, action)

quiz-fulfillment > create

POST /api/quiz-fulfillment/

Description:

Save and return fulfillment data.

NOTE:
Only that fulfillments are available, that are related to logged user.
Available only for logged users.
Available only fulfillments for active quzi.
Return:

Fulfillment (id, quiz(id), user(id), date_add, all_answers_sent(bool), answers_data[answer]).

Request Body

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

Parameter	Description
`quiz` required

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api quiz-fulfillment &gt; create -p quiz=...

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

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

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "quiz-fulfillment &gt; create"]
params = {
    "quiz": ...,
}
result = client.action(schema, action, params=params)

quiz-fulfillment > read

GET /api/quiz-fulfillment/{id}/

Description:

Retrieve specific quiz fulfillemt.

NOTE:
Only that fulfillments are available, that are related to logged user.
Available only for logged users.
Available only fulfillments for active quzi.
Return:

Fulfillment (id, quiz(id), user(id), date_add, all_answers_sent(bool), answers_data[answer]) or "detail": "Not found." not available.

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

route > list

GET /api/route/

Description:

List of available areas routes.

NOTE:
- Available only for logged users.
- Available only active.
Available with no area or area application for token application.
Return:

List of routes (id, name, name_full, description, type, type_data{id,name,description}, areas[ids], areas_data[area], locations_data[location], items_data[item], route_start[M - map item / F - first item], map_item[item id], first_item[item id], name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}], languages[list pf languages]).

Query Parameters

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

Parameter	Description
`id`	Id of item
`name`	Name of item
`type__id`	Id of type
`type__name`	Name of type
`languages__id`	Id of language
`languages__key`	Key of language
`route_items__item__id`	Id of item
`route_items__item__name`	Name of item

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api route &gt; list -p id=... -p name=... -p type__id=... -p type__name=... -p languages__id=... -p languages__key=... -p route_items__item__id=... -p route_items__item__name=...

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

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

// Interact with the API endpoint
var action = ["api", "route &gt; list"]
var params = {
    id: ...,
    name: ...,
    type__id: ...,
    type__name: ...,
    languages__id: ...,
    languages__key: ...,
    route_items__item__id: ...,
    route_items__item__name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "route &gt; list"]
params = {
    "id": ...,
    "name": ...,
    "type__id": ...,
    "type__name": ...,
    "languages__id": ...,
    "languages__key": ...,
    "route_items__item__id": ...,
    "route_items__item__name": ...,
}
result = client.action(schema, action, params=params)

route > read

GET /api/route/{id}/

Description:

Retrieve specific area route.

NOTE:
- Only that routes are available, that are related to the areas connected to the application (sending request).
- Field 'Areas ids' is a collection.
- Field 'locations ids' is a collection.
- Available only for logged users.
- Available only active.
- Available with no area or area application for token application.
Return:

Route (id, name, name_full, description, type, type_data{id,name,description}, logo_url[url], areas[ids], areas_data[area], locations_data[location], items_data[item], route_start[M - map item / F - first item], map_item[item id], first_item[item id], name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}], languages[list pf languages]). or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`id`	Id of item
`name`	Name of item
`type__id`	Id of type
`type__name`	Name of type
`languages__id`	Id of language
`languages__key`	Key of language
`route_items__item__id`	Id of item
`route_items__item__name`	Name of item

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api route &gt; read -p id=... -p id=... -p name=... -p type__id=... -p type__name=... -p languages__id=... -p languages__key=... -p route_items__item__id=... -p route_items__item__name=...

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

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

// Interact with the API endpoint
var action = ["api", "route &gt; read"]
var params = {
    id: ...,
    id: ...,
    name: ...,
    type__id: ...,
    type__name: ...,
    languages__id: ...,
    languages__key: ...,
    route_items__item__id: ...,
    route_items__item__name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "route &gt; read"]
params = {
    "id": ...,
    "id": ...,
    "name": ...,
    "type__id": ...,
    "type__name": ...,
    "languages__id": ...,
    "languages__key": ...,
    "route_items__item__id": ...,
    "route_items__item__name": ...,
}
result = client.action(schema, action, params=params)

route-type > list

GET /api/route-type/

Description:

List of available route types.

NOTE:
- Available only for logged users.
Return:

List of route types (id, name, description).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api route-type &gt; 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 = ["api", "route-type &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "route-type &gt; list"]
result = client.action(schema, action)

route-type > read

GET /api/route-type/{id}/

Description:

Retrieve specific route type.

NOTE:
- Available only for logged users.
Return:

Route type (id, name, description, description_translation[list of name translation {language, text}]) or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

site > list

GET /api/site/

Description:

List of active sites.
Return:

List of sites (id, name, title, description, about, terms_url[url to terms page], logo[url to image], image[url to image], header[url], title_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}], about_translation[list of name translation {language, text}]).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api site &gt; 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 = ["api", "site &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "site &gt; list"]
result = client.action(schema, action)

survey > list

GET /api/survey/

Description:

List of available Surveys.

NOTE:
- Only that surveys are available, that are related to the connnected to the application (sending request).
- Field 'name_translation' is a collection.
- Field 'name_full_translation' is a collection.
- Field 'description_translation' is a collection.
- Available only for logged users.
- Available only active.
- Available with area application for token application.
Return:

List of surveys (id, name, name_full, description, location, item, language[], name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}]).

Query Parameters

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

Parameter	Description
`location__id`	Id of location
`item__id`	Id of item

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "survey &gt; list"]
params = {
    "location__id": ...,
    "item__id": ...,
}
result = client.action(schema, action, params=params)

survey > read

GET /api/survey/{id}/

Description:

Retrieve specific survey.

NOTE:
- Only that surveys are available, that are related to the connnected to the application (sending request).
- Field 'name_translation' is a collection.
- Field 'name_full_translation' is a collection.
- Field 'description_translation' is a collection.
- Field 'questions_data' is a collection.
- Field 'options_data' is a collection.
- Field 'file_url' url to BLOB.
- Available only for logged users.
- Available only active.
- Available with area application for token application.
Return:

Survey (id, name, name_full, description, language[], location, item, name_full_translation[list of name translation {language, text}], description_translation[list of name translation {language, text}], questions_data [{id, no, type, description, file_url, description_translation [list of description translation {language, text}], options_data [{id, no, description, file_url, description_translation [[list of description translation {language, text}]]]}]}). or if not found: "detail": "Not found.".

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`location__id`	Id of location
`item__id`	Id of item

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "survey &gt; read"]
params = {
    "id": ...,
    "location__id": ...,
    "item__id": ...,
}
result = client.action(schema, action, params=params)

survey-answer > create

POST /api/survey-answer/

Description:

Save, check answer and return answer data.

NOTE:
- Field 'options_selected_data' is a collection of selected options.
- Field 'question_data' represents the complete set of data about the question.
- Field 'file_url' url to BLOB.
- Available only for logged users.
- Available only active.
- Available with location/item for area token application.
Return:

Answer {id, fulfillment id, question id, value, options_selected_data [{id,no,description,file_url, description_translation}], event}

Request Body

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

Parameter	Description
`fulfillment` required
`question` required
`value`
`options_data`
`event`

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api survey-answer &gt; create -p fulfillment=... -p question=... -p value=... -p options_data=... -p event=...

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

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

// Interact with the API endpoint
var action = ["api", "survey-answer &gt; create"]
var params = {
    fulfillment: ...,
    question: ...,
    value: ...,
    options_data: ...,
    event: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "survey-answer &gt; create"]
params = {
    "fulfillment": ...,
    "question": ...,
    "value": ...,
    "options_data": ...,
    "event": ...,
}
result = client.action(schema, action, params=params)

survey-fulfillment > create

POST /api/survey-fulfillment/

Request Body

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

Parameter	Description
`survey` required

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api survey-fulfillment &gt; create -p survey=...

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

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

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "survey-fulfillment &gt; create"]
params = {
    "survey": ...,
}
result = client.action(schema, action, params=params)

team > list

GET /api/team/

List of groups in which user is member.

**NOTE:**

* Available only for logged users.

Return:

List of teams (id, name, users [users], avatar, access_code).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "team &gt; list"]
result = client.action(schema, action)

team > read

GET /api/team/{id}/

NOTE:

* Available only for logged users and user must be a member of group.

Return:

Team (id, name, users [users], avatar, access_code).

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

team-create > create

POST /api/team-create/

Description:

Create new group.

NOTE:
- Status 201 - Created
- Status 464 - Member of other team
- Field 'name' is a name of new group.
- Field 'avatar' is an image which will be avatar of group.
Return:

Team (id, name, users [users], avatar, access_code).

Request Body

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

Parameter	Description
`name` required
`avatar`

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api team-create &gt; create -p name=... -p avatar=...

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

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

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "team-create &gt; create"]
params = {
    "name": ...,
    "avatar": ...,
}
result = client.action(schema, action, params=params)

team-edit > read

GET /api/team-edit/{id}/

Return:

Team (id, name, users [users], avatar, access_code).

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

team-edit > update

PUT /api/team-edit/{id}/

Description:

Update team informations.

NOTE:
- Available only for logged users.
Return:

Team (id, name, users [users], avatar, access_code).

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`name` required
`avatar`

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api team-edit &gt; update -p id=... -p name=... -p avatar=...

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

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

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "team-edit &gt; update"]
params = {
    "id": ...,
    "name": ...,
    "avatar": ...,
}
result = client.action(schema, action, params=params)

team-edit > partial_update

PATCH /api/team-edit/{id}/

Description:

Partial update team informations.

NOTE:
- Available only for logged users.
Return:

Team (id, name, users [users], avatar, access_code).

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`name`
`avatar`

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api team-edit &gt; partial_update -p id=... -p name=... -p avatar=...

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

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

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "team-edit &gt; partial_update"]
params = {
    "id": ...,
    "name": ...,
    "avatar": ...,
}
result = client.action(schema, action, params=params)

team-edit > delete

DELETE /api/team-edit/{id}/

Description:

Delete team.

NOTE:
- Available only for logged users.
Return:

None

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

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

team-membership > create

POST /api/team-membership/

Description:

Create new membership

NOTE:
- Status 200 - Group joined
- Status 404 - Not Found
- Status 461 - Invalid credentials
- Status 462 - Already a member
- Status 464 - Member of other team
- Field 'avatar' is an image which will be avatar of group.

Request Body

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

Parameter	Description
`name` required
`access_code`

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "team-membership &gt; create"]
params = {
    "name": ...,
    "access_code": ...,
}
result = client.action(schema, action, params=params)

team-membership > delete

DELETE /api/team-membership/{name}/

Description:

Delete membership

NOTE:
- Status 200 - Group leaved
- Status 404 - Not Found
- Status 463 - Not a member

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api team-membership &gt; delete -p name=...

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

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

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "team-membership &gt; delete"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

ui_translation > list

GET /api/ui_translation/

Description:

List of ui translations.
Return:

List of ui translations (id, text, text_translation[list of text translation {language, text}]).

Query Parameters

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

Parameter	Description
`id`	Id of translation
`text`	Text to translation

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api ui_translation &gt; list -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 = ["api", "ui_translation &gt; list"]
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("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "ui_translation &gt; list"]
params = {
    "id": ...,
    "text": ...,
}
result = client.action(schema, action, params=params)

user_profile > list

GET /api/user_profile/

Description:

Current authenticated user profile.

NOTE:
- Available only for logged users.
Return:

List of users profiles (id, username, first_name, last_name, status, language, country, user, guest, points, level_up_points, level_current_points, for_delete, owned_items_data[items], avatar(item), badges_data[badges]).

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api user_profile &gt; 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 = ["api", "user_profile &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "user_profile &gt; list"]
result = client.action(schema, action)

user_profile > create

POST /api/user_profile/

Description:

Create profile.

NOTE:
- If guest=false - username, email is required.
- If guest=true - username is generated automatically
- password is required.
- password and confirm password in output is to confirm that password has been changed "[CHANGED]", otherwise ""
Return:

Users profile (id, username, email, password, confirm_password, language, country, for_delete, guest)

Request Body

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

Parameter	Description
`username`
`email`
`password`
`confirm_password`
`language`
`country`
`for_delete`
`guest`

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api user_profile &gt; create -p username=... -p email=... -p password=... -p confirm_password=... -p language=... -p country=... -p for_delete=... -p guest=...

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

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

// Interact with the API endpoint
var action = ["api", "user_profile &gt; create"]
var params = {
    username: ...,
    email: ...,
    password: ...,
    confirm_password: ...,
    language: ...,
    country: ...,
    for_delete: ...,
    guest: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "user_profile &gt; create"]
params = {
    "username": ...,
    "email": ...,
    "password": ...,
    "confirm_password": ...,
    "language": ...,
    "country": ...,
    "for_delete": ...,
    "guest": ...,
}
result = client.action(schema, action, params=params)

user_profile > update

PUT /api/user_profile/{id}/

Description:

Update profile informations about current, authenticated user.

NOTE:
- All fields will be set, otherwise use update_partial.
- password is required.
- Available only for logged users.
- password and confirm password in output is to confirm that password has been changed "[CHANGED]", otherwise ""
Return:

Users profile (id, username, email, password, confirm_password, language, country, for_delete, guest)

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`username` required
`email` required
`password` required
`confirm_password` required
`language`
`country`
`for_delete`
`guest`

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api user_profile &gt; update -p id=... -p username=... -p email=... -p password=... -p confirm_password=... -p language=... -p country=... -p for_delete=... -p guest=...

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

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

// Interact with the API endpoint
var action = ["api", "user_profile &gt; update"]
var params = {
    id: ...,
    username: ...,
    email: ...,
    password: ...,
    confirm_password: ...,
    language: ...,
    country: ...,
    for_delete: ...,
    guest: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "user_profile &gt; update"]
params = {
    "id": ...,
    "username": ...,
    "email": ...,
    "password": ...,
    "confirm_password": ...,
    "language": ...,
    "country": ...,
    "for_delete": ...,
    "guest": ...,
}
result = client.action(schema, action, params=params)

user_profile > partial_update

PATCH /api/user_profile/{id}/

Description:

Partial update profile informations about current, authenticated user.

NOTE:
- Only sended fields will be set, otherwise use update.
- Available only for logged users.
- password and confirm password in output is to confirm that password has been changed "[CHANGED]", otherwise ""
Return:

Users profile (id, username, email, password, confirm_password, language, country, for_delete, guest)

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`username`
`email`
`password`
`confirm_password`
`language`
`country`
`for_delete`
`guest`

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action api user_profile &gt; partial_update -p id=... -p username=... -p email=... -p password=... -p confirm_password=... -p language=... -p country=... -p for_delete=... -p guest=...

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

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

// Interact with the API endpoint
var action = ["api", "user_profile &gt; partial_update"]
var params = {
    id: ...,
    username: ...,
    email: ...,
    password: ...,
    confirm_password: ...,
    language: ...,
    country: ...,
    for_delete: ...,
    guest: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["api", "user_profile &gt; partial_update"]
params = {
    "id": ...,
    "username": ...,
    "email": ...,
    "password": ...,
    "confirm_password": ...,
    "language": ...,
    "country": ...,
    "for_delete": ...,
    "guest": ...,
}
result = client.action(schema, action, params=params)

auth

convert-token > create

POST /auth/convert-token

Implements an endpoint to convert a provider token to an access token

The endpoint is used in the following flows:

Authorization code
Client credentials

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action auth convert-token &gt; create

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

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

// Interact with the API endpoint
var action = ["auth", "convert-token &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["auth", "convert-token &gt; create"]
result = client.action(schema, action)

invalidate-sessions > create

POST /auth/invalidate-sessions

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action auth invalidate-sessions &gt; create

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

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

// Interact with the API endpoint
var action = ["auth", "invalidate-sessions &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["auth", "invalidate-sessions &gt; create"]
result = client.action(schema, action)

revoke-token > create

POST /auth/revoke-token

Implements an endpoint to revoke access or refresh tokens

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action auth revoke-token &gt; create

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

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

// Interact with the API endpoint
var action = ["auth", "revoke-token &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["auth", "revoke-token &gt; create"]
result = client.action(schema, action)

token > create

POST /auth/token

Implements an endpoint to provide access tokens

The endpoint is used in the following flows:

Authorization code
Password
Client credentials

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action auth token &gt; create

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

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

// Interact with the API endpoint
var action = ["auth", "token &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["auth", "token &gt; create"]
result = client.action(schema, action)

private-media-api

read

GET /private-media-api/{path}

Description:

Retrieve the specific resource file (if exists) for location and item.

Path parameter example for location: location/aligator.jpg

NOTE:
- Available only for logged users.
Return:

BLOB

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`path` required

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action private-media-api read -p path=...

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

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

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["private-media-api", "read"]
params = {
    "path": ...,
}
result = client.action(schema, action, params=params)

user_profile

reset-achievements > list

GET /user_profile/reset-achievements/

Description:

Reset achievements of current user.

Return:

(message, error:[0-OK,1-error])

# Load the schema document
$ coreapi get https://cms.quistorp.emused.eu/docs/

# Interact with the API endpoint
$ coreapi action user_profile reset-achievements &gt; 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 = ["user_profile", "reset-achievements &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://cms.quistorp.emused.eu/docs/")

# Interact with the API endpoint
action = ["user_profile", "reset-achievements &gt; list"]
result = client.action(schema, action)