Memento API Doc

Add yourself or your unit/group as a member of the group memento-api-rest-consumers (https://groups.epfl.ch/cgi-bin/groups/viewgroup?groupid=S23510) in order to be notified of changes in the API.

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

# Install the Python client library
$ pip install coreapi

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

domains

list

GET /api/v1/domains/

List all Domain objects.

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.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

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

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

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

// Interact with the API endpoint
var action = ["domains", "list"]
var params = {
    limit: ...,
    offset: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

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

read

GET /api/v1/domains/{id}/

Return the details about the given Domain id.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

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

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

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

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

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

// Interact with the API endpoint
var action = ["domains", "read"]
var params = {
    id: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

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

events

list

GET /api/v1/events/

List all Event objects.

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.
`title`	Filters the events containing the given text in their title. Case insensitive.
`description`	Filters the events containing the given text in their description. Case insensitive.
`start_date`	Filters the events which start at the given start_date
`end_date`	Filters the events which finish at the given end_date
`start_time`	Filters the events which start at the given start_time
`end_time`	Filters the events which finish at the given end_time
`start_year`	Filters the events which start at the given start_year
`place_and_room`	Filters the events containing the given text in the place_and_room field. Case insensitive.
`spoken_languages`	Integer: Spoken Language ID. Return only the events linked to the given spoken language.
`memento`	Integer: Memento ID. Return only the events in the given memento.
`category`	Integer: Category ID. Return only the event linked to the given category.
`theme`	Theme name. Return only the events linked to the given theme.
`keywords`	Keywords name. Return only the events linked to the given keywords.
`vulgarization`	Integer: Vulgarization ID. Return only the events linked to the given vulgarization.
`registration`	Integer: Registration ID. Return only the events linked to the given registration.
`domains`	Integer: Domain ID. Return only the events linked to the given public.
`academic_calendar_category`	Integer: Academic Calendar Category ID. Return only the event linked to the given category.
`speaker`	Filters the events containing the given text in the speaker field. Case insensitive.
`organizer`	Filters the events containing the given text in the organizer field. Case insensitive.
`contact`	Filters the events containing the given text in the contact field. Case insensitive.
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

# Interact with the API endpoint
$ coreapi action events list -p limit=... -p offset=... -p title=... -p description=... -p start_date=... -p end_date=... -p start_time=... -p end_time=... -p start_year=... -p place_and_room=... -p spoken_languages=... -p memento=... -p category=... -p theme=... -p keywords=... -p vulgarization=... -p registration=... -p domains=... -p academic_calendar_category=... -p speaker=... -p organizer=... -p contact=... -p search=... -p ordering=...

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

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

// Interact with the API endpoint
var action = ["events", "list"]
var params = {
    limit: ...,
    offset: ...,
    title: ...,
    description: ...,
    start_date: ...,
    end_date: ...,
    start_time: ...,
    end_time: ...,
    start_year: ...,
    place_and_room: ...,
    spoken_languages: ...,
    memento: ...,
    category: ...,
    theme: ...,
    keywords: ...,
    vulgarization: ...,
    registration: ...,
    domains: ...,
    academic_calendar_category: ...,
    speaker: ...,
    organizer: ...,
    contact: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

# Interact with the API endpoint
action = ["events", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "title": ...,
    "description": ...,
    "start_date": ...,
    "end_date": ...,
    "start_time": ...,
    "end_time": ...,
    "start_year": ...,
    "place_and_room": ...,
    "spoken_languages": ...,
    "memento": ...,
    "category": ...,
    "theme": ...,
    "keywords": ...,
    "vulgarization": ...,
    "registration": ...,
    "domains": ...,
    "academic_calendar_category": ...,
    "speaker": ...,
    "organizer": ...,
    "contact": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/events/{event__pk}/

Return the details about the given Event id.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`event__pk` required

Query Parameters

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

Parameter	Description
`title`	Filters the events containing the given text in their title. Case insensitive.
`description`	Filters the events containing the given text in their description. Case insensitive.
`start_date`	Filters the events which start at the given start_date
`end_date`	Filters the events which finish at the given end_date
`start_time`	Filters the events which start at the given start_time
`end_time`	Filters the events which finish at the given end_time
`start_year`	Filters the events which start at the given start_year
`place_and_room`	Filters the events containing the given text in the place_and_room field. Case insensitive.
`spoken_languages`	Integer: Spoken Language ID. Return only the events linked to the given spoken language.
`memento`	Integer: Memento ID. Return only the events in the given memento.
`category`	Integer: Category ID. Return only the event linked to the given category.
`theme`	Theme name. Return only the events linked to the given theme.
`keywords`	Keywords name. Return only the events linked to the given keywords.
`vulgarization`	Integer: Vulgarization ID. Return only the events linked to the given vulgarization.
`registration`	Integer: Registration ID. Return only the events linked to the given registration.
`domains`	Integer: Domain ID. Return only the events linked to the given public.
`academic_calendar_category`	Integer: Academic Calendar Category ID. Return only the event linked to the given category.
`speaker`	Filters the events containing the given text in the speaker field. Case insensitive.
`organizer`	Filters the events containing the given text in the organizer field. Case insensitive.
`contact`	Filters the events containing the given text in the contact field. Case insensitive.
`search`	A search term.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

# Interact with the API endpoint
$ coreapi action events read -p event__pk=... -p title=... -p description=... -p start_date=... -p end_date=... -p start_time=... -p end_time=... -p start_year=... -p place_and_room=... -p spoken_languages=... -p memento=... -p category=... -p theme=... -p keywords=... -p vulgarization=... -p registration=... -p domains=... -p academic_calendar_category=... -p speaker=... -p organizer=... -p contact=... -p search=... -p ordering=...

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

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

// Interact with the API endpoint
var action = ["events", "read"]
var params = {
    event__pk: ...,
    title: ...,
    description: ...,
    start_date: ...,
    end_date: ...,
    start_time: ...,
    end_time: ...,
    start_year: ...,
    place_and_room: ...,
    spoken_languages: ...,
    memento: ...,
    category: ...,
    theme: ...,
    keywords: ...,
    vulgarization: ...,
    registration: ...,
    domains: ...,
    academic_calendar_category: ...,
    speaker: ...,
    organizer: ...,
    contact: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

# Interact with the API endpoint
action = ["events", "read"]
params = {
    "event__pk": ...,
    "title": ...,
    "description": ...,
    "start_date": ...,
    "end_date": ...,
    "start_time": ...,
    "end_time": ...,
    "start_year": ...,
    "place_and_room": ...,
    "spoken_languages": ...,
    "memento": ...,
    "category": ...,
    "theme": ...,
    "keywords": ...,
    "vulgarization": ...,
    "registration": ...,
    "domains": ...,
    "academic_calendar_category": ...,
    "speaker": ...,
    "organizer": ...,
    "contact": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

faculties

list

GET /api/v1/faculties/

Domain

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.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

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

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

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

// Interact with the API endpoint
var action = ["faculties", "list"]
var params = {
    limit: ...,
    offset: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

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

read

GET /api/v1/faculties/{id}/

Domain

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

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

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

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

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

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

// Interact with the API endpoint
var action = ["faculties", "read"]
var params = {
    id: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

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

mementos

list

GET /api/v1/mementos/

List all Memento objects.

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.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

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

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

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

// Interact with the API endpoint
var action = ["mementos", "list"]
var params = {
    limit: ...,
    offset: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

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

read

GET /api/v1/mementos/{id}/

Return the details about the given Memento id.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

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

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

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

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

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

// Interact with the API endpoint
var action = ["mementos", "read"]
var params = {
    id: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

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

events

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

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

# Interact with the API endpoint
$ coreapi action mementos events -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 = ["mementos", "events"]
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("http://memento.epfl.ch/api/docs/")

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

registrations

list

GET /api/v1/registrations/

List all Registration objects.

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

# Interact with the API endpoint
$ coreapi action registrations 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 = ["registrations", "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("http://memento.epfl.ch/api/docs/")

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

read

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

Return the details about the given Registration id.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

# Interact with the API endpoint
$ coreapi action registrations 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 = ["registrations", "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("http://memento.epfl.ch/api/docs/")

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

spoken_languages

list

GET /api/v1/spoken_languages/

List all Spoken Language objects.

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.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

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

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

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

// Interact with the API endpoint
var action = ["spoken_languages", "list"]
var params = {
    limit: ...,
    offset: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

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

read

GET /api/v1/spoken_languages/{id}/

Return the details about the given Spoken Language id.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

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

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

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

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

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

// Interact with the API endpoint
var action = ["spoken_languages", "read"]
var params = {
    id: ...,
    search: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://memento.epfl.ch/api/docs/")

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

vulgarizations

list

GET /api/v1/vulgarizations/

List all Vulgarization objects.

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

# Interact with the API endpoint
$ coreapi action vulgarizations 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 = ["vulgarizations", "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("http://memento.epfl.ch/api/docs/")

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

read

GET /api/v1/vulgarizations/{id}/

Return the details about the given Vulgarization id.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://memento.epfl.ch/api/docs/

# Interact with the API endpoint
$ coreapi action vulgarizations 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 = ["vulgarizations", "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("http://memento.epfl.ch/api/docs/")

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

Memento API Doc

Memento API Doc

categories

list

Query Parameters

read

Path Parameters

Query Parameters

domains

list

Query Parameters

read

Path Parameters

Query Parameters

events

list

Query Parameters

read

Path Parameters

Query Parameters

faculties

list

Query Parameters

read

Path Parameters

Query Parameters

mementos

list

Query Parameters

read

Path Parameters

Query Parameters

events

Path Parameters

registrations

list

read

Path Parameters

spoken_languages

list

Query Parameters

read

Path Parameters

Query Parameters

vulgarizations

list

read

Path Parameters