Documentation of OpenOLAT REST API

The goal of the REST API is to provide an easy way to exchange URLs. It is also used to integrate with other systems such as student administration, external course administration and/or external learning group administration.

Concepts

Representational State Transfer or REST is a style of architecture to be primarily used with the HTTP protocol, but not exclusively. In the case of HTTP, it utilizes all its features: URIs to describe resources, HTTP Methods as "verbs" to manipulate resources (GET to retrieve resources, PUT to create new ones, POST to modify them, DELETE...), HTTP Headers and Media Types for content negotiation...

In OpenOLAT, the JRS-311 is used as a backend for the implementation of our REST API. JSR-311 is a standard from J2EE. We use the reference implementation from the following standard: Jersey.

Security

The security is based on a two level mechanism, as it is in OpenOLAT.

  1. The first level is a servlet filter which collects all requests to the REST API. This filter determines whether the URI is open to everyone (/api, /ping, /auth...) or if it needs an authentication. The authentication itself is delegated to a web service.
  2. The second level happens in all entry points of the REST API. Every method checks if the user (if a user must be authenticated) has enough privileges to operate on the desired resource.

To maintain a valid authentication over several requests, the filter proposes two methods:

  1. Reuse the session cookie on every request. The advantage of this method is that OpenOLAT doesn't need to create a session on every request.
  2. If you cannot use the session cookie, the filter always adds an HTTP Header (X-OLAT-TOKEN) to the response. Send this token with the next request to maintain your privileges.

Configuration

A spring bean allows to configure Resources, Singletons and Providers; either statically with the XML configuration of the bean (/org/olat/restapi/_spring/restApiContext.xml) or programmatically by adding or removing classes and singletons to/from the bean (bean id is the same as its interface: org.olat.restapi.support.RestRegistrationService).

OpenOLAT uses the standard JAXB provider from Jersey to produce XML from java objects, as well as the JSON provider from Jackson, which reuses the same JAXB annotations.

Very important! All configuration settings must be done before the Jersey's servlet starts.

Example

Here is a little example on how to create a user and add it to a learning group:

  1. PUT http://www.frentix.com/olat/restapi/users
    HTTP Header: Content-Type application/json
    Response: 200
  2. GET http://www.frentix.com/olat/restapi/groups
    HTTP Header: Accept application/json
    Response: 200
  3. Choose a group
  4. PUT http://www.frentix.com/olat/restapi/groups/{groupId}/users/{identityKey}
    Response: 200

Documentation

This documentation is based on the WADL format. The XML file is automatically generated by Jersey on runtime. For documentation purposes, this file is the base of a four step Maven process to produce a human readable HTML file.

  1. Generate a XSD schema from all the Java classes used by JAXB for mapping
  2. Generate Javadoc with a custom doclet for WADL
  3. Generate WADL with the output of the two preceding steps
  4. Produce the final HTML documentation with XSLT

To add java classes annoted with JAXB, you must update the pom file in the OpenOLAT directory under the artfact maven-jaxb-schemagen-plugin.

To add resources, you must add the packages to the following plugins configurations: maven-javadoc-plugin and maven-wadl-plugin. Be aware that the first uses commas to seperates the packages and the second semicolons. Both recursively search all resources under the packages.

Examples for the documentation can only be generated for XML. This is a limitation of the maven plugin.

Contents of resources

Resources

/repo/courses/{courseId}

Description:
This web service will handle the functionality related to Course and its contents.

Initial Date: 27 apr. 2010

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

GET

Get the metadatas of the course by id

available response representations:

DELETE

Delete a course by id

available response representations:

/repo/courses/{courseId}/version

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

GET

The version of the Course Web Service

available response representations:

/repo/courses/{courseId}/configuration

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

The course resourceable's id

Methods

GET

Get the configuration of the course

available response representations:

POST

Update the course configuration

acceptable request representations:

available response representations:

/repo/courses/{courseId}/authors

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

The course resourceable's id

Methods

GET

Get all owners and authors of the course

available response representations:

/repo/courses/{courseId}/publish?locale

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

The course resourceable's id

Methods

POST

Publish the course.

request query parameters
parameter value description

locale

string

The course locale

available response representations:

/repo/courses/{courseId}/file

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

Methods

GET

Export the course

available response representations:

/repo/courses/{courseId}/runstructure

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

The course resourceable's id

Methods

GET

Get the runstructure of the course by id

available response representations:

/repo/courses/{courseId}/editortreemodel

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

The course resourceable's id

Methods

GET

Get the editor tree model of the course by id

available response representations:

/repo/courses/{courseId}/authors/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

identityKey

long

The user identifier

courseId

long

The course resourceable's id

Methods

GET

Get this specific author and owner of the course

available response representations:

PUT

Add an owner and author to the course

available response representations:

DELETE

Remove an owner and author to the course

available response representations:

/repo/courses/{courseId}/groups

Description:
CourseGroupWebService

Initial Date: 7 apr. 2010

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

Methods

GET

Lists all learn groups of the specified course.

available response representations:

PUT

Creates a new group for the course.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/groups/version

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

Methods

GET

Retrieves the version of the Course Group Web Service.

available response representations:

/repo/courses/{courseId}/groups/{groupKey}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

The group's id

Methods

GET

Retrieves the metadata of the specified group.

available response representations:

DELETE

Deletes the business group specified by the key of the group.

available response representations:

POST

Updates the metadata for the specified group.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/groups/new

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

Methods

POST

Fallback method for the browser.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/groups/{groupKey}/forum

Description:
Web service to manage a forum.

Initial Date: 20 apr. 2010

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

The key of the group

Methods

GET

Retrieves the forum.

available response representations:

/repo/courses/{courseId}/groups/{groupKey}/forum/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

The key of the group

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

/repo/courses/{courseId}/groups/{groupKey}/forum/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

The key of the group

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

/repo/courses/{courseId}/groups/{groupKey}/forum/posts/{messageKey}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

The key of the group

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

/repo/courses/{courseId}/groups/{groupKey}/forum/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

The key of the group

messageKey

long

Methods

GET

Retrieves the attachments of the message

available response representations:

PUT

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

/repo/courses/{courseId}/groups/{groupKey}/forum/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

The key of the group

filename

string

The name of the attachment

messageKey

long

The identity key of the user being searched

Methods

GET

Retrieves the attachment of the message

available response representations:

/repo/courses/{courseId}/groups/{groupKey}/folder

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

/repo/courses/{courseId}/groups/{groupKey}/folder/{path:.*}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

path

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/repo/courses/{courseId}/groups/{groupKey}/folder/version

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

courseId

long

groupKey

long

Methods

GET

available response representations:

/users/{identityKey}/forums

Description:

Initial Date: 6 déc. 2011

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

Methods

GET

Retrieves a list of forums on a user base. All forums of groups where the user is participant/tutor + all forums in course where the user is a participant (owner, tutor or participant)

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}

Description:
Web service to manage a forum.

Initial Date: 20 apr. 2010

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

Methods

GET

Retrieves the forum.

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/posts/{messageKey}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

messageKey

long

Methods

GET

Retrieves the attachments of the message

available response representations:

PUT

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

/users/{identityKey}/forums/course/{courseKey}/{courseNodeId}/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

filename

string

The name of the attachment

messageKey

long

The identity key of the user being searched

Methods

GET

Retrieves the attachment of the message

available response representations:

/users/{identityKey}/forums/group/{groupKey}

Description:
Web service to manage a forum.

Initial Date: 20 apr. 2010

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

Methods

GET

Retrieves the forum.

available response representations:

/users/{identityKey}/forums/group/{groupKey}/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

/users/{identityKey}/forums/group/{groupKey}/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

/users/{identityKey}/forums/group/{groupKey}/posts/{messageKey}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

/users/{identityKey}/forums/group/{groupKey}/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

messageKey

long

Methods

GET

Retrieves the attachments of the message

available response representations:

PUT

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

/users/{identityKey}/forums/group/{groupKey}/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

filename

string

The name of the attachment

messageKey

long

The identity key of the user being searched

Methods

GET

Retrieves the attachment of the message

available response representations:

/repo/courses/{courseId}/elements/contact?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&coaches&participants&groups&areas&to&defaultSubject&defaultBody

resource-wide template parameters
parameter value description

courseId

long

Methods

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

coaches

boolean

Default: false

participants

boolean

Default: false

groups

string

areas

string

to

string

defaultSubject

string

defaultBody

string

available response representations:

POST

acceptable request representations:

available response representations:

/repo/entries?start&limit

Description:
This handles the repository entries

Initial Date: 19.05.2009

Methods

GET

List all entries in the OLAT repository

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

available response representations:

GET

List all entries in the OLAT repository

available response representations:

PUT

Import a resource in the repository

acceptable request representations:

available response representations:

/repo/entries/version

Methods

GET

The version number of this web service

available response representations:

/repo/entries/search?type&author&name&myentries

Methods

GET

Search for repository entries, possible search attributes are name, author and type

