Actu API Doc

Add yourself or your unit/group as a member of the group actu-api-rest-consumers (https://groups.epfl.ch/cgi-bin/groups/viewgroup?groupid=S23511) 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.

channels

list

GET /api/v1/channels/

List all Channel 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.
`name`
`fr_description`
`en_description`
`de_description`
`is_active`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action channels list -p limit=... -p offset=... -p name=... -p fr_description=... -p en_description=... -p de_description=... -p is_active=... -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 = ["channels", "list"]
var params = {
    limit: ...,
    offset: ...,
    name: ...,
    fr_description: ...,
    en_description: ...,
    de_description: ...,
    is_active: ...,
    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://actu.epfl.ch/api-docs/")

# Interact with the API endpoint
action = ["channels", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "name": ...,
    "fr_description": ...,
    "en_description": ...,
    "de_description": ...,
    "is_active": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/channels/{id}/

Return the details about the given Channel id.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`name`
`fr_description`
`en_description`
`de_description`
`is_active`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action channels read -p id=... -p name=... -p fr_description=... -p en_description=... -p de_description=... -p is_active=... -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 = ["channels", "read"]
var params = {
    id: ...,
    name: ...,
    fr_description: ...,
    en_description: ...,
    de_description: ...,
    is_active: ...,
    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://actu.epfl.ch/api-docs/")

# Interact with the API endpoint
action = ["channels", "read"]
params = {
    "id": ...,
    "name": ...,
    "fr_description": ...,
    "en_description": ...,
    "de_description": ...,
    "is_active": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

news

GET /api/v1/channels/{id}/news/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

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

# Interact with the API endpoint
$ coreapi action channels news -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 = ["channels", "news"]
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://actu.epfl.ch/api-docs/")

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

projects

GET /api/v1/channels/{id}/projects/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

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

# Interact with the API endpoint
$ coreapi action channels projects -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 = ["channels", "projects"]
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://actu.epfl.ch/api-docs/")

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

faculties

list

GET /api/v1/faculties/

List all Faculty 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.
`fr_label`
`en_label`
`de_label`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action faculties list -p limit=... -p offset=... -p fr_label=... -p en_label=... -p de_label=... -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 = ["faculties", "list"]
var params = {
    limit: ...,
    offset: ...,
    fr_label: ...,
    en_label: ...,
    de_label: ...,
    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://actu.epfl.ch/api-docs/")

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

read

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

Return the details about the given Faculty id.

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
`fr_label`
`en_label`
`de_label`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action faculties read -p id=... -p fr_label=... -p en_label=... -p de_label=... -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 = ["faculties", "read"]
var params = {
    id: ...,
    fr_label: ...,
    en_label: ...,
    de_label: ...,
    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://actu.epfl.ch/api-docs/")

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

news

list

GET /api/v1/news/

List all News 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 news containing the given text in their title. Case insensitive.
`subtitle`	Filters the news containing the given text in their subtitle. Case insensitive.
`text`	Filters the news containing the given text in their text. Case insensitive.
`channel`	Integer: Channel ID. Return only the news in the given channel.
`category`	Integer: Category ID. Return only the news linked to the given category.
`themes`	Integer: Theme ID. Return only the news linked to the given theme.
`publics`	Integer: Public ID. Return only the news linked to the given public.
`faculties`	Integer: Faculty ID. Return only the news linked to the given faculty.
`projects`	Integer: Project ID. Return only the news linked to the given project.
`search`	A search term.
`lang`	Prefered language for the news

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

# Interact with the API endpoint
$ coreapi action news list -p limit=... -p offset=... -p title=... -p subtitle=... -p text=... -p channel=... -p category=... -p themes=... -p publics=... -p faculties=... -p projects=... -p search=... -p lang=...

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

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

// Interact with the API endpoint
var action = ["news", "list"]
var params = {
    limit: ...,
    offset: ...,
    title: ...,
    subtitle: ...,
    text: ...,
    channel: ...,
    category: ...,
    themes: ...,
    publics: ...,
    faculties: ...,
    projects: ...,
    search: ...,
    lang: ...,
}
client.action(schema, action, 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://actu.epfl.ch/api-docs/")

# Interact with the API endpoint
action = ["news", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "title": ...,
    "subtitle": ...,
    "text": ...,
    "channel": ...,
    "category": ...,
    "themes": ...,
    "publics": ...,
    "faculties": ...,
    "projects": ...,
    "search": ...,
    "lang": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v1/news/{news__pk}/

Return the details about the given News id.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`news__pk` required

Query Parameters

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

Parameter	Description
`title`	Filters the news containing the given text in their title. Case insensitive.
`subtitle`	Filters the news containing the given text in their subtitle. Case insensitive.
`text`	Filters the news containing the given text in their text. Case insensitive.
`channel`	Integer: Channel ID. Return only the news in the given channel.
`category`	Integer: Category ID. Return only the news linked to the given category.
`themes`	Integer: Theme ID. Return only the news linked to the given theme.
`publics`	Integer: Public ID. Return only the news linked to the given public.
`faculties`	Integer: Faculty ID. Return only the news linked to the given faculty.
`projects`	Integer: Project ID. Return only the news linked to the given project.
`search`	A search term.
`lang`	Prefered language for the news

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

# Interact with the API endpoint
$ coreapi action news read -p news__pk=... -p title=... -p subtitle=... -p text=... -p channel=... -p category=... -p themes=... -p publics=... -p faculties=... -p projects=... -p search=... -p lang=...

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

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

// Interact with the API endpoint
var action = ["news", "read"]
var params = {
    news__pk: ...,
    title: ...,
    subtitle: ...,
    text: ...,
    channel: ...,
    category: ...,
    themes: ...,
    publics: ...,
    faculties: ...,
    projects: ...,
    search: ...,
    lang: ...,
}
client.action(schema, action, 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://actu.epfl.ch/api-docs/")

# Interact with the API endpoint
action = ["news", "read"]
params = {
    "news__pk": ...,
    "title": ...,
    "subtitle": ...,
    "text": ...,
    "channel": ...,
    "category": ...,
    "themes": ...,
    "publics": ...,
    "faculties": ...,
    "projects": ...,
    "search": ...,
    "lang": ...,
}
result = client.action(schema, action, params=params)

projects

list

GET /api/v1/projects/

List all Project 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.
`fr_label`
`en_label`
`de_label`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action projects list -p limit=... -p offset=... -p fr_label=... -p en_label=... -p de_label=... -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 = ["projects", "list"]
var params = {
    limit: ...,
    offset: ...,
    fr_label: ...,
    en_label: ...,
    de_label: ...,
    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://actu.epfl.ch/api-docs/")

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

read

GET /api/v1/projects/{id}/

Return the details about the given Project id.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`fr_label`
`en_label`
`de_label`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action projects read -p id=... -p fr_label=... -p en_label=... -p de_label=... -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 = ["projects", "read"]
var params = {
    id: ...,
    fr_label: ...,
    en_label: ...,
    de_label: ...,
    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://actu.epfl.ch/api-docs/")

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

publics

list

GET /api/v1/publics/

List all Public 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.
`fr_label`
`en_label`
`de_label`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action publics list -p limit=... -p offset=... -p fr_label=... -p en_label=... -p de_label=... -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 = ["publics", "list"]
var params = {
    limit: ...,
    offset: ...,
    fr_label: ...,
    en_label: ...,
    de_label: ...,
    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://actu.epfl.ch/api-docs/")

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

read

GET /api/v1/publics/{id}/

Return the details about the given Public id.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`fr_label`
`en_label`
`de_label`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action publics read -p id=... -p fr_label=... -p en_label=... -p de_label=... -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 = ["publics", "read"]
var params = {
    id: ...,
    fr_label: ...,
    en_label: ...,
    de_label: ...,
    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://actu.epfl.ch/api-docs/")

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

themes

list

GET /api/v1/themes/

List all Theme 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.
`fr_label`
`en_label`
`de_label`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action themes list -p limit=... -p offset=... -p fr_label=... -p en_label=... -p de_label=... -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 = ["themes", "list"]
var params = {
    limit: ...,
    offset: ...,
    fr_label: ...,
    en_label: ...,
    de_label: ...,
    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://actu.epfl.ch/api-docs/")

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

read

GET /api/v1/themes/{id}/

Return the details about the given Theme id.

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`fr_label`
`en_label`
`de_label`
`search`	A search term.

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

# Interact with the API endpoint
$ coreapi action themes read -p id=... -p fr_label=... -p en_label=... -p de_label=... -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 = ["themes", "read"]
var params = {
    id: ...,
    fr_label: ...,
    en_label: ...,
    de_label: ...,
    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://actu.epfl.ch/api-docs/")

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

Actu API Doc

Actu API Doc

categories

list

Query Parameters

read

Path Parameters

Query Parameters

channels

list

Query Parameters

read

Path Parameters

Query Parameters

news

Path Parameters

projects

Path Parameters

faculties

list

Query Parameters

read

Path Parameters

Query Parameters

news

list

Query Parameters

read

Path Parameters

Query Parameters

projects

list

Query Parameters

read

Path Parameters

Query Parameters

publics

list

Query Parameters

read

Path Parameters

Query Parameters

themes

list

Query Parameters

read

Path Parameters

Query Parameters