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

/ping

Description:
Ping to test the presence of the REST Api

Initial Date: 7 apr. 2010

Methods

/ping/version

Methods

/ping/{name}

resource-wide template parameters
parameter value description

name

string

Methods

/repo/entries

Description:
This handles the repository entries

Initial Date: 19.05.2009

Methods

/repo/entries/version

Methods

/repo/entries/search

Methods

/repo/entries/{repoEntryKey}

Description:
Repository entry resource

Initial Date: 19.05.2009

resource-wide template parameters
parameter value description

repoEntryKey

string

Methods

/repo/entries/{repoEntryKey}/file

resource-wide template parameters
parameter value description

repoEntryKey

string

repoEntryKey

string

Methods

/repo/entries/{repoEntryKey}/coaches/{identityKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

repoEntryKey

string

identityKey

long

Methods

/repo/entries/{repoEntryKey}/owners

resource-wide template parameters
parameter value description

repoEntryKey

string

repoEntryKey

string

Methods

/repo/entries/{repoEntryKey}/owners/{identityKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

repoEntryKey

string

identityKey

long

Methods

/repo/entries/{repoEntryKey}/participants

resource-wide template parameters
parameter value description

repoEntryKey

string

repoEntryKey

string

Methods

/repo/entries/{repoEntryKey}/participants/{identityKey}

resource-wide template parameters
parameter value description

repoEntryKey

string

repoEntryKey

string

identityKey

long

Methods

/repo/entries/{repoEntryKey}/coaches

resource-wide template parameters
parameter value description

repoEntryKey

string

repoEntryKey

string

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

path

string

Methods

/api

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

Initial Date: 14 apr. 2010

Methods

/api/version

Methods

/api/doc

Methods

/api/doc/{filename}

resource-wide template parameters
parameter value description

filename

string

Methods

/api/{filename}

resource-wide template parameters
parameter value description

filename

string

Methods

/api/copyright

Methods

/i18n

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

Initial Date: 14 apr. 2010

Methods

/i18n/version

Methods

/i18n/{package}/{key}

resource-wide template parameters
parameter value description

package

string

key

string

Methods

/system

Description:

Initial Date: 18 jun. 2010

Methods

/system/environment

Methods

/system/release

Methods

/system/log

Description:
This web service returns logFiles

Initial Date: 23.12.2011

Methods

/system/log/version

Methods

/system/log/{date}

resource-wide template parameters
parameter value description

date

string

Methods

/system/monitoring

Methods

/system/monitoring/configuration

Methods

/system/monitoring/runtime

Methods

/system/monitoring/runtime/classes

Methods

/system/monitoring/runtime/memory

Methods

/system/monitoring/runtime/threads

Methods

/system/monitoring/database

Methods

/system/monitoring/openolat

Methods

/system/monitoring/openolat/tasks

Methods

/system/monitoring/openolat/users

Methods

/system/monitoring/openolat/repository

Methods

/system/monitoring/openolat/sessions

Methods

/system/monitoring/openolat/indexer

Methods

/system/monitoring/openolat/indexer/status

Methods

/system/monitoring/memory

Description:

Initial Date: 21 juin 2010

Methods

/system/monitoring/memory/pools

Methods

/system/monitoring/memory/samples

Methods

/system/monitoring/threads

Description:

Initial Date: 21 juin 2010

Methods

/system/monitoring/threads/cpu

Methods

/system/indexer

Methods

/system/indexer/status

Methods

/system/notifications

Methods

/system/notifications/status

Methods

/repo/courses/infos

Description:

Initial Date: 7 févr. 2012

Methods

/repo/courses/infos/{courseId}

resource-wide template parameters
parameter value description

courseId

long

Methods

/catalog

Description:
A web service for the catalog

Initial Date: 5 may 2010

Methods

/catalog/version

Methods

/catalog/{path:.*}

resource-wide template parameters
parameter value description

path

string

Methods

/catalog/{path:.*}/owners

resource-wide template parameters
parameter value description

path

string

Methods

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

resource-wide template parameters
parameter value description

path

string

identityKey

long

Methods

/catalog/{path:.*}/children

resource-wide template parameters
parameter value description

path

string

Methods

/auth

Description:
Authenticate against OLAT Provider

Initial Date: 7 apr. 2010

Methods

/auth/version

Methods

/auth/{username}

resource-wide template parameters
parameter value description

username

string

Methods

/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

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

path

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

path

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

/users/{username}/auth

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

resource-wide template parameters
parameter value description

username

string

Methods

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

resource-wide template parameters
parameter value description

username

string

username

string

authKey

long

Methods

/users/{username}/auth/version

resource-wide template parameters
parameter value description

username

string

Methods

/users/{username}/auth/new

resource-wide template parameters
parameter value description

username

string

username

string

Methods

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

resource-wide template parameters
parameter value description

username

string

username

string

authKey

long

Methods

/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

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

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

courseId

long

Methods

/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

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

threadKey

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

nodeId

string

messageKey

long

Methods

/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

/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

messageKey

long

Methods

/repo/courses/{courseId}/elements/contact

resource-wide template parameters
parameter value description

courseId

long

Methods

/repo/courses

Description:
This web service handles the courses.

Initial Date: 27 apr. 2010

Methods

/repo/courses/version

Methods

/notifications

Description:

REST API for notifications

Initial Date: 25 aug 2010

Methods

/repo/forums

Description:
Web service to manage forums.

Initial Date: 26 aug. 2010

Methods

/repo/forums/version

Methods

/repo/forums/{forumKey}

Description:
Web service to manage a forum.

Initial Date: 20 apr. 2010

resource-wide template parameters
parameter value description

forumKey

long

Methods

/repo/forums/{forumKey}/threads

resource-wide template parameters
parameter value description

forumKey

long

Methods

/repo/forums/{forumKey}/posts/{threadKey}

resource-wide template parameters
parameter value description

forumKey

long

threadKey

long

Methods

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

resource-wide template parameters
parameter value description

forumKey

long

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

forumKey

long

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

forumKey

long

filename

string

messageKey

long

Methods

/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

Methods

/repo/courses/{courseId}/configuration

resource-wide template parameters
parameter value description

courseId

long

courseId

long

Methods

/repo/courses/{courseId}/version

resource-wide template parameters
parameter value description

courseId

long

Methods

/repo/courses/{courseId}/publish

resource-wide template parameters
parameter value description

courseId

long

courseId

long

Methods

/repo/courses/{courseId}/file

resource-wide template parameters
parameter value description

courseId

long

courseId

long

Methods

/repo/courses/{courseId}/runstructure

resource-wide template parameters
parameter value description

courseId

long

courseId

long

Methods

/repo/courses/{courseId}/editortreemodel

resource-wide template parameters
parameter value description

courseId

long

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

identityKey

long

courseId

long

Methods

/repo/courses/{courseId}/tutors/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

identityKey

long

courseId

long

Methods

/repo/courses/{courseId}/authors

resource-wide template parameters
parameter value description

courseId

long

courseId

long

Methods

/repo/courses/{courseId}/participants/{identityKey}

resource-wide template parameters
parameter value description

courseId

long

identityKey

long

courseId

long

Methods

/repo/courses/{courseId}/groups

Description:
CourseGroupWebService

Initial Date: 7 apr. 2010

resource-wide template parameters
parameter value description

courseId

long

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

groupKey

long

Methods

/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

courseId

long

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

groupKey

long

threadKey

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

groupKey

long

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

groupKey

long

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

groupKey

long

filename

string

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

courseId

long

groupKey

long

path

string

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

courseId

long

Methods

/users/{identityKey}/forums

Description:

Initial Date: 6 déc. 2011

resource-wide template parameters
parameter value description

identityKey

long

Methods

/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

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

threadKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

filename

string

messageKey

long

Methods

/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

courseKey

long

courseNodeId

string

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

threadKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

filename

string

messageKey

long

Methods

/groups

Description:
This handles the learning groups.

Initial Date: 23 mar. 2010

Methods

/groups/version

Methods

/groups/{groupKey}

resource-wide template parameters
parameter value description

groupKey

long

Methods

/groups/{groupKey}/configuration

resource-wide template parameters
parameter value description

groupKey

long

Methods

/groups/{groupKey}/infos

resource-wide template parameters
parameter value description

groupKey

long

Methods

/groups/{groupKey}/owners

resource-wide template parameters
parameter value description

groupKey

long

Methods

/groups/{groupKey}/participants

resource-wide template parameters
parameter value description

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

groupKey

long

identityKey

long

Methods

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

resource-wide template parameters
parameter value description

groupKey

long

identityKey

long

Methods

/groups/{groupKey}/forum

Description:
Web service to manage a forum.

Initial Date: 20 apr. 2010

resource-wide template parameters
parameter value description

groupKey

long

Methods

/groups/{groupKey}/forum/threads

resource-wide template parameters
parameter value description

groupKey

long

Methods

/groups/{groupKey}/forum/posts/{threadKey}

resource-wide template parameters
parameter value description

groupKey

long

threadKey

long

Methods

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

resource-wide template parameters
parameter value description

groupKey

long

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

groupKey

long

messageKey

long

Methods

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

resource-wide template parameters
parameter value description

groupKey

long

filename

string

messageKey

long

Methods

/groups/{groupKey}/folder

resource-wide template parameters
parameter value description

groupKey

long

Methods

/groups/{groupKey}/folder/version

resource-wide template parameters
parameter value description

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

groupKey

long

path

string

Methods

/groups/{groupKey}/wiki

resource-wide template parameters
parameter value description

groupKey

long

Methods

/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

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

parentNodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

nodeId

string

courseId

long

Methods

/repo/courses/{courseId}/assessments

Description:
Retrieve and import course assessments

Initial Date: 7 apr. 2010

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

identityKey

long

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

nodeId

string

courseId

long

Methods

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

resource-wide template parameters
parameter value description

courseId

long

nodeId

long

identityKey

long

courseId

long

Methods

/contacts

Description:

Initial Date: 21 oct. 2011

Methods

/repo/lifecycle

Initial date: 10.06.2013

Methods

/users

This web service handles functionalities related to User.

Methods

/users/{identityKey}

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/version

Methods

/users/{identityKey}/roles

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/portrait

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/delete

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/folders

Description:

Initial Date: 16 déc. 2011

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/folders/personal

resource-wide template parameters
parameter value description

identityKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

path

string

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

courseKey

long

courseNodeId

string

path

string

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

Methods

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

resource-wide template parameters
parameter value description

identityKey

long

groupKey

long

path

string

Methods

/users/{identityKey}/courses

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/courses/my

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/courses/teached

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/courses/favorite

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/groups

Description:

Initial Date: 18 oct. 2011

resource-wide template parameters
parameter value description

identityKey

long

Methods

/users/{identityKey}/groups/infos

resource-wide template parameters
parameter value description

identityKey

long

Methods

Representations

text/plain

Example
Ping

Return a small string

text/plain

Example
1.0

The version of this specific Web Service

text/plain

Example
Ping

Return a small string

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:

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:

The roles of the authenticated user are not sufficient

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:

text/plain

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:

The roles of the authenticated user are not sufficient

The course not found

The metadatas of the created course

The roles of the authenticated user are not sufficient

The repository entry not found

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:

application/xml (repositoryEntryVO)

XML Schema

Source:

application/json (repositoryEntryVO)

XML Schema

Source:

application/xml

application/json

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:

The roles of the authenticated user are not sufficient

The resource is locked

The resource could not found

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

Download of this resource is not possible

The roles of the authenticated user are not sufficient

The repository entry or the user cannot be found

The user is added as coach of the repository entry

The roles of the authenticated user are not sufficient

The repository entry or the user cannot be found

The user is removed as coach from the repository entry

The roles of the authenticated user are not sufficient

The repository entry cannot be found

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 repository entry

XML Schema

Source:

The repository entry or the user cannot be found

The user is added as owner of the repository entry

The roles of the authenticated user are not sufficient

The repository entry or the user cannot be found

The user is removed as owner from the repository entry

The roles of the authenticated user are not sufficient

The repository entry cannot be found

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>

Coaches of the repository entry

XML Schema

Source:

The repository entry or the user cannot be found

The user is added as participant of the repository entry

The roles of the authenticated user are not sufficient

The repository entry or the user cannot be found

The user is removed as participant from the repository entry

The roles of the authenticated user are not sufficient

The repository entry cannot be found

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>

Coaches of the repository entry

XML Schema

Source:

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

*/*

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

application/json

application/xml

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

text/plain

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

application/json

application/xml

*/*

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/plain

Example
1.0

Return the version number

text/html

image/jpeg

Images for the documentation

image/jpeg

Images for the documentation

text/html, application/xhtml+xml

The copyright of the REST API.

text/plain

The copyright of the REST API.

text/plain

Example
1.0

The version of this specific Web Service

text/plain

Example
OK

The translation of the package + key

application/xml, application/json (ns3:environmentVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<environmentVO arch="x86_64" osName="Mac OS X" osVersion="10.7.2" availableProcessors="4" runtimeName="15261@agam.local" vmName="Java HotSpot(TM) 64-Bit Server VM" vmVendor="Apple Inc." vmVersion="20.4-b02-402"/>

A short summary of the number of classes

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:releaseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<versionVO buildVersion="" olatVersion="" repoRevision="" allowAutoPatch="true" patchAvailable="true" allowAutoUpdate="false" updateAvailable="false" upgradeAvailable="false"/>

The verison of the instance

XML Schema

Source:

The roles of the authenticated user are not sufficient

text/plain

application/octet-stream

text/plain

Example
1.0

The version of this specific Web Service

text/plain

application/octet-stream

application/xml, application/json (ns3:releaseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<monitoringInfosVO>
    <type>openolat</type>
    <description>this is an OpenOLAT instance</description>
    <probes>
        <probe>Environment</probe>
        <probe>System</probe>
        <probe>Runtime</probe>
        <probe>Memory</probe>
    </probes>
    <dependencies>
        <dependency type="openfire" url="localhost"/>
        <dependency type="mysql" url="192.168.1.120"/>
    </dependencies>
</monitoringInfosVO>

The verison of the instance

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:runtimeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<runtimeVO systemLoadAverage="1.16748046875" startTime="2013-07-26T09:01:43.546+02:00" upTime="21248">
    <classes loadedClassCount="7000" unloadedClassCount="1500" totalLoadedClassCount="8500"/>
    <threads threadCount="102" daemonCount="45" peakThreadCount="123"/>
    <memory usedMemory="12" freeMemory="45" totalMemory="56" initHeap="0" usedHeap="0" committedHeap="0" maxHeap="0" initNonHeap="0" usedNonHeap="0" committedNonHeap="0" maxNonHeap="0" garbageCollectionTime="0" garbageCollectionCount="0"/>
</runtimeVO>

The version of the instance

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:classesVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<classeStatisticsVO loadedClassCount="7000" unloadedClassCount="1500" totalLoadedClassCount="8500"/>

A short summary of the number of classes

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:runtimeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<memoryStatisticsVO usedMemory="12" freeMemory="45" totalMemory="56" initHeap="0" usedHeap="0" committedHeap="0" maxHeap="0" initNonHeap="0" usedNonHeap="0" committedNonHeap="0" maxNonHeap="0" garbageCollectionTime="0" garbageCollectionCount="0"/>

The version of the instance

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:runtimeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<threadStatisticsVO threadCount="102" daemonCount="45" peakThreadCount="123"/>

The version of the instance

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:runtimeVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<databaseVO>
    <connectionInfos activeConnectionCount="10" currentConnectionCount="25"/>
    <hibernateStatistics openSessionsCount="12" transactionsCount="13900" successfulTransactionCount="13980" failedTransactionsCount="2" optimisticFailureCount="23" queryExecutionMaxTime="12000" queryExecutionMaxTimeQueryString="select * from PLock" queryExecutionCount="1237"/>
</databaseVO>

The version of the instance

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:releaseVO)

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

The verison of the instance

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:taskVOes)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sessionsVO count="234" authenticatedCount="234" secureAuthenticatedCount="234" webdavCount="23" secureWebdavCount="12" restCount="0" secureRestCount="0" instantMessagingCount="123" authenticatedClickCountLastMinute="0" authenticatedPollCountLastMinute="0" authenticatedClickCountLastFiveMinutes="0" requestLastMinute="0" requestLastFiveMinutes="0" authenticatedPollCountLastFiveMinutes="0" concurrentDispatchThreads="0"/>

A short summary about sessions

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:releaseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userStatisticsVO totalUserCount="0" totalGroupCount="0"/>

The verison of the instance

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:releaseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryStatisticsVO coursesCount="0" publishedCoursesCount="0"/>

The verison of the instance

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:sessionVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sessionsVO count="234" authenticatedCount="234" secureAuthenticatedCount="234" webdavCount="23" secureWebdavCount="12" restCount="0" secureRestCount="0" instantMessagingCount="123" authenticatedClickCountLastMinute="0" authenticatedPollCountLastMinute="0" authenticatedClickCountLastFiveMinutes="0" requestLastMinute="0" requestLastFiveMinutes="0" authenticatedPollCountLastFiveMinutes="0" concurrentDispatchThreads="0"/>

A short summary about sessions

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:releaseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<indexerStatisticsVO indexedDocumentCount="0" excludedDocumentCount="0" documentQueueSize="0" runningFolderIndexerCount="0" availableFolderIndexerCount="0" indexSize="0" indexingTime="0"/>

Statistics about the indexer

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The status has changed

The roles of the authenticated user are not sufficient

application/xml, application/json

The status of the indexer

The roles of the authenticated user are not sufficient

text/plain

The status of the indexer

The roles of the authenticated user are not sufficient

text/plain

Informations about memory

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:memoryVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<memoryVO date="2013-07-26T09:01:43.546+02:00" totalMem="230" totalUsed="546" maxAvailable="2000"/>

A short summary of the number of classes

XML Schema

Source:

The roles of the authenticated user are not sufficient

text/plain

application/xml

application/json

application/xml

application/json

text/plain

application/xml

application/json

application/xml

application/json

application/xml, application/json (ns3:releaseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<indexerStatisticsVO indexedDocumentCount="0" excludedDocumentCount="0" documentQueueSize="0" runningFolderIndexerCount="0" availableFolderIndexerCount="0" indexSize="0" indexingTime="0"/>

Statistics about the indexer

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The status has changed

The roles of the authenticated user are not sufficient

application/xml, application/json

The status of the indexer

The roles of the authenticated user are not sufficient

text/plain

The status of the indexer

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The status has changed

The roles of the authenticated user are not sufficient

application/xml, application/json

The status of the notifications job

The roles of the authenticated user are not sufficient

text/plain

The status of the notifications job

The roles of the authenticated user are not sufficient

application/xml, application/json, application/json;pagingspec=1.0 (ns3:courseVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseInfoVOes totalCount="1">
    <infos>
        <infos>
            <key>777</key>
            <softKey>oo_98237498</softKey>
            <repoEntryKey>456</repoEntryKey>
            <title>Demo course</title>
            <displayName>Demo course</displayName>
        </infos>
    </infos>
</courseInfoVOes>

List of visible courses

XML Schema

Source:

application/xml, application/json (ns3:courseVO)

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

Course informations

XML Schema

Source:

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:

text/plain

Example
1.0

The version of this specific Web Service

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:

The path could not be resolved to a valid catalog entry

The path could not be resolved to a valid catalog entry

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:

Not authorized

application/xml (catalogEntryVO)

XML Schema

Source:

application/json (catalogEntryVO)

XML Schema

Source:

The path could not be resolved to a valid catalog entry

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:

Not authorized

application/x-www-form-urlencoded

The path could not be resolved to a valid catalog entry

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:

Not authorized

application/xml (catalogEntryVO)

XML Schema

Source:

application/json (catalogEntryVO)

XML Schema

Source:

The path could not be resolved to a valid catalog entry

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:

Not authorized

The path could not be resolved to a valid catalog entry

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:

Not authorized

The path could not be resolved to a valid catalog entry

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:

Not authorized

The path could not be resolved to a valid catalog entry

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:

Not authorized

The path could not be resolved to a valid catalog entry

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:

Not authorized

The path could not be resolved to a valid catalog entry

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:

Not authorized

The path could not be resolved to a valid catalog entry

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:

Not authorized

The path could not be resolved to a valid catalog entry

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:

text/plain

Example
1.0

The version of this specific Web Service

The identity not found

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

The authentication has failed

text/plain

Example
1.0

The version of this specific Web Service

The course or the shared folder not found

The list of files

The roles of the authenticated user are not sufficient

The course or the shared folder not found

The list of files

The roles of the authenticated user are not sufficient

The course not found

The list of files

The roles of the authenticated user are not sufficient

The course or course node not found

The file is correctly saved

The course node is not acceptable to copy a file

The roles of the authenticated user are not sufficient

The course or course node not found

The file is correctly saved

The course node is not acceptable to copy a file

The roles of the authenticated user are not sufficient

The course not found

The list of files

The roles of the authenticated user are not sufficient

The course or course node not found

The file is correctly saved

The course node is not acceptable to copy a file

The roles of the authenticated user are not sufficient

The course or course node not found

The file is correctly saved

The course node is not acceptable to copy a file

The roles of the authenticated user are not sufficient

application/xml (authenticationVO)

XML Schema

Source:

application/json (authenticationVO)

XML Schema

Source:

The identity not found

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:

The roles of the authenticated user are not sufficient

The identity not found

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:

The roles of the authenticated user are not sufficient

The identity or the authentication not found

The authentication successfully deleted

The roles of the authenticated user are not sufficient

text/plain

Example
1.0

The version of this specific Web Service

application/xml (authenticationVO)

XML Schema

Source:

application/json (authenticationVO)

XML Schema

Source:

The identity not found

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:

The roles of the authenticated user are not sufficient

The identity or the authentication not found

The authentication successfully deleted

The roles of the authenticated user are not sufficient

The course or parentNode not found

application/xml, application/json (ns3:forumVOes)

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

The course node metadatas

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

application/xml, application/json (ns3:forumVO)

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

The course node metadatas

XML Schema

Source:

The roles of the authenticated user are not sufficient

The forum not found

application/xml, application/json (ns3:forumVO)

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

The root message of the thread

XML Schema

Source:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author or message not found

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:

The roles of the authenticated user are not sufficient

application/xml (replyVO)

XML Schema

Source:

application/json (replyVO)

XML Schema

Source:

The author or message not found

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:

The roles of the authenticated user are not sufficient

The author or message not found

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:

The roles of the authenticated user are not sufficient

The message not found

application/xml, application/json

The links to the attachments

application/x-www-form-urlencoded

The identity or the portrait not found

application/json, application/xml

Ok

application/xml (fileUpload)

XML Schema

Source:

application/json (fileUpload)

XML Schema

Source:

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/octet-stream

The portrait as image

application/xml

application/json

application/x-www-form-urlencoded

application/xml

application/json

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:

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:

The roles of the authenticated user are not sufficient

application/xml

application/json

text/plain

Example
1.0

The version of this specific Web Service

The identity not found

application/xml, application/json

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

The notifications

text/plain

Example
1.0

The version of this specific Web Service

The forum not found

application/xml, application/json (ns3:forumVO)

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

The root message of the thread

XML Schema

Source:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author or message not found

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:

The roles of the authenticated user are not sufficient

application/xml (replyVO)

XML Schema

Source:

application/json (replyVO)

XML Schema

Source:

The author or message not found

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:

The roles of the authenticated user are not sufficient

The author or message not found

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:

The roles of the authenticated user are not sufficient

The message not found

application/xml, application/json

The links to the attachments

application/x-www-form-urlencoded

The identity or the portrait not found

application/json, application/xml

Ok

application/xml (fileUpload)

XML Schema

Source:

application/json (fileUpload)

XML Schema

Source:

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/octet-stream

The portrait as image

The course not found

The metadatas of the created course

The roles of the authenticated user are not sufficient

The course not found

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:

The course not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course not found

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:

The roles of the authenticated user are not sufficient

text/plain

Example
1.0

The version of this specific Web Service

The course not found

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:

The roles of the authenticated user are not sufficient

The course not found

application/zip

The course as a ZIP file

Not authorized to export the course

The course not found

application/xml

The run structure of the course

The roles of the authenticated user are not sufficient

The course not found

application/xml

The editor tree model of the course

The roles of the authenticated user are not sufficient

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

application/xml, application/json (ns3:userVO)

The author

XML Schema

Source:

The roles of the authenticated user are not sufficient

The course or the user not found

The user is an author and owner of the course

The roles of the authenticated user are not sufficient

The course or the user not found

The user was successfully removed as owner of the course

The roles of the authenticated user are not sufficient

The course or the user not found

The user is a coach of the course

The roles of the authenticated user are not sufficient

The course not found

application/xml, application/json (ns3:userVO)

The array of authors

XML Schema

Source:

The roles of the authenticated user are not sufficient

The course or the user not found

The user is a participant of the course

The roles of the authenticated user are not sufficient

The context of the group not found

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 (groupVO)

XML Schema

Source:

application/json (groupVO)

XML Schema

Source:

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:

The roles of the authenticated user are not sufficient

text/plain

Example
1.0

The version of this specific Web Service

The business group cannot be found

The business group is deleted

The roles of the authenticated user are not sufficient

The business group cannot be found

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:

*/* (groupVO)

XML Schema

Source:

The business group cannot be found

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:

The roles of the authenticated user are not sufficient

The forum not found

application/xml, application/json (ns3:forumVO)

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

The root message of the thread

XML Schema

Source:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author or message not found

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:

The roles of the authenticated user are not sufficient

application/xml (replyVO)

XML Schema

Source:

application/json (replyVO)

XML Schema

Source:

The author or message not found

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:

The roles of the authenticated user are not sufficient

The author or message not found

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:

The roles of the authenticated user are not sufficient

The message not found

application/xml, application/json

The links to the attachments

application/x-www-form-urlencoded

The identity or the portrait not found

application/json, application/xml

Ok

application/xml (fileUpload)

XML Schema

Source:

application/json (fileUpload)

XML Schema

Source:

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/octet-stream

The portrait as image

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

application/json

application/xml

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

text/plain

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

application/json

application/xml

*/*

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/xml

application/json

application/x-www-form-urlencoded

application/xml

application/json

application/xml

application/json

application/xml, application/json (ns3:forumVO)

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

The forums

XML Schema

Source:

The roles of the authenticated user are not sufficient

The forum not found

application/xml, application/json (ns3:forumVO)

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

The root message of the thread

XML Schema

Source:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author or message not found

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:

The roles of the authenticated user are not sufficient

application/xml (replyVO)

XML Schema

Source:

application/json (replyVO)

XML Schema

Source:

The author or message not found

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:

The roles of the authenticated user are not sufficient

The author or message not found

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:

The roles of the authenticated user are not sufficient

The message not found

application/xml, application/json

The links to the attachments

application/x-www-form-urlencoded

The identity or the portrait not found

application/json, application/xml

Ok

application/xml (fileUpload)

XML Schema

Source:

application/json (fileUpload)

XML Schema

Source:

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/octet-stream

The portrait as image

The forum not found

application/xml, application/json (ns3:forumVO)

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

The root message of the thread

XML Schema

Source:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author or message not found

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:

The roles of the authenticated user are not sufficient

application/xml (replyVO)

XML Schema

Source:

application/json (replyVO)

XML Schema

Source:

The author or message not found

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:

The roles of the authenticated user are not sufficient

The author or message not found

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:

The roles of the authenticated user are not sufficient

The message not found

application/xml, application/json

The links to the attachments

application/x-www-form-urlencoded

The identity or the portrait not found

application/json, application/xml

Ok

application/xml (fileUpload)

XML Schema

Source:

application/json (fileUpload)

XML Schema

Source:

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/octet-stream

The portrait as image

application/xml (groupVO)

XML Schema

Source:

application/json (groupVO)

XML Schema

Source:

The business group cannot be found

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:

The roles of the authenticated user are not sufficient

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:

text/plain

Example
1.0

The version of this specific Web Service

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 (groupVO)

XML Schema

Source:

application/json (groupVO)

XML Schema

Source:

The business group cannot be found

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:

The roles of the authenticated user are not sufficient

The business group cannot be found

The business group is deleted

The roles of the authenticated user are not sufficient

*/* (groupVO)

XML Schema

Source:

*/*

The business group cannot be found

application/xml, application/json (ns3:groupInfoVO)

Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupInfoVO folderWrite="false">
    <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:

The business group cannot be found

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:

The business group cannot be found

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:

The business group or the user cannot be found

The user is added as owner of the group

The roles of the authenticated user are not sufficient

The business group or the user cannot be found

The user is removed as owner from the group

The roles of the authenticated user are not sufficient

The business group or the user cannot be found

The user is added as participant of the group

The roles of the authenticated user are not sufficient

The business group or the user cannot be found

The user is remove from the group as participant

The roles of the authenticated user are not sufficient

The forum not found

application/xml, application/json (ns3:forumVO)

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

The root message of the thread

XML Schema

Source:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

The author, forum or message not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The author or message not found

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:

The roles of the authenticated user are not sufficient

application/xml (replyVO)

XML Schema

Source:

application/json (replyVO)

XML Schema

Source:

The author or message not found

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:

The roles of the authenticated user are not sufficient

The author or message not found

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:

The roles of the authenticated user are not sufficient

The message not found

application/xml, application/json

The links to the attachments

application/x-www-form-urlencoded

The identity or the portrait not found

application/json, application/xml

Ok

application/xml (fileUpload)

XML Schema

Source:

application/json (fileUpload)

XML Schema

Source:

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/json, application/xml

Ok

The identity or the portrait not found

application/octet-stream

The portrait as image

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

application/json

application/xml

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

text/plain

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

application/json

application/xml

*/*

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/zip

application/octet-stream

text/plain

Example
1.0

The version of this specific Web Service

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course, parentNode or test not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course, parentNode or test not found

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:

The roles of the authenticated user are not sufficient

course, parentNode or test not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

application/x-www-form-urlencoded

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The given URL is not valid

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The roles of the authenticated user are not sufficient

The course or parentNode not found

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:

The course node is not of type task

The roles of the authenticated user are not sufficient

The configuration is not valid

The course or task node not found

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:

The call is not applicable to task course node

The roles of the authenticated user are not sufficient

The configuration is not valid

The course or task node not found

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:

The call is not applicable to task course node

The roles of the authenticated user are not sufficient

The course or task node not found

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:

The roles of the authenticated user are not sufficient

The configuration is not valid

The course or survey node not found

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:

The call is not applicable to survey course node

The roles of the authenticated user are not sufficient

The configuration is not valid

The course or survey node not found

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:

The call is not applicable to survey course node

The roles of the authenticated user are not sufficient

The course or survey node not found

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:

The roles of the authenticated user are not sufficient

The configuration is not valid

The course or test node not found

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:

The call is not applicable to test course node

The roles of the authenticated user are not sufficient

The configuration is not valid

The course or test node not found

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:

The call is not applicable to test course node

The roles of the authenticated user are not sufficient

The course or test node not found

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:

The roles of the authenticated user are not sufficient

The course not found

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:

The roles of the authenticated user are not sufficient

text/plain

Example
1.0

The version of this specific Web Service

The identity or the course not found

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:

The roles of the authenticated user are not sufficient

The course not found

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:

The roles of the authenticated user are not sufficient

application/xml (assessableResultsVO)

XML Schema

Source:

application/json (assessableResultsVO)

XML Schema

Source:

The identity not found

Import successful

The roles of the authenticated user are not sufficient

The identity or the course not found

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:

The roles of the authenticated user are not sufficient

The list of contacts

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:

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:

The roles of the authenticated user are not sufficient

application/xml (userVO)

XML Schema

Source:

application/json (userVO)

XML Schema

Source:

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

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

The roles of the authenticated user are not sufficient

The identity not found

The user is removed from the group

The roles of the authenticated user are not sufficient

application/xml (userVO)

XML Schema

Source:

application/json (userVO)

XML Schema

Source:

The identity not found

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:

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:

The roles of the authenticated user are not sufficient

The identity not found

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

The roles of the authenticated user are not sufficient

text/plain

Example
1.0

The version of this specific Web Service

application/xml

application/json

application/xml

application/json

The identity not found

application/xml, application/json

The user

The roles of the authenticated user are not sufficient

The identity or the portrait not found

application/octet-stream

The portrait as image

The identity or the portrait not found

application/octet-stream

The portrait as image

Not authorized

The portrait deleted

Not authorized

The identity not found

The user is removed from the group

The roles of the authenticated user are not sufficient

application/xml, application/json (ns3:folderVOes)

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

The folders

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

application/json

application/xml

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

text/plain

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

application/json

application/xml

*/*

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

application/json

application/xml

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

text/plain

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

application/json

application/xml

*/*

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

application/x-www-form-urlencoded

application/json

application/xml

application/json

application/xml

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

text/plain

application/json

application/xml

text/html

application/octet-stream

*/*

application/json

application/xml

*/*

application/x-www-form-urlencoded

application/json

application/xml

*/*

application/json

application/xml

*/*

application/json (fileUpload)

XML Schema

Source:

application/xml (fileUpload)

XML Schema

Source:

application/json

application/xml

application/json

application/xml

application/json

application/xml

application/xml, application/json (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>

The courses

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (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>

The courses

XML Schema

Source:

The roles of the authenticated user are not sufficient

application/xml, application/json (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>

The courses

XML Schema

Source:

The roles of the authenticated user are not sufficient

The identity not found

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:

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 folderWrite="false">
            <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:

The request hasn't paging information