request query parameters
parameter value description

type

string

Filter by the file resource type of the repository entry

author

string

Default: *

Filter by the author's username

name

string

Default: *

Filter by name of repository entry

myentries

boolean

Default: false

Only search entries the requester owns

available response representations:

/repo/entries/{repoEntryKey}

Description:
Repository entry resource

Initial Date: 19.05.2009

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

DELETE

Delete a course by id

available response representations:

GET

get a resource in the repository

available response representations:

POST

Replace a resource in the repository and update its display name. The implementation is limited to CP.

acceptable request representations:

available response representations:

/repo/entries/{repoEntryKey}/file

resource-wide template parameters
parameter value description

repoEntryKey

string

repoEntryKey

string

Methods

GET

Download the export zip file of a repository entry.

available response representations:

/repo/courses?start&limit

Description:
This web service handles the courses.

Initial Date: 27 apr. 2010

Methods

GET

Get all courses viewable by the authenticated user

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

available response representations:

PUT

Creates an empty course, or a copy from a course if the parameter copyFrom is set.

request query parameters
parameter value description

shortTitle

string

The short title

title

string

The title

sharedFolderSoftKey

string

The repository entry key of a shared folder (optional)

copyFrom

long

The cours key to make a copy from (optional)

available response representations:

/repo/courses/version

Methods

GET

The version of the Course Web Service

available response representations:

/contacts?start&limit

Description:

Initial Date: 21 oct. 2011

Methods

GET

Retrieve the contacts of the logged in identity.

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

available response representations:

/repo/courses/{courseId}/elements/forum

Description:
REST API implementation for forum course node

Initial Date: 20.12.2010

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

Retrieves metadata of the published course node

available response representations:

POST

This attaches a Forum Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

acceptable request representations:

available response representations:

PUT

This attaches a Forum Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

moderatorExpertRules

string

posterExpertRules

string

readerExpertRules

string

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

The node's id

courseId

long

The course resourceable's id

Methods

GET

Retrieves metadata of the published course node

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/thread?title&body&identityName&sticky

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

The id of the course node.

courseId

long

The id of the course.

Methods

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

identityName

string

The author identity name (optional)

sticky

boolean

Creates sticky thread.

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/message?parentMessageId&title&body&identityName

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

The id of the course node.

courseId

long

The id of the course.

Methods

PUT

Creates a new forum message in the forum of the course node

request query parameters
parameter value description

parentMessageId

long

The id of the parent message.

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

identityName

string

The author identity name (optional)

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum

Description:
Web service to manage a forum.

Initial Date: 20 apr. 2010

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

GET

Retrieves the forum.

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/posts/{messageKey}

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

messageKey

long

Methods

GET

Retrieves the attachments of the message

available response representations:

PUT

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/forum/{nodeId}/forum/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

filename

string

The name of the attachment

messageKey

long

The identity key of the user being searched

Methods

GET

Retrieves the attachment of the message

available response representations:

/repo/courses/{courseId}/elements/folder

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

available response representations:

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

downloadExpertRules

string

uploadExpertRules

string

available response representations:

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/folder/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

courseId

long

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/folder/{nodeId}/files

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/folder/{nodeId}/files/{path:.*}

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

path

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/repo/courses/{courseId}/elements/folder/{nodeId}/files/version

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

GET

available response representations:

/repo/courses/infos?start&limit

Description:

Initial Date: 7 févr. 2012

Methods

GET

Get courses informations viewable by the authenticated user

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

available response representations:

/users/{identityKey}/folders

Description:

Initial Date: 16 déc. 2011

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

Methods

GET

Retrieves a list of folders on a user base. All folders of groups where the user is participant/tutor + all folders in course where the user is a participant (owner, tutor or participant)

available response representations:

/users/{identityKey}/folders/personal

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

identityKey

long

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

/users/{identityKey}/folders/personal/{path:.*}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

identityKey

long

path

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/users/{identityKey}/folders/personal/version

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

identityKey

long

Methods

GET

available response representations:

/users/{identityKey}/folders/group/{groupKey}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

/users/{identityKey}/folders/group/{groupKey}/{path:.*}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

path

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/users/{identityKey}/folders/group/{groupKey}/version

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

groupKey

long

Methods

GET

available response representations:

/users/{identityKey}/folders/course/{courseKey}/{courseNodeId}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

/users/{identityKey}/folders/course/{courseKey}/{courseNodeId}/{path:.*}

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

path

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/users/{identityKey}/folders/course/{courseKey}/{courseNodeId}/version

resource-wide template parameters
parameter value description

identityKey

long

The key of the user (IdentityImpl)

courseKey

long

courseNodeId

string

Methods

GET

available response representations:

/catalog

Description:
A web service for the catalog

Initial Date: 5 may 2010

Methods

GET

Returns the list of root catalog entries.

available response representations:

/catalog/{path:.*}/owners/{identityKey}

resource-wide template parameters
parameter value description

path

string

The path

identityKey

long

The id of the user

Methods

GET

Retrieves data of an owner of the local sub tree

available response representations:

PUT

Add an owner of the local sub tree

available response representations:

DELETE

Remove an owner of the local sub tree

available response representations:

/catalog/version

Methods

GET

Retrieves the version of the Catalog Web Service.

available response representations:

/catalog/{path:.*}/children?start&limit

resource-wide template parameters
parameter value description

path

string

The path

Methods

GET

Returns a list of catalog entries.

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

available response representations:

/catalog/{path:.*}

resource-wide template parameters
parameter value description

path

string

The path

Methods

GET

Returns the metadata of the catalog entry.

available response representations:

PUT

Adds a catalog entry under the path specified in the URL.

request query parameters
parameter value description

name

string

The name

description

string

The description

type

int

The type (leaf or node)

repoEntryKey

long

The id of the repository entry

available response representations:

PUT

Adds a catalog entry under the path specified in the URL.

acceptable request representations:

available response representations:

POST

Updates the catalog entry under the path specified in the URL.

acceptable request representations:

available response representations:

POST

Updates the catalog entry with the path specified in the URL.

request query parameters
parameter value description

newParentKey

long

acceptable request representations:

available response representations:

POST

Updates the catalog entry with the path specified in the URL.

request query parameters
parameter value description

name

string

description

string

newParentKey

long

available response representations:

DELETE

Deletes the catalog entry with the path specified in the URL.

available response representations:

/catalog/{path:.*}/owners

resource-wide template parameters
parameter value description

path

string

The path

Methods

GET

Get the owners of the local sub tree

available response representations:

/users

This web service handles functionalities related to User.

Methods

PUT

Creates and persists a new user entity

acceptable request representations:

available response representations:

GET

Search users and return them in a simple form (without user properties). User properties can be added two the query parameters. If the authUsername and the authProvider are set, the search is made only with these two parameters because they are sufficient to return a single user.

request query parameters
parameter value description

login

string

The login (search with like)

authProvider

string

An authentication provider (optional)

authUsername

string

An specific username from the authentication provider

available response representations:

/users/{identityKey}

resource-wide template parameters
parameter value description

identityKey

long

The user key identifier of the user being searched

Methods

DELETE

Delete an user from the system

available response representations:

GET

Retrieves an user given its unique key identifier

request query parameters
parameter value description

withPortrait

boolean

Default: false

If true return the portrait as Base64 (default false)

available response representations:

/users/version

Methods

GET

The version of the User Web Service

available response representations:

/users/new

Methods

POST

Fallback method for browser

acceptable request representations:

available response representations:

/users/{identityKey}/delete

resource-wide template parameters
parameter value description

identityKey

long

The user key identifier

Methods

POST

Fallback method for browsers

available response representations:

/users/{identityKey}/portrait

resource-wide template parameters
parameter value description

identityKey

long

The identity key identifier of the user being searched

Methods

GET

Retrieves the portrait of an user

available response representations:

POST

Upload the portrait of an user

acceptable request representations:

available response representations:

DELETE

Deletes the portrait of an user

available response representations:

/users/{identityKey}/groups?start&limit

Description:

Initial Date: 18 oct. 2011

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

Return all groups of a user

request query parameters
parameter value description

start

int

Default: 0

The first result

limit

int

Default: 25

The maximum results

available response representations:

/users/{identityKey}/groups/infos?start&limit

resource-wide template parameters
parameter value description

identityKey

long

Methods

GET

Return all groups with information of a user. Paging is mandatory!

request query parameters
parameter value description

start

int

Default: 0

The first result

limit

int

Default: 25

The maximum results

available response representations:

/repo/forums

Description:
Web service to manage forums.

Initial Date: 26 aug. 2010

Methods

/repo/forums/version

Methods

GET

The version of the Forum Web Service

available response representations:

/repo/forums/{forumKey}

Description:
Web service to manage a forum.

Initial Date: 20 apr. 2010

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

Methods

GET

Retrieves the forum.

available response representations:

/repo/forums/{forumKey}/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

/repo/forums/{forumKey}/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

