UMN API

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

# Install the Python client library
$ pip install coreapi

api

artists > list

GET /api/{version}/artists/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`headliner`
`genres`
`tag`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api artists list -p version=... -p limit=... -p offset=... -p search=... -p headliner=... -p genres=... -p tag=... -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 = ["api", "artists > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
    headliner: ...,
    genres: ...,
    tag: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "artists > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "headliner": ...,
    "genres": ...,
    "tag": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

artists > name_stat

GET /api/{version}/artists/name_stat/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api artists name_stat -p version=...

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "artists > name_stat"]
params = {
    "version": ...,
}
result = client.action(schema, action, params=params)

artists > read

GET /api/{version}/artists/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Query Parameters

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

Parameter	Description
`search`	A search term.
`headliner`
`genres`
`tag`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api artists read -p version=... -p id=... -p search=... -p headliner=... -p genres=... -p tag=... -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 = ["api", "artists > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
    headliner: ...,
    genres: ...,
    tag: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "artists > read"]
params = {
    "version": ...,
    "id": ...,
    "search": ...,
    "headliner": ...,
    "genres": ...,
    "tag": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

artists > add_to_favorites

POST /api/{version}/artists/{id}/add_to_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Request Body

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

Parameter	Description
`name` required
`slug`
`description`
`long_description`
`headliner`
`links`
`youtube_links`
`vk_playlist_link`
`vk_playlist_code`

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api artists add_to_favorites -p version=... -p id=... -p name=... -p slug=... -p description=... -p long_description=... -p headliner=... -p links=... -p youtube_links=... -p vk_playlist_link=... -p vk_playlist_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", "artists > add_to_favorites"]
var params = {
    version: ...,
    id: ...,
    name: ...,
    slug: ...,
    description: ...,
    long_description: ...,
    headliner: ...,
    links: ...,
    youtube_links: ...,
    vk_playlist_link: ...,
    vk_playlist_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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "artists > add_to_favorites"]
params = {
    "version": ...,
    "id": ...,
    "name": ...,
    "slug": ...,
    "description": ...,
    "long_description": ...,
    "headliner": ...,
    "links": ...,
    "youtube_links": ...,
    "vk_playlist_link": ...,
    "vk_playlist_code": ...,
}
result = client.action(schema, action, params=params)

artists > remove_from_favorites

POST /api/{version}/artists/{id}/remove_from_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Request Body

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

Parameter	Description
`name` required
`slug`
`description`
`long_description`
`headliner`
`links`
`youtube_links`
`vk_playlist_link`
`vk_playlist_code`

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api artists remove_from_favorites -p version=... -p id=... -p name=... -p slug=... -p description=... -p long_description=... -p headliner=... -p links=... -p youtube_links=... -p vk_playlist_link=... -p vk_playlist_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", "artists > remove_from_favorites"]
var params = {
    version: ...,
    id: ...,
    name: ...,
    slug: ...,
    description: ...,
    long_description: ...,
    headliner: ...,
    links: ...,
    youtube_links: ...,
    vk_playlist_link: ...,
    vk_playlist_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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "artists > remove_from_favorites"]
params = {
    "version": ...,
    "id": ...,
    "name": ...,
    "slug": ...,
    "description": ...,
    "long_description": ...,
    "headliner": ...,
    "links": ...,
    "youtube_links": ...,
    "vk_playlist_link": ...,
    "vk_playlist_code": ...,
}
result = client.action(schema, action, params=params)

auth > confirm_email > create

POST /api/{version}/auth/confirm_email/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`key` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth confirm_email create -p version=... -p key=...

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

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

// Interact with the API endpoint
var action = ["api", "auth > confirm_email > create"]
var params = {
    version: ...,
    key: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "auth > confirm_email > create"]
params = {
    "version": ...,
    "key": ...,
}
result = client.action(schema, action, params=params)

auth > facebook > create

POST /api/{version}/auth/facebook/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`access_token`
`code`

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth facebook create -p version=... -p access_token=... -p code=...

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

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

// Interact with the API endpoint
var action = ["api", "auth > facebook > create"]
var params = {
    version: ...,
    access_token: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "auth > facebook > create"]
params = {
    "version": ...,
    "access_token": ...,
    "code": ...,
}
result = client.action(schema, action, params=params)

auth > instagram > create

POST /api/{version}/auth/instagram/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`access_token`
`code`

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth instagram create -p version=... -p access_token=... -p code=...

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

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

// Interact with the API endpoint
var action = ["api", "auth > instagram > create"]
var params = {
    version: ...,
    access_token: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "auth > instagram > create"]
params = {
    "version": ...,
    "access_token": ...,
    "code": ...,
}
result = client.action(schema, action, params=params)

POST /api/{version}/auth/login/

Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework Accept the following POST parameters: username, password Return the REST Framework Token Object's key.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`email` required
`password` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth login create -p version=... -p email=... -p password=...

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

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

// Interact with the API endpoint
var action = ["api", "auth > login > create"]
var params = {
    version: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

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

auth > password_reset > create

POST /api/{version}/auth/password_reset/

Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`email` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth password_reset create -p version=... -p email=...

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

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

// Interact with the API endpoint
var action = ["api", "auth > password_reset > create"]
var params = {
    version: ...,
    email: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "auth > password_reset > create"]
params = {
    "version": ...,
    "email": ...,
}
result = client.action(schema, action, params=params)

auth > password_reset_confirm > create

POST /api/{version}/auth/password_reset_confirm/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`new_password1` required
`new_password2` required
`uid` required
`token` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth password_reset_confirm create -p version=... -p new_password1=... -p new_password2=... -p uid=... -p token=...

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

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

// Interact with the API endpoint
var action = ["api", "auth > password_reset_confirm > create"]
var params = {
    version: ...,
    new_password1: ...,
    new_password2: ...,
    uid: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "auth > password_reset_confirm > create"]
params = {
    "version": ...,
    "new_password1": ...,
    "new_password2": ...,
    "uid": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

auth > registration > create

POST /api/{version}/auth/registration/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`email` required
`password1` required
`password2` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth registration create -p version=... -p email=... -p password1=... -p password2=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "auth > registration > create"]
var params = {
    version: ...,
    email: ...,
    password1: ...,
    password2: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "auth > registration > create"]
params = {
    "version": ...,
    "email": ...,
    "password1": ...,
    "password2": ...,
}
result = client.action(schema, action, params=params)

auth > registration > verify-email > create

POST /api/{version}/auth/registration/verify-email/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`key` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth registration verify-email create -p version=... -p key=...

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

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

// Interact with the API endpoint
var action = ["api", "auth > registration > verify-email > create"]
var params = {
    version: ...,
    key: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "auth > registration > verify-email > create"]
params = {
    "version": ...,
    "key": ...,
}
result = client.action(schema, action, params=params)

auth > vkontakte > mobile > create

POST /api/{version}/auth/vkontakte/mobile/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`access_token` required
`first_name`
`last_name`
`photo`
`friends` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth vkontakte mobile create -p version=... -p access_token=... -p first_name=... -p last_name=... -p photo=... -p friends=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "auth > vkontakte > mobile > create"]
var params = {
    version: ...,
    access_token: ...,
    first_name: ...,
    last_name: ...,
    photo: ...,
    friends: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "auth > vkontakte > mobile > create"]
params = {
    "version": ...,
    "access_token": ...,
    "first_name": ...,
    "last_name": ...,
    "photo": ...,
    "friends": ...,
}
result = client.action(schema, action, params=params)

auth > vkontakte > web > create

POST /api/{version}/auth/vkontakte/web/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`access_token`
`code`

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api auth vkontakte web create -p version=... -p access_token=... -p code=...

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

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

// Interact with the API endpoint
var action = ["api", "auth > vkontakte > web > create"]
var params = {
    version: ...,
    access_token: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "auth > vkontakte > web > create"]
params = {
    "version": ...,
    "access_token": ...,
    "code": ...,
}
result = client.action(schema, action, params=params)

experts > list

GET /api/{version}/experts/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api experts list -p version=... -p limit=... -p offset=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "experts > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "experts > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

experts > read

GET /api/{version}/experts/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`search`	A search term.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api experts read -p version=... -p id=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "experts > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

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

genres > list

GET /api/{version}/genres/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api genres list -p version=... -p limit=... -p offset=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "genres > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "genres > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

genres > read

GET /api/{version}/genres/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`search`	A search term.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api genres read -p version=... -p id=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "genres > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

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

journal_authors > list

GET /api/{version}/journal_authors/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api journal_authors list -p version=... -p limit=... -p offset=... -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 = ["api", "journal_authors > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "journal_authors > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

journal_authors > read

GET /api/{version}/journal_authors/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required	A unique integer value identifying this journal author.

Query Parameters

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

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

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api journal_authors read -p version=... -p id=... -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 = ["api", "journal_authors > read"]
var params = {
    version: ...,
    id: ...,
    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("http://test.api.umn.2tapp.cc/")

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

me > list

GET /api/{version}/me/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api me list -p version=...

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

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

me > delete

DELETE /api/{version}/me/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api me delete -p version=...

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

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

news > list

GET /api/{version}/news/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`tag`
`author`
`categories`
`promo`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api news list -p version=... -p limit=... -p offset=... -p search=... -p tag=... -p author=... -p categories=... -p promo=... -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 = ["api", "news > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
    tag: ...,
    author: ...,
    categories: ...,
    promo: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "news > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "tag": ...,
    "author": ...,
    "categories": ...,
    "promo": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

news > read

GET /api/{version}/news/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Query Parameters

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

Parameter	Description
`search`	A search term.
`tag`
`author`
`categories`
`promo`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api news read -p version=... -p id=... -p search=... -p tag=... -p author=... -p categories=... -p promo=... -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 = ["api", "news > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
    tag: ...,
    author: ...,
    categories: ...,
    promo: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "news > read"]
params = {
    "version": ...,
    "id": ...,
    "search": ...,
    "tag": ...,
    "author": ...,
    "categories": ...,
    "promo": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

news > comment

POST /api/{version}/news/{id}/comment/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

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 http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api news comment -p version=... -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", "news > comment"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "news > comment"]
params = {
    "version": ...,
    "id": ...,
    "text": ...,
}
result = client.action(schema, action, params=params)

partner_routes > list

GET /api/{version}/partner_routes/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`random_order`

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api partner_routes list -p version=... -p limit=... -p offset=... -p search=... -p random_order=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "partner_routes > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
    random_order: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "partner_routes > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "random_order": ...,
}
result = client.action(schema, action, params=params)

partner_routes > read

GET /api/{version}/partner_routes/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Query Parameters

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

Parameter	Description
`search`	A search term.
`random_order`

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api partner_routes read -p version=... -p id=... -p search=... -p random_order=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "partner_routes > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
    random_order: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "partner_routes > read"]
params = {
    "version": ...,
    "id": ...,
    "search": ...,
    "random_order": ...,
}
result = client.action(schema, action, params=params)

partner_routes > add_to_favorites

POST /api/{version}/partner_routes/{id}/add_to_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Request Body

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

Parameter	Description
`name` required
`name_preposition`
`description`
`links`

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api partner_routes add_to_favorites -p version=... -p id=... -p name=... -p name_preposition=... -p description=... -p links=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "partner_routes > add_to_favorites"]
var params = {
    version: ...,
    id: ...,
    name: ...,
    name_preposition: ...,
    description: ...,
    links: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "partner_routes > add_to_favorites"]
params = {
    "version": ...,
    "id": ...,
    "name": ...,
    "name_preposition": ...,
    "description": ...,
    "links": ...,
}
result = client.action(schema, action, params=params)

partner_routes > remove_from_favorites

POST /api/{version}/partner_routes/{id}/remove_from_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Request Body

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

Parameter	Description
`name` required
`name_preposition`
`description`
`links`

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api partner_routes remove_from_favorites -p version=... -p id=... -p name=... -p name_preposition=... -p description=... -p links=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "partner_routes > remove_from_favorites"]
var params = {
    version: ...,
    id: ...,
    name: ...,
    name_preposition: ...,
    description: ...,
    links: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "partner_routes > remove_from_favorites"]
params = {
    "version": ...,
    "id": ...,
    "name": ...,
    "name_preposition": ...,
    "description": ...,
    "links": ...,
}
result = client.action(schema, action, params=params)

partners > list

GET /api/{version}/partners/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api partners list -p version=... -p limit=... -p offset=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "partners > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "partners > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

partners > read

GET /api/{version}/partners/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`search`	A search term.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api partners read -p version=... -p id=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "partners > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

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

performances > list

GET /api/{version}/performances/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`artist`
`place`
`artist__genres`
`artist__tag`
`datetime`
`favorited`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances list -p version=... -p limit=... -p offset=... -p search=... -p artist=... -p place=... -p artist__genres=... -p artist__tag=... -p datetime=... -p favorited=... -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 = ["api", "performances > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
    artist: ...,
    place: ...,
    artist__genres: ...,
    artist__tag: ...,
    datetime: ...,
    favorited: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "artist": ...,
    "place": ...,
    "artist__genres": ...,
    "artist__tag": ...,
    "datetime": ...,
    "favorited": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

performances > get_from_cache

GET /api/{version}/performances/get_from_cache/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances get_from_cache -p version=...

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances > get_from_cache"]
params = {
    "version": ...,
}
result = client.action(schema, action, params=params)

performances > merge_favorites

POST /api/{version}/performances/merge_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`performances` required
`partner_routes` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances merge_favorites -p version=... -p performances=... -p partner_routes=...

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances > merge_favorites"]
params = {
    "version": ...,
    "performances": ...,
    "partner_routes": ...,
}
result = client.action(schema, action, params=params)

performances > read

GET /api/{version}/performances/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Query Parameters

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

Parameter	Description
`search`	A search term.
`artist`
`place`
`artist__genres`
`artist__tag`
`datetime`
`favorited`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances read -p version=... -p id=... -p search=... -p artist=... -p place=... -p artist__genres=... -p artist__tag=... -p datetime=... -p favorited=... -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 = ["api", "performances > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
    artist: ...,
    place: ...,
    artist__genres: ...,
    artist__tag: ...,
    datetime: ...,
    favorited: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances > read"]
params = {
    "version": ...,
    "id": ...,
    "search": ...,
    "artist": ...,
    "place": ...,
    "artist__genres": ...,
    "artist__tag": ...,
    "datetime": ...,
    "favorited": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

performances > add_to_favorites

POST /api/{version}/performances/{id}/add_to_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances add_to_favorites -p version=... -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", "performances > add_to_favorites"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances > add_to_favorites"]
params = {
    "version": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

performances > remove_from_favorites

POST /api/{version}/performances/{id}/remove_from_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances remove_from_favorites -p version=... -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", "performances > remove_from_favorites"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances > remove_from_favorites"]
params = {
    "version": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

performances_lite > list

GET /api/{version}/performances_lite/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`artist`
`place`
`artist__genres`
`artist__tag`
`datetime`
`favorited`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances_lite list -p version=... -p limit=... -p offset=... -p search=... -p artist=... -p place=... -p artist__genres=... -p artist__tag=... -p datetime=... -p favorited=... -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 = ["api", "performances_lite > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
    artist: ...,
    place: ...,
    artist__genres: ...,
    artist__tag: ...,
    datetime: ...,
    favorited: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances_lite > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "artist": ...,
    "place": ...,
    "artist__genres": ...,
    "artist__tag": ...,
    "datetime": ...,
    "favorited": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

performances_lite > get_from_cache

GET /api/{version}/performances_lite/get_from_cache/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances_lite get_from_cache -p version=...

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

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances_lite > get_from_cache"]
params = {
    "version": ...,
}
result = client.action(schema, action, params=params)

performances_lite > merge_favorites

POST /api/{version}/performances_lite/merge_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Request Body

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

Parameter	Description
`performances` required
`partner_routes` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances_lite merge_favorites -p version=... -p performances=... -p partner_routes=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "performances_lite > merge_favorites"]
var params = {
    version: ...,
    performances: ...,
    partner_routes: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances_lite > merge_favorites"]
params = {
    "version": ...,
    "performances": ...,
    "partner_routes": ...,
}
result = client.action(schema, action, params=params)

performances_lite > read

GET /api/{version}/performances_lite/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Query Parameters

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

Parameter	Description
`search`	A search term.
`artist`
`place`
`artist__genres`
`artist__tag`
`datetime`
`favorited`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances_lite read -p version=... -p id=... -p search=... -p artist=... -p place=... -p artist__genres=... -p artist__tag=... -p datetime=... -p favorited=... -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 = ["api", "performances_lite > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
    artist: ...,
    place: ...,
    artist__genres: ...,
    artist__tag: ...,
    datetime: ...,
    favorited: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances_lite > read"]
params = {
    "version": ...,
    "id": ...,
    "search": ...,
    "artist": ...,
    "place": ...,
    "artist__genres": ...,
    "artist__tag": ...,
    "datetime": ...,
    "favorited": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

performances_lite > add_to_favorites

POST /api/{version}/performances_lite/{id}/add_to_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances_lite add_to_favorites -p version=... -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", "performances_lite > add_to_favorites"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances_lite > add_to_favorites"]
params = {
    "version": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

performances_lite > remove_from_favorites

POST /api/{version}/performances_lite/{id}/remove_from_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api performances_lite remove_from_favorites -p version=... -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", "performances_lite > remove_from_favorites"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "performances_lite > remove_from_favorites"]
params = {
    "version": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

places > list

GET /api/{version}/places/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`genres`
`tag`
`datetime`
`main_platform`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api places list -p version=... -p limit=... -p offset=... -p search=... -p genres=... -p tag=... -p datetime=... -p main_platform=... -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 = ["api", "places > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
    genres: ...,
    tag: ...,
    datetime: ...,
    main_platform: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "places > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "genres": ...,
    "tag": ...,
    "datetime": ...,
    "main_platform": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

places > read

GET /api/{version}/places/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Query Parameters

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

Parameter	Description
`search`	A search term.
`genres`
`tag`
`datetime`
`main_platform`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api places read -p version=... -p id=... -p search=... -p genres=... -p tag=... -p datetime=... -p main_platform=... -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 = ["api", "places > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
    genres: ...,
    tag: ...,
    datetime: ...,
    main_platform: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "places > read"]
params = {
    "version": ...,
    "id": ...,
    "search": ...,
    "genres": ...,
    "tag": ...,
    "datetime": ...,
    "main_platform": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

places_lite > list

GET /api/{version}/places_lite/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.
`genres`
`tag`
`datetime`
`main_platform`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api places_lite list -p version=... -p limit=... -p offset=... -p search=... -p genres=... -p tag=... -p datetime=... -p main_platform=... -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 = ["api", "places_lite > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
    genres: ...,
    tag: ...,
    datetime: ...,
    main_platform: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "places_lite > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
    "genres": ...,
    "tag": ...,
    "datetime": ...,
    "main_platform": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

places_lite > read

GET /api/{version}/places_lite/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required

Query Parameters

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

Parameter	Description
`search`	A search term.
`genres`
`tag`
`datetime`
`main_platform`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api places_lite read -p version=... -p id=... -p search=... -p genres=... -p tag=... -p datetime=... -p main_platform=... -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 = ["api", "places_lite > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
    genres: ...,
    tag: ...,
    datetime: ...,
    main_platform: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "places_lite > read"]
params = {
    "version": ...,
    "id": ...,
    "search": ...,
    "genres": ...,
    "tag": ...,
    "datetime": ...,
    "main_platform": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

profiles > read

GET /api/{version}/profiles/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required	A UUID string identifying this profile.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api profiles read -p version=... -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", "profiles > read"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

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

profiles > add_to_favorites

POST /api/{version}/profiles/{id}/add_to_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required	A UUID string identifying this profile.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api profiles add_to_favorites -p version=... -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", "profiles > add_to_favorites"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "profiles > add_to_favorites"]
params = {
    "version": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

profiles > create_device

POST /api/{version}/profiles/{id}/create_device/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required	A UUID string identifying this profile.

Request Body

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

Parameter	Description
`token` required
`platform` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api profiles create_device -p version=... -p id=... -p token=... -p platform=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "profiles > create_device"]
var params = {
    version: ...,
    id: ...,
    token: ...,
    platform: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "profiles > create_device"]
params = {
    "version": ...,
    "id": ...,
    "token": ...,
    "platform": ...,
}
result = client.action(schema, action, params=params)

profiles > get_friends

GET /api/{version}/profiles/{id}/get_friends/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required	A UUID string identifying this profile.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api profiles get_friends -p version=... -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", "profiles > get_friends"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "profiles > get_friends"]
params = {
    "version": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

profiles > remove_device

POST /api/{version}/profiles/{id}/remove_device/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required	A UUID string identifying this profile.

Request Body

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

Parameter	Description
`token` required

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api profiles remove_device -p version=... -p id=... -p token=...

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

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

// Interact with the API endpoint
var action = ["api", "profiles > remove_device"]
var params = {
    version: ...,
    id: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "profiles > remove_device"]
params = {
    "version": ...,
    "id": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

profiles > remove_from_favorites

POST /api/{version}/profiles/{id}/remove_from_favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required	A UUID string identifying this profile.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api profiles remove_from_favorites -p version=... -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", "profiles > remove_from_favorites"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "profiles > remove_from_favorites"]
params = {
    "version": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

profiles > set_coordinates

POST /api/{version}/profiles/{id}/set_coordinates/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required
`id` required	A UUID string identifying this profile.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api profiles set_coordinates -p version=... -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", "profiles > set_coordinates"]
var params = {
    version: ...,
    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("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "profiles > set_coordinates"]
params = {
    "version": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

search > list

GET /api/{version}/search/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api search list -p version=... -p limit=... -p offset=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "search > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "search > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

tags > list

GET /api/{version}/tags/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`version` required

Query Parameters

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

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`search`	A search term.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api tags list -p version=... -p limit=... -p offset=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "tags > list"]
var params = {
    version: ...,
    limit: ...,
    offset: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

# Interact with the API endpoint
action = ["api", "tags > list"]
params = {
    "version": ...,
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

tags > read

GET /api/{version}/tags/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`search`	A search term.

# Load the schema document
$ coreapi get http://test.api.umn.2tapp.cc/

# Interact with the API endpoint
$ coreapi action api tags read -p version=... -p id=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.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", "tags > read"]
var params = {
    version: ...,
    id: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://test.api.umn.2tapp.cc/")

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