Actu API Doc

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

categories

GET /api/v1/categories/

List all Category objects.

Query Parameters

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

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

# Interact with the API endpoint
$ coreapi action categories list -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 = ["categories", "list"]
var params = {
    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("https://actu.epfl.ch/api-docs/")

# Interact with the API endpoint
action = ["categories", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/categories/{id}/

Return the details about the given Category id.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredA unique integer value identifying this category.

Query Parameters

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

ParameterDescription
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

# Interact with the API endpoint
$ coreapi action categories read -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 = ["categories", "read"]
var params = {
    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("https://actu.epfl.ch/api-docs/")

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

channels

GET /api/v1/channels/

List all Channel objects.

Query Parameters

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

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

# Interact with the API endpoint
action = ["channels", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)
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.

ParameterDescription
id required

Query Parameters

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

ParameterDescription
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

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

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id required
 
# Load the schema document
$ coreapi get https://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("https://actu.epfl.ch/api-docs/")

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

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id required
 
# Load the schema document
$ coreapi get https://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("https://actu.epfl.ch/api-docs/")

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

faculties

GET /api/v1/faculties/

List all Faculty objects.

Query Parameters

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

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

# Interact with the API endpoint
action = ["faculties", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)
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.

ParameterDescription
id requiredA unique integer value identifying this Faculty.

Query Parameters

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

ParameterDescription
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

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

news

GET /api/v1/news/

List all News objects.

Query Parameters

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

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
searchA search term.
langPrefered language for the news
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

# Interact with the API endpoint
$ coreapi action news list -p limit=... -p offset=... -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: ...,
    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("https://actu.epfl.ch/api-docs/")

# Interact with the API endpoint
action = ["news", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
    "lang": ...,
}
result = client.action(schema, action, params=params)
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.

ParameterDescription
news__pk required

Query Parameters

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

ParameterDescription
searchA search term.
langPrefered language for the news
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

# Interact with the API endpoint
$ coreapi action news read -p news__pk=... -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: ...,
    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("https://actu.epfl.ch/api-docs/")

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

projects

GET /api/v1/projects/

List all Project objects.

Query Parameters

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

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

# Interact with the API endpoint
action = ["projects", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)
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.

ParameterDescription
id requiredA unique integer value identifying this project.

Query Parameters

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

ParameterDescription
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

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

publics

GET /api/v1/publics/

List all Public objects.

Query Parameters

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

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

# Interact with the API endpoint
action = ["publics", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)
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.

ParameterDescription
id requiredA unique integer value identifying this public.

Query Parameters

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

ParameterDescription
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

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

themes

GET /api/v1/themes/

List all Theme objects.

Query Parameters

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

ParameterDescription
limitNumber of results to return per page.
offsetThe initial index from which to return the results.
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

# Interact with the API endpoint
action = ["themes", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)
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.

ParameterDescription
id requiredA unique integer value identifying this theme.

Query Parameters

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

ParameterDescription
searchA search term.
 
# Load the schema document
$ coreapi get https://actu.epfl.ch/api-docs/

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

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