/repo/forums/{forumKey}/posts/{messageKey}

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

/repo/forums/{forumKey}/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

messageKey

long

Methods

GET

Retrieves the attachments of the message

available response representations:

PUT

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

/repo/forums/{forumKey}/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

forumKey

long

The key of the forum

filename

string

The name of the attachment

messageKey

long

The identity key of the user being searched

Methods

GET

Retrieves the attachment of the message

available response representations:

/ping

Description:
Ping to test the presence of the REST Api

Initial Date: 7 apr. 2010

Methods

GET

Return a string

available response representations:

/ping/version

Methods

GET

The version of the Ping Web Service

available response representations:

/ping/{name}

resource-wide template parameters
parameter value description

name

string

Methods

POST

Return a string

available response representations:

/users/{username}/auth

This web service handles functionalities related to authentication credentials of users.

resource-wide template parameters
parameter value description

username

string

The username of the user to retrieve authentication

Methods

PUT

Creates and persists an authentication

acceptable request representations:

available response representations:

GET

Returns all user authentications

available response representations:

/users/{username}/auth/{authKey}

resource-wide template parameters
parameter value description

username

string

The username of the user to retrieve authentication

username

string

The username of the user

authKey

long

The authentication key identifier

Methods

DELETE

Deletes an authentication from the system

available response representations:

/users/{username}/auth/version

resource-wide template parameters
parameter value description

username

string

The username of the user to retrieve authentication

Methods

GET

The version of the User Authentication Web Service

available response representations:

/users/{username}/auth/new

resource-wide template parameters
parameter value description

username

string

The username of the user to retrieve authentication

username

string

The username of the user

Methods

POST

Fallback method for browsers

acceptable request representations:

available response representations:

/users/{username}/auth/{authKey}/delete

resource-wide template parameters
parameter value description

username

string

The username of the user to retrieve authentication

username

string

The username of the user

authKey

long

The authentication key identifier

Methods

POST

Fallback method for browsers

available response representations:

/groups

Description:
This handles the learning groups.

Initial Date: 23 mar. 2010

Methods

GET

Return the list of all groups if you have group manager permission, or all learning group that you particip with or owne.

available response representations:

/groups/version

Methods

GET

Retrieves the version of the Group Web Service.

available response representations:

/groups/{groupKey}

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

Methods

GET

Return the group specified by the key of the group.

available response representations:

POST

Updates a group.

acceptable request representations:

available response representations:

DELETE

Deletes the business group specified by the groupKey.

available response representations:

/groups/{groupKey}/infos

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

Methods

GET

Returns the informations of the group specified by the groupKey.

available response representations:

/groups/{groupKey}/owners

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

Methods

GET

Returns the list of owners of the group specified by the groupKey.

available response representations:

/groups/{groupKey}/participants

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

Methods

GET

Returns the list of participants of the group specified by the groupKey.

available response representations:

/groups/{groupKey}/owners/{identityKey}

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

identityKey

long

The user's id

Methods

PUT

Adds an owner to the group.

available response representations:

DELETE

Removes the owner from the group.

available response representations:

/groups/{groupKey}/owners/{identityKey}/new

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

identityKey

long

The user's id

Methods

POST

Fallback method for browser.

available response representations:

/groups/{groupKey}/owners/{identityKey}/delete

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

identityKey

long

The user's id

Methods

POST

Fallback method for browser.

available response representations:

/groups/{groupKey}/participants/{identityKey}

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

identityKey

long

The id of the user

Methods

PUT

Adds a participant to the group.

available response representations:

DELETE

Removes a participant from the group.

available response representations:

/groups/{groupKey}/participants/{identityKey}/new

resource-wide template parameters
parameter value description

groupKey

long

The id of the group

identityKey

long

The user's id

Methods

POST

Fallback method for browser.

available response representations:

/groups/{groupKey}/participants/{identityKey}/delete

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

identityKey

long

The id of the user

Methods

POST

Fallback method for browser.

available response representations:

/groups/{groupKey}/forum

Description:
Web service to manage a forum.

Initial Date: 20 apr. 2010

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

Methods

GET

Retrieves the forum.

available response representations:

/groups/{groupKey}/forum/threads?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

Methods

GET

Retrieves the threads in the forum

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name,creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

PUT

Creates a new thread in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

POST

Creates a new thread in the forum of the course node

acceptable request representations:

available response representations:

/groups/{groupKey}/forum/posts/{threadKey}?start&limit&orderBy&asc

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

threadKey

long

The key of the thread

Methods

GET

Retrieves the messages in the thread

request query parameters
parameter value description

start

int

Default: 0

limit

int

Default: 25

orderBy

string

Default: creationDate

(value name, creationDate)

asc

boolean

Default: true

(value true/false)

available response representations:

/groups/{groupKey}/forum/posts/{messageKey}

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

messageKey

long

The id of the reply message

Methods

POST

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

PUT

Creates a new reply in the forum of the course node

request query parameters
parameter value description

title

string

The title for the first post in the thread

body

string

The body for the first post in the thread

authorKey

long

The author user key (optional)

available response representations:

PUT

Creates a new reply in the forum of the course node

acceptable request representations:

available response representations:

/groups/{groupKey}/forum/posts/{messageKey}/attachments

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

messageKey

long

Methods

GET

Retrieves the attachments of the message

available response representations:

PUT

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

POST

Upload the attachment of a message

acceptable request representations:

available response representations:

/groups/{groupKey}/forum/posts/{messageKey}/attachments/{filename}

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

filename

string

The name of the attachment

messageKey

long

The identity key of the user being searched

Methods

GET

Retrieves the attachment of the message

available response representations:

/groups/{groupKey}/folder

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

/groups/{groupKey}/folder/{path:.*}

resource-wide template parameters
parameter value description

groupKey

long

path

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

POST

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

available response representations:

DELETE

available response representations:

/groups/{groupKey}/folder/version

resource-wide template parameters
parameter value description

groupKey

long

Methods

GET

available response representations:

/groups/{groupKey}/wiki

resource-wide template parameters
parameter value description

groupKey

long

The key of the group

Methods

GET

available response representations:

/repo/courses/{courseId}/assessments

Description:
Retrieve and import course assessments

Initial Date: 7 apr. 2010

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

GET

Returns the results of the course.

available response representations:

/repo/courses/{courseId}/assessments/version

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

GET

Retireves the version of the Course Assessment Web Service.

available response representations:

/repo/courses/{courseId}/assessments/users/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

identityKey

long

The id of the user

courseId

long

The course resourceable's id

Methods

GET

Returns the results of the course.

available response representations:

/repo/courses/{courseId}/assessments/{nodeId}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

nodeId

string

The id of the course building block

courseId

long

The resourceable id of the course

Methods

GET

Exports results for an assessable course node for all students.

available response representations:

POST

Imports results for an assessable course node for the authenticated student.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/assessments/{nodeId}/users/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

nodeId

long

The ident of the course building block

identityKey

long

The id of the user

courseId

long

The course resourceable's id

Methods

GET

Returns the results of a student at a specific assessable node

available response representations:

/api

Description:
Service for general informations on the OLAT REST Api.

Initial Date: 14 apr. 2010

Methods

/api/version

Methods

GET

Version number of the whole REST API of OLAT.

available response representations:

/api/doc

Methods

GET

available response representations:

/api/doc/{filename}

resource-wide template parameters
parameter value description

filename

string

Methods

GET

Returns images for the documentation of OLAT.

available response representations:

/api/{filename}

resource-wide template parameters
parameter value description

filename

string

Methods

GET

Returns images for the documentation of OLAT.

available response representations:

/api/copyright

Methods

GET

Returns the copyright of OLAT.

available response representations:

GET

Returns the copyright of OLAT.

available response representations:

/system/log

Description:
This web service returns logFiles

Initial Date: 23.12.2011

Methods

GET

available response representations:

/system/log/version

Methods

GET

The version of the Log Web Service

available response representations:

/system/log/{date}

resource-wide template parameters
parameter value description

date

string

Methods

GET

available response representations:

/notifications?date&type

Description:

REST API for notifications

Initial Date: 25 aug 2010

Methods

GET

Retrieves the notification of the logged in user.

request query parameters
parameter value description

date

string

The date (optional)

type

string

The type of notifications (User, Forum...) (optional)

available response representations:

/repo/courses/{courseId}/elements/enrollment?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&groups&cancelEnabled

resource-wide template parameters
parameter value description

courseId

long

Methods

PUT

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

groups

string

cancelEnabled

boolean

Default: false

available response representations:

POST

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/enrollment/{nodeId}/groups

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

courseId

long

Methods

GET

available response representations:

/repo/courses/{courseId}/elements

This interface provides course building capabilities from our REST API.

Initial Date: Feb 8, 2010 Time: 3:45:50 PM

Methods

/repo/courses/{courseId}/elements/version

Methods

GET

The version of the Course Elements Web Service

available response representations:

/repo/courses/{courseId}/elements/{nodeId}

resource-wide template parameters
parameter value description

nodeId

string

The node's id

courseId

long

The course resourceable's id

Methods

GET

Retrieves metadata of the course node

available response representations:

/repo/courses/{courseId}/elements/structure/{nodeId}

resource-wide template parameters
parameter value description

nodeId

string

The node's id of this structure

courseId

long

The course resourceable's id

Methods

POST

This updates a Structure Element onto a given course.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/structure

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

This attaches a Structure Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

acceptable request representations:

available response representations:

PUT

This attaches a Structure Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

displayType

string

Default: toc

available response representations:

/repo/courses/{courseId}/elements/singlepage/{nodeId}?shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

POST

This updates a Single Page Element onto a given course.

request query parameters
parameter value description

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/singlepage

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

POST

This attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

acceptable request representations:

available response representations:

POST

This attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

acceptable request representations:

available response representations:

PUT

This attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this single page

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

acceptable request representations:

available response representations:

PUT

This attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this single page

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

filename

string

The single page file name

path

string

available response representations:

/repo/courses/{courseId}/elements/task/{nodeId}

resource-wide template parameters
parameter value description

nodeId

string

The node's id of this task

courseId

long

The course resourceable id

Methods

POST

This updates a Task Element onto a given course.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/task

resource-wide template parameters
parameter value description

courseId

long

The course resourceable id

Methods

POST

This attaches a Task Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

acceptable request representations:

available response representations:

PUT

This attaches a Task Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this task

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

text

string

The task node text

points

float

The task node's possible points

available response representations:

/repo/courses/{courseId}/elements/test/{nodeId}

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

POST

This updates a Test Element onto a given course.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/test

resource-wide template parameters
parameter value description

courseId

long

The course resourceable id

Methods

POST

This attaches a Test Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

acceptable request representations:

available response representations:

PUT

This attaches a Test Element onto a given course. The element will be inserted underneath the supplied parentNodeId.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this test

position

int

The test node's id which is retorned in the response of the import test resource

shortTitle

string

Default: undefined

The node's position relative to its sibling nodes (optional)

longTitle

string

Default: undefined

The node short title

objectives

string

Default: undefined

The node long title

visibilityExpertRules

string

The node learning objectives

accessExpertRules

string

The rules to view the node (optional)

testResourceableId

long

The rules to access the node (optional)

available response representations:

/repo/courses/{courseId}/elements/assessment/{nodeId}

resource-wide template parameters
parameter value description

nodeId

string

The node's id of this assessment

courseId

long

The course resourceable's id

Methods

POST

Updates an assessment building block.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/assessment

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

POST

Attaches an assessment building block.

acceptable request representations:

available response representations:

PUT

Attaches an assessment building block.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this assessment

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

available response representations:

/repo/courses/{courseId}/elements/wiki/{nodeId}

resource-wide template parameters
parameter value description

nodeId

string

The node's id which of this wiki

courseId

long

The course resourceable's id

Methods

POST

Attaches an wiki building block.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/wiki?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&wikiResourceableId

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

Attaches an wiki building block.

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

wikiResourceableId

long

available response representations:

PUT

Attaches an wiki building block.

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

wikiResourceableId

long

available response representations:

/repo/courses/{courseId}/elements/blog/{nodeId}

resource-wide template parameters
parameter value description

nodeId

string

The node's id of this blog

courseId

long

The course resourceable's id

Methods

POST

Update an blog building block.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/blog?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&repoEntry

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

POST

Attaches an blog building block.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this assessment

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

repoEntry

long

The softkey of the blog resourceable (optional)

available response representations:

PUT

Attaches an blog building block.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this assessment

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

repoEntry

long

The softkey of the blog resourceable (optional)

available response representations:

/repo/courses/{courseId}/elements/survey/{nodeId}

resource-wide template parameters
parameter value description

nodeId

string

The node's id which will be the parent of this assessment

courseId

long

The course resourceable's id

Methods

POST

Attaches an survey building block.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/survey?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&surveyResourceableId

resource-wide template parameters
parameter value description

courseId

long

Methods

POST

Attaches an survey building block.

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

The node's position relative to its sibling nodes (optional)

longTitle

string

Default: undefined

The node short title

objectives

string

Default: undefined

The node long title

visibilityExpertRules

string

The node learning objectives

accessExpertRules

string

The rules to view the node (optional)

surveyResourceableId

long

The rules to access the node (optional)

available response representations:

PUT

Attaches an survey building block.

request query parameters
parameter value description

parentNodeId

string

position

int

shortTitle

string

Default: undefined

longTitle

string

Default: undefined

objectives

string

Default: undefined

visibilityExpertRules

string

accessExpertRules

string

surveyResourceableId

long

available response representations:

/repo/courses/{courseId}/elements/externalpage/{nodeId}

resource-wide template parameters
parameter value description

parentNodeId

string

The node's id of this external page

courseId

long

The course resourceable's id

Methods

POST

Update an external page building block.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/externalpage?parentNodeId&position&shortTitle&longTitle&objectives&visibilityExpertRules&accessExpertRules&url

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

POST

Attaches an external page building block.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this assessment

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

url

string

The URL of the external page

available response representations:

PUT

Attaches an external page building block.

request query parameters
parameter value description

parentNodeId

string

The node's id which will be the parent of this assessment

position

int

The node's position relative to its sibling nodes (optional)

shortTitle

string

Default: undefined

The node short title

longTitle

string

Default: undefined

The node long title

objectives

string

Default: undefined

The node learning objectives

visibilityExpertRules

string

The rules to view the node (optional)

accessExpertRules

string

The rules to access the node (optional)

url

string

The URL of the external page

available response representations:

/repo/courses/{courseId}/elements/task/{nodeId}/file

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

POST

This attaches a Task file onto a given task element.

acceptable request representations:

available response representations:

PUT

This attaches a Task file onto a given task element.

acceptable request representations:

available response representations:

/repo/courses/{courseId}/elements/task/{nodeId}/configuration?enableAssignment&taskAssignmentType&taskAssignmentText&enableTaskPreview&enableTaskDeselect&onlyOneUserPerTask&enableDropbox&enableDropboxConfirmationMail&dropboxConfirmationText&enableReturnbox&enableScoring&grantScoring&scoreMin&scoreMax&grantPassing&scorePassingThreshold&enableCommentField&commentForUser&commentForCoaches&enableSolution&accessExpertRuleTask&accessExpertRuleDropbox&accessExpertRuleReturnbox&accessExpertRuleScoring&accessExpertRuleSolution

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

POST

This attaches the run-time configuration onto a given task element.

request query parameters
parameter value description

enableAssignment

boolean

taskAssignmentType

string

taskAssignmentText

string

enableTaskPreview

boolean

enableTaskDeselect

boolean

onlyOneUserPerTask

boolean

enableDropbox

boolean

enableDropboxConfirmationMail

boolean

dropboxConfirmationText

string

enableReturnbox

boolean

enableScoring

boolean

grantScoring

boolean

scoreMin

float

scoreMax

float

grantPassing

boolean

scorePassingThreshold

float

enableCommentField

boolean

commentForUser

string

commentForCoaches

string

enableSolution

boolean

accessExpertRuleTask

string

accessExpertRuleDropbox

string

accessExpertRuleReturnbox

string

accessExpertRuleScoring

string

accessExpertRuleSolution

string

available response representations:

PUT

This attaches the run-time configuration onto a given task element.

request query parameters
parameter value description

enableAssignment

boolean

taskAssignmentType

string

taskAssignmentText

string

enableTaskPreview

boolean

enableTaskDeselect

boolean

onlyOneUserPerTask

boolean

enableDropbox

boolean

enableDropboxConfirmationMail

boolean

dropboxConfirmationText

string

enableReturnbox

boolean

enableScoring

boolean

grantScoring

boolean

scoreMin

float

scoreMax

float

grantPassing

boolean

scorePassingThreshold

float

enableCommentField

boolean

commentForUser

string

commentForCoaches

string

enableSolution

boolean

accessExpertRuleTask

string

accessExpertRuleDropbox

string

accessExpertRuleReturnbox

string

accessExpertRuleScoring

string

accessExpertRuleSolution

string

available response representations:

GET

Retrieves configuration of the task course node

available response representations:

/repo/courses/{courseId}/elements/survey/{nodeId}/configuration?allowCancel&allowNavigation&allowSuspend&sequencePresentation&showNavigation&showQuestionTitle&showSectionsOnly

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

POST

This attaches the run-time configuration onto a given survey element.

request query parameters
parameter value description

allowCancel

boolean

Default: false

allowNavigation

boolean

Default: false

allowSuspend

boolean

Default: false

sequencePresentation

string

Default: itemPage

showNavigation

boolean

Default: true

showQuestionTitle

boolean

Default: true

showSectionsOnly

boolean

Default: false

available response representations:

PUT

This attaches the run-time configuration onto a given survey element.

request query parameters
parameter value description

allowCancel

boolean

Default: false

allowNavigation

boolean

Default: false

allowSuspend

boolean

Default: false

sequencePresentation

string

Default: itemPage

showNavigation

boolean

Default: true

showQuestionTitle

boolean

Default: true

showSectionsOnly

boolean

Default: false

available response representations:

GET

Retrieves configuration of the survey course node

available response representations:

/repo/courses/{courseId}/elements/test/{nodeId}/configuration?allowCancel&allowNavigation&allowSuspend&numAttempts&sequencePresentation&showNavigation&showQuestionTitle&showResultsAfterFinish&showResultsDependendOnDate&showResultsOnHomepage&showScoreInfo&showQuestionProgress&showScoreProgress&showSectionsOnly&summaryPresentation&startDate&endDate

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

POST

This attaches the run-time configuration onto a given test element.

request query parameters
parameter value description

allowCancel

boolean

Default: false

allowNavigation

boolean

Default: false

allowSuspend

boolean

Default: false

numAttempts

int

Default: 0

sequencePresentation

string

Default: itemPage

showNavigation

boolean

Default: true

showQuestionTitle

boolean

Default: true

showResultsAfterFinish

boolean

Default: true

showResultsDependendOnDate

boolean

Default: false

showResultsOnHomepage

boolean

Default: false

showScoreInfo

boolean

Default: true

showQuestionProgress

boolean

Default: true

showScoreProgress

boolean

Default: true

showSectionsOnly

boolean

Default: false

summaryPresentation

string

Default: summaryCompact

startDate

long

endDate

long

available response representations:

PUT

This attaches the run-time configuration onto a given test element.

request query parameters
parameter value description

allowCancel

boolean

Default: false

allowNavigation

boolean

Default: false

allowSuspend

boolean

Default: false

numAttempts

int

Default: 0

sequencePresentation

string

Default: itemPage

showNavigation

boolean

Default: true

showQuestionTitle

boolean

Default: true

showResultsAfterFinish

boolean

Default: true

showResultsDependendOnDate

boolean

Default: false

showResultsOnHomepage

boolean

Default: false

showScoreInfo

boolean

Default: true

showQuestionProgress

boolean

Default: true

showScoreProgress

boolean

Default: true

showSectionsOnly

boolean

Default: false

summaryPresentation

string

Default: summaryCompact

startDate

long

endDate

long

available response representations:

GET

Retrieves configuration of the test course node

available response representations:

/i18n

Description:
This handles translations from the i18n module of OLAT.

Initial Date: 14 apr. 2010

Methods

/i18n/version

Methods

GET

Retrieves the version of the i18n Web Service.

available response representations:

/i18n/{package}/{key}?locale

resource-wide template parameters
parameter value description

package

string

The name of the package

key

string

The key to translate

Methods

GET

Return the translation of the key. If the "locale" parameter is not specified, the method try to use the "locale" of the user and if it hasn't, take the default locale.

request query parameters
parameter value description

locale

string

The locale (optional)

available response representations:

/repo/courses/{courseId}/resourcefolders

Description:
This will handle the resources folders in the course: the course storage folder and the shared folder. The course folder has a read-write access but the shared folder can only be read.

Initial Date: 26 apr. 2010

Methods

/repo/courses/{courseId}/resourcefolders/version

Methods

GET

The version of the resources folders Web Service

available response representations:

/repo/courses/{courseId}/resourcefolders/sharedfolder

resource-wide template parameters
parameter value description

courseId

long

The course resourceable's id

Methods

GET

This retrieves the files in the shared folder

available response representations:

/repo/courses/{courseId}/resourcefolders/sharedfolder/{path:.*}

resource-wide template parameters
parameter value description

path

string

courseId

long

The course resourceable's id

Methods

GET

This retrieves the files in the shared folder

available response representations:

/repo/courses/{courseId}/resourcefolders/coursefolder

resource-wide template parameters
parameter value description

courseId

long

Methods

GET

This retrieves the files in the course folder

available response representations:

POST

This attaches the uploaded file(s) to the supplied folder id.

acceptable request representations:

available response representations:

PUT

This attaches the uploaded file(s) to the supplied folder id at the root level

acceptable request representations:

available response representations:

/repo/courses/{courseId}/resourcefolders/coursefolder/{path:.*}

resource-wide template parameters
parameter value description

path

string

courseId

long

Methods

GET

This retrieves the files in the course folder

available response representations:

POST

This attaches the uploaded file(s) to the supplied folder id.

acceptable request representations:

available response representations:

PUT

This attaches the uploaded file(s) to the supplied folder id at the root level

acceptable request representations:

available response representations:

/auth

Description:
Authenticate against OLAT Provider

Initial Date: 7 apr. 2010

Methods

/auth/version

Methods

GET

Retrieves the version of the User Authentication Web Service

available response representations:

/auth/{username}?password

resource-wide template parameters
parameter value description

username

string

The username

Methods

GET

Authenticates against OLAT Provider and provides a security token if authentication is successful. The security token is returned as a header named X-OLAT-TOKEN. Given that the password is sent in clear text and not encrypted, it is not advisable to use this service over a none secure connection (https).

request query parameters
parameter value description

password

string

The password (the password is in clear text, not encrypted)

available response representations:

Representations

Status Code 404

The course not found

Status Code 200 - application/xml, application/json (ns3:courseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
    <key>777</key>
    <title>Demo course</title>
    <displayName>Demo course</displayName>
</courseVO>

The metadatas of the created course

XML Schema

Source:

Status Code 404

The course not found

Status Code 200

The metadatas of the created course

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 404

The course not found

Status Code 200 - application/xml, application/json (ns3:courseConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
    <sharedFolderSoftKey>head_1_olat_43985684395</sharedFolderSoftKey>
</courseVO>

The configuration of the course

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course not found

Status Code 200 - application/xml, application/json (ns3:courseConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
    <sharedFolderSoftKey>head_1_olat_43985684395</sharedFolderSoftKey>
</courseVO>

The metadatas of the created course

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course not found

Status Code 200 - application/xml, application/json (ns3:userVO)

The array of authors

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course not found

Status Code 200 - application/xml, application/json (ns3:courseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
    <key>777</key>
    <title>Demo course</title>
    <displayName>Demo course</displayName>
</courseVO>

The metadatas of the created course

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course not found

Status Code 200 - application/zip

The course as a ZIP file

Status Code 401

Not authorized to export the course

Status Code 404

The course not found

Status Code 200 - application/xml

The run structure of the course

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course not found

Status Code 200 - application/xml

The editor tree model of the course

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course not found or the user is not an onwer or author of the course

Status Code 200 - application/xml, application/json (ns3:userVO)

The author

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or the user not found

Status Code 200

The user is an author and owner of the course

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or the user not found

Status Code 200

The user was successfully removed as owner of the course

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The context of the group not found

Status Code 200 - application/xml, application/json (ns3:groupVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups totalCount="0">
    <groups>
        <group>
            <key>123467</key>
            <description>My group description</description>
            <name>My group</name>
            <minParticipants>0</minParticipants>
            <maxParticipants>0</maxParticipants>
        </group>
    </groups>
</groups>

The list of all learning group of the course

XML Schema

Source:

application/xml

application/json

Status Code 200 - application/xml, application/json (ns3:groupVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
    <key>123467</key>
    <description>My group description</description>
    <name>My group</name>
    <minParticipants>0</minParticipants>
    <maxParticipants>0</maxParticipants>
</groupVO>

The persisted group

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 404

The business group cannot be found

Status Code 200 - application/xml, application/json (ns3:groupVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
    <key>123467</key>
    <description>My group description</description>
    <name>My group</name>
    <minParticipants>0</minParticipants>
    <maxParticipants>0</maxParticipants>
</groupVO>

This is the list of all groups in OLAT system

XML Schema

Source:

Status Code 404

The business group cannot be found

Status Code 200

The business group is deleted

Status Code 401

The roles of the authenticated user are not sufficient

*/*

Status Code 404

The business group cannot be found

Status Code 200 - application/xml, application/json (ns3:groupVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
    <key>123467</key>
    <description>My group description</description>
    <name>My group</name>
    <minParticipants>0</minParticipants>
    <maxParticipants>0</maxParticipants>
</groupVO>

The saved group

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

*/*

Status Code 200 - application/xml, application/json (ns3:groupVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
    <key>123467</key>
    <description>My group description</description>
    <name>My group</name>
    <minParticipants>0</minParticipants>
    <maxParticipants>0</maxParticipants>
</groupVO>

The persisted group

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The forum not found

Status Code 200 - application/xml, application/json (ns3:forumVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/xml

application/json

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The message not found

Status Code 200 - application/xml, application/json

The links to the attachments

application/xml

application/json

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

application/x-www-form-urlencoded

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

multipart/form-data

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

Status Code 404

The identity or the portrait not found

Status Code 200 - application/octet-stream

The portrait as image

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

multipart/form-data

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

multipart/form-data

application/json

application/xml

*/*

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/plain

Status Code 200 - application/xml, application/json (ns3:forumVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>

The forums

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The forum not found

Status Code 200 - application/xml, application/json (ns3:forumVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/xml

application/json

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The message not found

Status Code 200 - application/xml, application/json

The links to the attachments

application/xml

application/json

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

application/x-www-form-urlencoded

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

multipart/form-data

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

Status Code 404

The identity or the portrait not found

Status Code 200 - application/octet-stream

The portrait as image

Status Code 404

The forum not found

Status Code 200 - application/xml, application/json (ns3:forumVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/xml

application/json

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The message not found

Status Code 200 - application/xml, application/json

The links to the attachments

application/xml

application/json

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

application/x-www-form-urlencoded

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

multipart/form-data

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

Status Code 404

The identity or the portrait not found

Status Code 200 - application/octet-stream

The portrait as image

application/xml

application/json

application/x-www-form-urlencoded

application/xml

application/json

Status Code 200 - text/plain, text/html, application/xml, application/json (ns3:repositoryEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntries totalCount="1">
    <repositoryEntries>
        <repositoryEntrie>
            <key>479286</key>
            <softkey>internal_cp</softkey>
            <resourcename>fdhasl</resourcename>
            <displayname>CP-demo</displayname>
            <resourceableId>4368567</resourceableId>
            <resourceableTypeName>CourseModule</resourceableTypeName>
        </repositoryEntrie>
    </repositoryEntries>
</repositoryEntries>

List all entries in the repository

XML Schema

Source:

Status Code 200 - text/plain, text/html, application/xml, application/json (ns3:repositoryEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntries totalCount="1">
    <repositoryEntries>
        <repositoryEntrie>
            <key>479286</key>
            <softkey>internal_cp</softkey>
            <resourcename>fdhasl</resourcename>
            <displayname>CP-demo</displayname>
            <resourceableId>4368567</resourceableId>
            <resourceableTypeName>CourseModule</resourceableTypeName>
        </repositoryEntrie>
    </repositoryEntries>
</repositoryEntries>

List all entries in the repository

XML Schema

Source:

multipart/form-data

Status Code 200 - application/xml, application/json (ns3:repositoryEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
    <key>479286</key>
    <softkey>internal_cp</softkey>
    <resourcename>fdhasl</resourcename>
    <displayname>CP-demo</displayname>
    <resourceableId>4368567</resourceableId>
    <resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>

Import the resource and return the repository entry

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

text/plain

Status Code 200 - application/xml, application/json (ns3:repositoryEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
    <key>479286</key>
    <softkey>internal_cp</softkey>
    <resourcename>fdhasl</resourcename>
    <displayname>CP-demo</displayname>
    <resourceableId>4368567</resourceableId>
    <resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>

Search for repository entries

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course not found

Status Code 200

The metadatas of the created course

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The repository entry not found

Status Code 200 - application/xml, application/json (ns3:repositoryEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
    <key>479286</key>
    <softkey>internal_cp</softkey>
    <resourcename>fdhasl</resourcename>
    <displayname>CP-demo</displayname>
    <resourceableId>4368567</resourceableId>
    <resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>

Get the repository resource

XML Schema

Source:

multipart/form-data

Status Code 200 - application/xml, application/json (ns3:repositoryEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
    <key>479286</key>
    <softkey>internal_cp</softkey>
    <resourcename>fdhasl</resourcename>
    <displayname>CP-demo</displayname>
    <resourceableId>4368567</resourceableId>
    <resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>

Replace the resource and return the updated repository entry

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 409

The resource is locked

Status Code 404

The resource could not found

Status Code 200 - application/zip

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
    <key>479286</key>
    <softkey>internal_cp</softkey>
    <resourcename>fdhasl</resourcename>
    <displayname>CP-demo</displayname>
    <resourceableId>4368567</resourceableId>
    <resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>

Download the repository entry as export zip file

Status Code 406

Download of this resource is not possible

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - application/xml, application/json, application/json;pagingspec=1.0 (ns3:courseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courses totalCount="0">
    <courses>
        <course>
            <key>777</key>
            <title>Demo course</title>
            <displayName>Demo course</displayName>
        </course>
    </courses>
</courses>

List of visible courses

XML Schema

Source:

Status Code 200 - application/xml, application/json (ns3:courseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
    <key>777</key>
    <title>Demo course</title>
    <displayName>Demo course</displayName>
</courseVO>

The metadatas of the created course

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 200

The list of contacts

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:forumVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forums totalCount="1">
    <forums>
        <forums subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
    </forums>
</forums>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:forumVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The forum not found

Status Code 200 - application/xml, application/json (ns3:forumVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/xml

application/json

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The message not found

Status Code 200 - application/xml, application/json

The links to the attachments

application/xml

application/json

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

application/x-www-form-urlencoded

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

multipart/form-data

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

Status Code 404

The identity or the portrait not found

Status Code 200 - application/octet-stream

The portrait as image

application/xml

application/json

application/xml

application/json

application/x-www-form-urlencoded

application/xml

application/json

application/xml

application/json

application/x-www-form-urlencoded

application/xml

application/json

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

multipart/form-data

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

multipart/form-data

application/json

application/xml

*/*

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/plain

Status Code 200 - application/xml, application/json, application/json;pagingspec=1.0 (ns3:courseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courses totalCount="0">
    <courses>
        <course>
            <key>777</key>
            <title>Demo course</title>
            <displayName>Demo course</displayName>
        </course>
    </courses>
</courses>

List of visible courses

XML Schema

Source:

Status Code 200 - application/xml, application/json (ns3:folderVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<folders totalCount="1">
    <folders>
        <folder delete="false" list="false" read="false" write="false" subscribed="true" courseNodeId="438950850389" courseKey="375397" name="Course folder"/>
    </folders>
</folders>

The folders

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

multipart/form-data

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

multipart/form-data

application/json

application/xml

*/*

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/plain

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

multipart/form-data

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

multipart/form-data

application/json

application/xml

*/*

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/plain

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

multipart/form-data

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

multipart/form-data

application/json

application/xml

*/*

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/plain

Status Code 200 - application/xml, application/json (ns3:catalogEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntries totalCount="0">
    <catalogEntries>
        <catalogEntry>
            <key>478</key>
            <name>Category</name>
            <description>Description of the category</description>
            <type>0</type>
        </catalogEntry>
    </catalogEntries>
</catalogEntries>

The list of roots catalog entries

XML Schema

Source:

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:userVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
    <users>
        <user>
            <key>345</key>
            <login>john</login>
            <password></password>
            <firstName>John</firstName>
            <lastName>Smith</lastName>
            <email>john.smith@frentix.com</email>
            <properties>
                <property>
                    <name>telPrivate</name>
                    <value>238456782</value>
                </property>
                <property>
                    <name>telMobile</name>
                    <value>238456782</value>
                </property>
            </properties>
        </user>
    </users>
</users>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:userVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
    <users>
        <user>
            <key>345</key>
            <login>john</login>
            <password></password>
            <firstName>John</firstName>
            <lastName>Smith</lastName>
            <email>john.smith@frentix.com</email>
            <properties>
                <property>
                    <name>telPrivate</name>
                    <value>238456782</value>
                </property>
                <property>
                    <name>telMobile</name>
                    <value>238456782</value>
                </property>
            </properties>
        </user>
    </users>
</users>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:userVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
    <users>
        <user>
            <key>345</key>
            <login>john</login>
            <password></password>
            <firstName>John</firstName>
            <lastName>Smith</lastName>
            <email>john.smith@frentix.com</email>
            <properties>
                <property>
                    <name>telPrivate</name>
                    <value>238456782</value>
                </property>
                <property>
                    <name>telMobile</name>
                    <value>238456782</value>
                </property>
            </properties>
        </user>
    </users>
</users>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:catalogEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntries totalCount="0">
    <catalogEntries>
        <catalogEntry>
            <key>478</key>
            <name>Category</name>
            <description>Description of the category</description>
            <type>0</type>
        </catalogEntry>
    </catalogEntries>
</catalogEntries>

The list of catalog entries

XML Schema

Source:

Status Code 200 - application/xml, application/json (ns3:catalogEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
    <key>478</key>
    <name>Category</name>
    <description>Description of the category</description>
    <type>0</type>
</catalogEntryVO>

The catalog entry

XML Schema

Source:

Status Code 401

The path could not be resolved to a valid catalog entry

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:catalogEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
    <key>478</key>
    <name>Category</name>
    <description>Description of the category</description>
    <type>0</type>
</catalogEntryVO>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

application/xml

application/json

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:catalogEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
    <key>478</key>
    <name>Category</name>
    <description>Description of the category</description>
    <type>0</type>
</catalogEntryVO>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

application/x-www-form-urlencoded

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:catalogEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
    <key>478</key>
    <name>Category</name>
    <description>Description of the category</description>
    <type>0</type>
</catalogEntryVO>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

application/xml

application/json

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:catalogEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
    <key>478</key>
    <name>Category</name>
    <description>Description of the category</description>
    <type>0</type>
</catalogEntryVO>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:catalogEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
    <key>478</key>
    <name>Category</name>
    <description>Description of the category</description>
    <type>0</type>
</catalogEntryVO>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:catalogEntryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
    <key>478</key>
    <name>Category</name>
    <description>Description of the category</description>
    <type>0</type>
</catalogEntryVO>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

Status Code 404

The path could not be resolved to a valid catalog entry

Status Code 200 - application/xml, application/json (ns3:userVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
    <users>
        <user>
            <key>345</key>
            <login>john</login>
            <password></password>
            <firstName>John</firstName>
            <lastName>Smith</lastName>
            <email>john.smith@frentix.com</email>
            <properties>
                <property>
                    <name>telPrivate</name>
                    <value>238456782</value>
                </property>
                <property>
                    <name>telMobile</name>
                    <value>238456782</value>
                </property>
            </properties>
        </user>
    </users>
</users>

The catalog entry

XML Schema

Source:

Status Code 401

Not authorized

application/xml

application/json

Status Code 200 - application/xml, application/json

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userVO>
    <key>345</key>
    <login>john</login>
    <password></password>
    <firstName>John</firstName>
    <lastName>Smith</lastName>
    <email>john.smith@frentix.com</email>
    <properties>
        <property>
            <name>telPrivate</name>
            <value>238456782</value>
        </property>
        <property>
            <name>telMobile</name>
            <value>238456782</value>
        </property>
    </properties>
</userVO>

The persisted user

Status Code 406 - application/xml, application/json

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorVOes>
    <errorVO>
        <code>org.olat.restapi:error</code>
        <translation>Hello world, there is an error</translation>
    </errorVO>
</errorVOes>

The list of errors

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - application/xml, application/json (ns3:userVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
    <users>
        <user>
            <key>345</key>
            <login>john</login>
            <password></password>
            <firstName>John</firstName>
            <lastName>Smith</lastName>
            <email>john.smith@frentix.com</email>
            <properties>
                <property>
                    <name>telPrivate</name>
                    <value>238456782</value>
                </property>
                <property>
                    <name>telMobile</name>
                    <value>238456782</value>
                </property>
            </properties>
        </user>
    </users>
</users>

The list of all users in the OLAT system

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The identity not found

Status Code 200

The user is removed from the group

Status Code 401

The roles of the authenticated user are not sufficient

application/xml

application/json

Status Code 404

The identity not found

Status Code 200 - application/xml, application/json (ns3:userVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userVO>
    <key>345</key>
    <login>john</login>
    <password></password>
    <firstName>John</firstName>
    <lastName>Smith</lastName>
    <email>john.smith@frentix.com</email>
    <properties>
        <property>
            <name>telPrivate</name>
            <value>238456782</value>
        </property>
        <property>
            <name>telMobile</name>
            <value>238456782</value>
        </property>
    </properties>
</userVO>

The user

XML Schema

Source:

Status Code 406 - application/xml, application/json (ns3:errorVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorVOes>
    <errorVO>
        <code>org.olat.restapi:error</code>
        <translation>Hello world, there is an error</translation>
    </errorVO>
</errorVOes>

The list of validation errors

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The identity not found

Status Code 200 - application/xml, application/json

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userVO>
    <key>345</key>
    <login>john</login>
    <password></password>
    <firstName>John</firstName>
    <lastName>Smith</lastName>
    <email>john.smith@frentix.com</email>
    <properties>
        <property>
            <name>telPrivate</name>
            <value>238456782</value>
        </property>
        <property>
            <name>telMobile</name>
            <value>238456782</value>
        </property>
    </properties>
</userVO>

The user

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

application/xml

application/json

Status Code 200 - application/xml, application/json

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userVO>
    <key>345</key>
    <login>john</login>
    <password></password>
    <firstName>John</firstName>
    <lastName>Smith</lastName>
    <email>john.smith@frentix.com</email>
    <properties>
        <property>
            <name>telPrivate</name>
            <value>238456782</value>
        </property>
        <property>
            <name>telMobile</name>
            <value>238456782</value>
        </property>
    </properties>
</userVO>

The persisted user

Status Code 406 - application/xml, application/json

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorVOes>
    <errorVO>
        <code>org.olat.restapi:error</code>
        <translation>Hello world, there is an error</translation>
    </errorVO>
</errorVOes>

The list of errors

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The identity not found

Status Code 200

The user is removed from the group

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The identity or the portrait not found

Status Code 200 - application/octet-stream

The portrait as image

multipart/form-data

Status Code 404

The identity or the portrait not found

Status Code 200 - application/octet-stream

The portrait as image

Status Code 401

Not authorized

Status Code 200

The portrait deleted

Status Code 401

Not authorized

Status Code 404

The identity not found

Status Code 200 - application/xml, application/json (ns3:groupVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups totalCount="0">
    <groups>
        <group>
            <key>123467</key>
            <description>My group description</description>
            <name>My group</name>
            <minParticipants>0</minParticipants>
            <maxParticipants>0</maxParticipants>
        </group>
    </groups>
</groups>

The groups of the user

XML Schema

Source:

Status Code 200 - application/xml;pagingspec=1.0, application/json;pagingspec=1.0 (ns3:groupInfoVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups totalCount="0">
    <groups>
        <group>
            <key>123467</key>
            <description>My group description</description>
            <name>My group</name>
            <minParticipants>0</minParticipants>
            <maxParticipants>0</maxParticipants>
            <news>&lt;p&gt;Hello world&lt;/p&gt;</news>
            <forumKey>374589</forumKey>
            <hasWiki>false</hasWiki>
            <hasFolder>false</hasFolder>
        </group>
    </groups>
</groups>

The groups of the user

XML Schema

Source:

Status Code 406

The request hasn't paging information

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 404

The forum not found

Status Code 200 - application/xml, application/json (ns3:forumVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/xml

application/json

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The message not found

Status Code 200 - application/xml, application/json

The links to the attachments

application/xml

application/json

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

application/x-www-form-urlencoded

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

multipart/form-data

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

Status Code 404

The identity or the portrait not found

Status Code 200 - application/octet-stream

The portrait as image

Status Code 200 - text/plain

Example
Ping

Return a small string

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 200 - text/plain

Example
Ping

Return a small string

application/xml

application/json

Status Code 404

The identity not found

Status Code 200 - application/xml, application/json (ns3:authenticationVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<authenticationVO>
    <key>38759</key>
    <identityKey>345</identityKey>
    <provider>OLAT</provider>
    <authUsername>john</authUsername>
</authenticationVO>

The saved authentication

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The identity not found

Status Code 200 - application/xml, application/json (ns3:authenticationVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<authenticationVOes>
    <authenticationVO>
        <key>38759</key>
        <identityKey>345</identityKey>
        <provider>OLAT</provider>
        <authUsername>john</authUsername>
    </authenticationVO>
</authenticationVOes>

The list of all users in the OLAT system

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The identity or the authentication not found

Status Code 200

The authentication successfully deleted

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

application/xml

application/json

Status Code 404

The identity not found

Status Code 200 - application/xml, application/json (ns3:authenticationVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<authenticationVO>
    <key>38759</key>
    <identityKey>345</identityKey>
    <provider>OLAT</provider>
    <authUsername>john</authUsername>
</authenticationVO>

The saved authentication

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The identity or the authentication not found

Status Code 200

The authentication successfully deleted

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - application/xml, application/json (ns3:groupVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups totalCount="0">
    <groups>
        <group>
            <key>123467</key>
            <description>My group description</description>
            <name>My group</name>
            <minParticipants>0</minParticipants>
            <maxParticipants>0</maxParticipants>
        </group>
    </groups>
</groups>

This is the list of all groups in OLAT system

XML Schema

Source:

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 200 - application/xml, application/json (ns3:groupVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
    <key>123467</key>
    <description>My group description</description>
    <name>My group</name>
    <minParticipants>0</minParticipants>
    <maxParticipants>0</maxParticipants>
</groupVO>

A business group in the OLAT system

XML Schema

Source:

application/xml

application/json

Status Code 404

The business group cannot be found

Status Code 200 - application/xml, application/json (ns3:groupVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
    <key>123467</key>
    <description>My group description</description>
    <name>My group</name>
    <minParticipants>0</minParticipants>
    <maxParticipants>0</maxParticipants>
</groupVO>

The saved business group

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The business group cannot be found

Status Code 200

The business group is deleted

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The business group cannot be found

Status Code 200 - application/xml, application/json (ns3:groupInfoVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupInfoVO>
    <key>123467</key>
    <description>My group description</description>
    <name>My group</name>
    <minParticipants>0</minParticipants>
    <maxParticipants>0</maxParticipants>
    <news>&lt;p&gt;Hello world&lt;/p&gt;</news>
    <forumKey>374589</forumKey>
    <hasWiki>false</hasWiki>
    <hasFolder>false</hasFolder>
</groupInfoVO>

Participants of the business group

XML Schema

Source:

Status Code 404

The business group cannot be found

Status Code 200 - application/xml, application/json (ns3:userVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
    <users>
        <user>
            <key>345</key>
            <login>john</login>
            <password></password>
            <firstName>John</firstName>
            <lastName>Smith</lastName>
            <email>john.smith@frentix.com</email>
            <properties>
                <property>
                    <name>telPrivate</name>
                    <value>238456782</value>
                </property>
                <property>
                    <name>telMobile</name>
                    <value>238456782</value>
                </property>
            </properties>
        </user>
    </users>
</users>

Owners of the business group

XML Schema

Source:

Status Code 404

The business group cannot be found

Status Code 200 - application/xml, application/json (ns3:userVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
    <users>
        <user>
            <key>345</key>
            <login>john</login>
            <password></password>
            <firstName>John</firstName>
            <lastName>Smith</lastName>
            <email>john.smith@frentix.com</email>
            <properties>
                <property>
                    <name>telPrivate</name>
                    <value>238456782</value>
                </property>
                <property>
                    <name>telMobile</name>
                    <value>238456782</value>
                </property>
            </properties>
        </user>
    </users>
</users>

Participants of the business group

XML Schema

Source:

Status Code 404

The business group or the user cannot be found

Status Code 200

The user is added as owner of the group

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The business group or the user cannot be found

Status Code 200

The user is removed as owner from the group

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The business group or the user cannot be found

Status Code 200

The user is added as owner of the group

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The business group or the user cannot be found

Status Code 200

The user is removed as owner from the group

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The business group or the user cannot be found

Status Code 200

The user is added as participant of the group

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The business group or the user cannot be found

Status Code 200

The user is remove from the group as participant

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The business group or the user cannot be found

Status Code 200

The user is added as participant of the group

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The business group or the user cannot be found

Status Code 200

The user is remove from the group as participant

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The forum not found

Status Code 200 - application/xml, application/json (ns3:forumVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author, forum or message not found

Status Code 200 - application/xml, application/json (ns3:messageVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages totalCount="1">
    <messages>
        <message>
            <key>380</key>
            <authorKey>345</authorKey>
            <title>A message</title>
            <body>The content of the message</body>
        </message>
    </messages>
</messages>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/xml

application/json

Status Code 404

The author or message not found

Status Code 200 - application/xml, application/json (ns3:messageVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messageVO>
    <key>380</key>
    <authorKey>345</authorKey>
    <title>A message</title>
    <body>The content of the message</body>
</messageVO>

The root message of the thread

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The message not found

Status Code 200 - application/xml, application/json

The links to the attachments

application/xml

application/json

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

application/x-www-form-urlencoded

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

multipart/form-data

Status Code 404

The identity or the portrait not found

Status Code 200 - application/json, application/xml

Ok

Status Code 404

The identity or the portrait not found

Status Code 200 - application/octet-stream

The portrait as image

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

multipart/form-data

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/html

application/octet-stream

*/*

multipart/form-data

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

multipart/form-data

application/json

application/xml

*/*

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/plain

application/zip

application/octet-stream

Status Code 404

The course not found

Status Code 200 - application/xml, application/json (ns3:assessableResultsVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assessableResultsVOes>
    <assessableResultsVO>
        <identityKey>345</identityKey>
        <score>34.0</score>
        <passed>true</passed>
    </assessableResultsVO>
</assessableResultsVOes>

Array of results for the whole the course

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 404

The identity or the course not found

Status Code 200 - application/xml, application/json (ns3:assessableResultsVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assessableResultsVO>
    <identityKey>345</identityKey>
    <score>34.0</score>
    <passed>true</passed>
</assessableResultsVO>

The result of the course

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course not found

Status Code 200 - application/xml, application/json (ns3:assessableResultsVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assessableResultsVOes>
    <assessableResultsVO>
        <identityKey>345</identityKey>
        <score>34.0</score>
        <passed>true</passed>
    </assessableResultsVO>
</assessableResultsVOes>

Export all results of all user of the course

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/xml

application/json

Status Code 404

The identity not found

Status Code 200

Import successful

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The identity or the course not found

Status Code 200 - application/xml, application/json (ns3:assessableResultsVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assessableResultsVO>
    <identityKey>345</identityKey>
    <score>34.0</score>
    <passed>true</passed>
</assessableResultsVO>

The result of a user at a specific node

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - text/plain

Example
1.0

Return the version number

text/html

Status Code 200 - image/jpeg

Images for the documentation

Status Code 200 - image/jpeg

Images for the documentation

Status Code 200 - text/html, application/xhtml+xml

The copyright of the REST API.

Status Code 200 - text/plain

The copyright of the REST API.

text/plain

application/octet-stream

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

text/plain

application/octet-stream

Status Code 404

The identity not found

Status Code 200 - application/xml, application/json

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<subscriptionInfoVOes>
    <subscriptionInfoVO>
        <title>Infos</title>
        <items/>
    </subscriptionInfoVO>
</subscriptionInfoVOes>

The notifications

application/xml

application/json

application/x-www-form-urlencoded

application/xml

application/json

application/xml

application/json

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

multipart/form-data

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

multipart/form-data

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

the course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

multipart/form-data

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

multipart/form-data

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

the course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

the course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course, parentNode or test not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The test node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course, parentNode or test not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The test node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

course, parentNode or test not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

the test node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 409

The given URL is not valid

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

multipart/form-data

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

multipart/form-data

Status Code 404

The course or parentNode not found

Status Code 200 - application/xml, application/json (ns3:courseNodeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node metadatas

XML Schema

Source:

Status Code 406

The course node is not of type task

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 409

The configuration is not valid

Status Code 404

The course or task node not found

Status Code 200 - application/xml, application/json (ns3:surveyConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The task node configuration

XML Schema

Source:

Status Code 406

The call is not applicable to task course node

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 409

The configuration is not valid

Status Code 404

The course or task node not found

Status Code 200 - application/xml, application/json (ns3:surveyConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The task node configuration

XML Schema

Source:

Status Code 406

The call is not applicable to task course node

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or task node not found

Status Code 200 - application/xml, application/json (ns3:surveyConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node configuration

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 409

The configuration is not valid

Status Code 404

The course or survey node not found

Status Code 200 - application/xml, application/json (ns3:surveyConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The survey node configuration

XML Schema

Source:

Status Code 406

The call is not applicable to survey course node

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 409

The configuration is not valid

Status Code 404

The course or survey node not found

Status Code 200 - application/xml, application/json (ns3:surveyConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The survey node configuration

XML Schema

Source:

Status Code 406

The call is not applicable to survey course node

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or survey node not found

Status Code 200 - application/xml, application/json (ns3:surveyConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node configuration

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 409

The configuration is not valid

Status Code 404

The course or test node not found

Status Code 200 - application/xml, application/json (ns3:testConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The test node configuration

XML Schema

Source:

Status Code 406

The call is not applicable to test course node

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 409

The configuration is not valid

Status Code 404

The course or test node not found

Status Code 200 - application/xml, application/json (ns3:testConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The test node configuration

XML Schema

Source:

Status Code 406

The call is not applicable to test course node

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or test node not found

Status Code 200 - application/xml, application/json (ns3:testConfigVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
    <id>id</id>
</courseNodeVO>

The course node configuration

XML Schema

Source:

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 200 - text/plain

Example
OK

The translation of the package + key

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 404

The course or the shared folder not found

Status Code 200

The list of files

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course or the shared folder not found

Status Code 200

The list of files

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course not found

Status Code 200

The list of files

Status Code 401

The roles of the authenticated user are not sufficient

multipart/form-data

Status Code 404

The course or course node not found

Status Code 200

The file is correctly saved

Status Code 406

The course node is not acceptable to copy a file

Status Code 401

The roles of the authenticated user are not sufficient

multipart/form-data

Status Code 404

The course or course node not found

Status Code 200

The file is correctly saved

Status Code 406

The course node is not acceptable to copy a file

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 404

The course not found

Status Code 200

The list of files

Status Code 401

The roles of the authenticated user are not sufficient

multipart/form-data

Status Code 404

The course or course node not found

Status Code 200

The file is correctly saved

Status Code 406

The course node is not acceptable to copy a file

Status Code 401

The roles of the authenticated user are not sufficient

multipart/form-data

Status Code 404

The course or course node not found

Status Code 200

The file is correctly saved

Status Code 406

The course node is not acceptable to copy a file

Status Code 401

The roles of the authenticated user are not sufficient

Status Code 200 - text/plain

Example
1.0

The version of this specific Web Service

Status Code 404

The identity not found

Status Code 200 - text/plain, application/xml

Example
&lt;hello&gt;Hello john&lt;/hello&gt;

Say hello to the authenticated user, and give it a security token

Status Code 401

The authentication has failed