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.;
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.
The security is based on a two level mechanism, as it is in OpenOLAT.
To maintain a valid authentication over several requests, the filter proposes two methods:
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.
Here is a little example on how to create a user and add it to a learning group:
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.
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.
Description:<br> <P> Initial Date: 6 févr. 2012 <br>
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
This attaches a Folder Element onto a given course. The element will be inserted underneath the supplied parentNodeId.
parameter | value | description |
---|---|---|
parentNodeId |
The node's id which will be the parent of this folder |
|
position |
The node's position relative to its sibling nodes (optional) |
|
shortTitle |
Default: undefined |
The node short title |
longTitle |
Default: undefined |
The node long title |
objectives |
Default: undefined |
The node learning objectives |
visibilityExpertRules |
The rules to view the node (optional) |
|
downloadExpertRules |
The rules to download files (optional) |
|
uploadExpertRules |
The rules to upload files (optional) |
available response representations:
available response representations:
available response representations:
Retrieves metadata of the course node
available response representations:
available response representations:
available response representations:
This attaches a Folder Element onto a given course. The element will be inserted underneath the supplied parentNodeId.
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
The course resourceable's id |
|
nodeId |
The node's id |
This updates a Folder Element onto a given course.
acceptable request representations:
available response representations:
available response representations:
available response representations:
Retrieves metadata of the course node
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
nodeId |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
nodeId |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
nodeId |
||
path |
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
nodeId |
parameter | value | description |
---|---|---|
identityKey |
parameter | value | description |
---|---|---|
identityKey |
||
identityKey |
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
onlyFuture |
Default: false |
available response representations:
Initial date: 23.12.2015<br>
parameter | value | description |
---|---|---|
identityKey |
||
calendarId |
||
identityKey |
parameter | value | description |
---|---|---|
identityKey |
||
calendarId |
||
identityKey |
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
onlyFuture |
Default: false |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
||
calendarId |
||
identityKey |
||
eventId |
parameter | value | description |
---|---|---|
identityKey |
||
calendarId |
||
identityKey |
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
managed |
||
externalId |
||
externalRef |
||
repositoryEntryKey |
available response representations:
parameter | value | description |
---|---|---|
shortTitle |
||
title |
||
displayName |
||
description |
||
softKey |
||
access |
||
membersOnly |
||
externalId |
||
externalRef |
||
authors |
||
location |
||
managedFlags |
||
sharedFolderSoftKey |
||
copyFrom |
||
initialAuthor |
||
setAuthor |
Default: true |
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
||
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
identityKey |
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
||
identityKey |
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
identityKey |
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
locale |
||
access |
||
membersOnly |
available response representations:
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
||
path |
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
Retrieves the forum.
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
Retrieves the threads in the forum
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name,creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
||
threadKey |
The key of the thread |
Retrieves the messages in the thread
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name, creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
||
messageKey |
The id of the reply message |
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
||
messageKey |
The key of the message |
Retrieves the attachments of the message
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
groupKey |
||
messageKey |
The identity key of the user being searched |
|
filename |
The name of the attachment |
Retrieves the attachment of the message
available response representations:
available response representations:
Initial date: 23.12.2015<br>
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
onlyFuture |
Default: false |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
eventId |
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
Initial date: 14.07.2015<br>
parameter | value | description |
---|---|---|
courseId |
||
subIdentifier |
returns the list of booking of the resource.
available response representations:
Return the created or updated booking
acceptable request representations:
available response representations:
Return the created or updated booking
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
subIdentifier |
||
bookingId |
The id of the booking |
Returns the list of members of the booking.
available response representations:
Update the list of members of the booking, it add and mutates the members and delete the missing members.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
subIdentifier |
||
bookingId |
Initial date: 24.03.2016<br>
parameter | value | description |
---|---|---|
courseId |
||
subIdentifier |
parameter | value | description |
---|---|---|
courseId |
||
subIdentifier |
returns the list of booking of the resource.
available response representations:
Return the created or updated training
acceptable request representations:
available response representations:
Return the created or updated training
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
subIdentifier |
||
trainingKey |
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
||
lectureBlockKey |
parameter | value | description |
---|---|---|
courseId |
||
lectureBlockKey |
||
identityKey |
parameter | value | description |
---|---|---|
courseId |
||
lectureBlockKey |
parameter | value | description |
---|---|---|
courseId |
||
lectureBlockKey |
parameter | value | description |
---|---|---|
courseId |
||
lectureBlockKey |
Webservice to create a temporary key to change the password Initial date: 15.10.2013<br>
parameter | value | description |
---|---|---|
identityKey |
available response representations:
Initial date: 06.07.2015<br>
Initial date: 14.07.2015<br>
parameter | value | description |
---|---|---|
resourceName |
||
resourceId |
||
subIdentifier |
returns the list of booking of the resource.
available response representations:
Return the created or updated booking
acceptable request representations:
available response representations:
Return the created or updated booking
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
resourceName |
||
resourceId |
||
subIdentifier |
||
bookingId |
The id of the booking |
Returns the list of members of the booking.
available response representations:
Update the list of members of the booking, it add and mutates the members and delete the missing members.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
resourceName |
||
resourceId |
||
subIdentifier |
||
bookingId |
parameter | value | description |
---|---|---|
externalId |
||
managed |
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
parameter | value | description |
---|---|---|
groupKey |
parameter | value | description |
---|---|---|
groupKey |
parameter | value | description |
---|---|---|
groupKey |
parameter | value | description |
---|---|---|
identityKey |
||
groupKey |
parameter | value | description |
---|---|---|
identityKey |
||
groupKey |
The Group Wiki Webservice<br /> allows the export of group wikis
parameter | value | description |
---|---|---|
groupKey |
will export the wiki from the current group to a CP and serve as zip-file.<br />
available response representations:
parameter | value | description |
---|---|---|
groupKey |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
||
path |
parameter | value | description |
---|---|---|
groupKey |
Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>
parameter | value | description |
---|---|---|
groupKey |
Retrieves the forum.
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
Retrieves the threads in the forum
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name,creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
||
threadKey |
The key of the thread |
Retrieves the messages in the thread
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name, creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
||
messageKey |
The id of the reply message |
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
||
messageKey |
The key of the message |
Retrieves the attachments of the message
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
available response representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
||
messageKey |
The identity key of the user being searched |
|
filename |
The name of the attachment |
Retrieves the attachment of the message
available response representations:
available response representations:
Description:<br> Access the custom dbs of a course <P> Initial Date: *7 apr. 2010 <br>
parameter | value | description |
---|---|---|
name |
The name of the key value pair |
|
category |
The name of the database |
|
courseId |
The course resourceable's id |
Retrieve a value of an authenticated user.
available response representations:
available response representations:
Retrieve a value of an authenticated user.
available response representations:
available response representations:
Update a value for an authenticated user.
acceptable request representations:
available response representations:
Delete a value for an authenticated user.
available response representations:
available response representations:
available response representations:
Put a new value for an authenticated user.
parameter | value | description |
---|---|---|
value |
The value of the key value pair |
available response representations:
parameter | value | description |
---|---|---|
category |
The name of the database |
|
courseId |
The course resourceable's id |
Retrieve all values of the authenticated user
available response representations:
Put a new value for an authenticated user.
acceptable request representations:
available response representations:
Update a value for an authenticated user.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
name |
The name of the key value pair |
|
category |
The name of the database |
|
courseId |
The course resourceable's id |
Retrieves the version of the Course DB Web Service.
available response representations:
parameter | value | description |
---|---|---|
path |
||
courseId |
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
path |
||
courseId |
available response representations:
parameter | value | description |
---|---|---|
courseId |
Description:<br> REST API implementation for forum course node <P> Initial Date: 20.12.2010 <br>
parameter | value | description |
---|---|---|
courseId |
Retrieves metadata of the published course node
available response representations:
available response representations:
available response representations:
This attaches a Forum Element onto a given course. The element will be inserted underneath the supplied parentNodeId.
acceptable request representations:
available response representations:
available response representations:
available response representations:
This attaches a Forum Element onto a given course. The element will be inserted underneath the supplied parentNodeId.
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
moderatorExpertRules |
||
posterExpertRules |
||
readerExpertRules |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
The course resourceable's id |
|
nodeId |
The node's id |
Retrieves metadata of the published course node
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
The id of the course. |
|
nodeId |
The id of the course node. |
Creates a new thread in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
identityName |
The author identity name (optional) |
|
sticky |
Creates sticky thread. |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
The id of the course. |
|
nodeId |
The id of the course node. |
Creates a new forum message in the forum of the course node
parameter | value | description |
---|---|---|
parentMessageId |
The id of the parent message. |
|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
identityName |
The author identity name (optional) |
available response representations:
available response representations:
available response representations:
Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
Retrieves the forum.
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
Retrieves the threads in the forum
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name,creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
||
threadKey |
The key of the thread |
Retrieves the messages in the thread
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name, creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
||
messageKey |
The id of the reply message |
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
||
messageKey |
The key of the message |
Retrieves the attachments of the message
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
||
messageKey |
The identity key of the user being searched |
|
filename |
The name of the attachment |
Retrieves the attachment of the message
available response representations:
available response representations:
Description:<br> <P> Initial Date: 6 déc. 2011 <br>
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
Retrieves a list of forums on a user base. All forums of groups where the user is participant/tutor + all forums in course where the user is a participant (owner, tutor or participant)
available response representations:
available response representations:
Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
Retrieves the forum.
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
Retrieves the threads in the forum
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name,creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
||
threadKey |
The key of the thread |
Retrieves the messages in the thread
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name, creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
||
messageKey |
The id of the reply message |
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
||
messageKey |
The key of the message |
Retrieves the attachments of the message
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
||
messageKey |
The identity key of the user being searched |
|
filename |
The name of the attachment |
Retrieves the attachment of the message
available response representations:
available response representations:
Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
Retrieves the forum.
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
Retrieves the threads in the forum
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name,creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
||
threadKey |
The key of the thread |
Retrieves the messages in the thread
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name, creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
||
messageKey |
The id of the reply message |
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
||
messageKey |
The key of the message |
Retrieves the attachments of the message
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
||
messageKey |
The identity key of the user being searched |
|
filename |
The name of the attachment |
Retrieves the attachment of the message
available response representations:
available response representations:
Initial date: 17.11.2014<br>
parameter | value | description |
---|---|---|
resourceKey |
The primary key of the resource of the repository entry of the course. |
|
identityKey |
The owner of the certificate |
Return the certificate as PDF file.
available response representations:
available response representations:
available response representations:
Generate a new certificate.
parameter | value | description |
---|---|---|
score |
The score which appears in the certificate |
|
passed |
The passed/failed which appears in the certificate (true/false) |
|
creationDate |
The date of the certification |
available response representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
name |
Initial date: 13.11.2012<br>
parameter | value | description |
---|---|---|
identityToken |
The identity key of the user being searched |
Retrieves the portrait of an user
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
||
identityKey |
||
courseId |
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
courseId |
||
identityKey |
||
courseId |
||
nodeId |
The Wikis Webservice.<br /> OO-112
get list of repo-entry wikis. Group-Wikis are not listed!
available response representations:
The Wiki Webservice<br /> allows the export of "normal" wikis ( in contrast to group-wikis) OO-112
parameter | value | description |
---|---|---|
wikiKey |
part of the REST path, the resourceable-id / repo-entry-key / softkey of the wiki resource. |
will export the specified wiki (which must be a repo-entry-wiki) to a CP and serve as zip-file.<br />
available response representations:
This web service handles functionalities related to authentication credentials of users.
parameter | value | description |
---|---|---|
username |
The username of the user to retrieve authentication |
Creates and persists an authentication
acceptable request representations:
available response representations:
available response representations:
available response representations:
available response representations:
available response representations:
Returns all user authentications
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
username |
The username of the user to retrieve authentication |
|
authKey |
The authentication key identifier |
|
username |
The username of the user |
parameter | value | description |
---|---|---|
username |
The username of the user to retrieve authentication |
|
username |
The username of the user to change the password |
Change the password of a user.
acceptable request representations:
available response representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
username |
The username of the user to retrieve authentication |
The version of the User Authentication Web Service
available response representations:
<h3>Description:</h3> REST API for notifications <p> Initial Date: 25 aug 2010 <br>
Retrieves the notification of the logged in user.
parameter | value | description |
---|---|---|
date |
The date (optional) |
|
type |
The type of notifications (User, Forum...) (optional) |
available response representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
subscriberKey |
parameter | value | description |
---|---|---|
ressourceId |
||
subIdentifier |
||
ressourceName |
parameter | value | description |
---|---|---|
package |
||
key |
parameter | value | description |
---|---|---|
locale |
available response representations:
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
managed |
||
externalId |
||
externalRef |
||
resourceType |
available response representations:
parameter | value | description |
---|---|---|
type |
||
author |
Default: * |
|
name |
Default: * |
|
myentries |
Default: false |
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
identityKey |
||
repoEntryKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
identityKey |
||
repoEntryKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
identityKey |
||
repoEntryKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
||
lectureBlockKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
||
lectureBlockKey |
||
identityKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
||
lectureBlockKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
||
lectureBlockKey |
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
||
lectureBlockKey |
Description:<br> This handles the contact building block. <P> Initial Date: 10 mai 2010 <br>
parameter | value | description |
---|---|---|
courseId |
This attaches a contact element onto a given course, the element will be inserted underneath the supplied parentNodeId
parameter | value | description |
---|---|---|
parentNodeId |
The node's id which will be the parent of this structure |
|
position |
The node's position relative to its sibling nodes (optional) |
|
shortTitle |
Default: undefined |
The node short title |
longTitle |
Default: undefined |
The node long title |
objectives |
Default: undefined |
The node learning objectives |
visibilityExpertRules |
The rules to view the node (optional) |
|
accessExpertRules |
The rules to access the node (optional) |
|
coaches |
Default: false |
Send to coaches (true/false) |
participants |
Default: false |
Send to participants (true/false) |
groups |
A list of learning groups (list of keys) |
|
areas |
A list of learning areas (list of keys) |
|
to |
The list of e-mail address |
|
defaultSubject |
The default subject |
|
defaultBody |
The default body text |
available response representations:
available response representations:
available response representations:
This attaches a contact element onto a given course, the element will be inserted underneath the supplied parentNodeId
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
filename |
parameter | value | description |
---|---|---|
filename |
Description:<br> This handles the enrollment building block. <P> Initial Date: 10 mai 2010 <br>
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
This attaches an enrollment element onto a given course, the element will be inserted underneath the supplied parentNodeId
parameter | value | description |
---|---|---|
parentNodeId |
The node's id which will be the parent of this structure |
|
position |
The node's position relative to its sibling nodes (optional) |
|
shortTitle |
Default: undefined |
The node short title |
longTitle |
Default: undefined |
The node long title |
objectives |
Default: undefined |
The node learning objectives |
visibilityExpertRules |
The rules to view the node (optional) |
|
accessExpertRules |
The rules to access the node (optional) |
|
groups |
A list of learning groups (list of keys) |
|
cancelEnabled |
Default: false |
cancel enrollment enabled or not |
available response representations:
available response representations:
available response representations:
This attaches an enrollment element onto a given course, the element will be inserted underneath the supplied parentNodeId
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
nodeId |
Retrieves the groups where the enrollment happens
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
path |
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
available response representations:
parameter | value | description |
---|---|---|
path |
||
identityKey |
parameter | value | description |
---|---|---|
path |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
name |
||
description |
||
type |
||
repoEntryKey |
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
newParentKey |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
name |
||
description |
||
newParentKey |
available response representations:
parameter | value | description |
---|---|---|
path |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
date |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
from |
||
to |
||
lastSamples |
available response representations:
acceptable request representations:
available response representations:
Description:<br> Web service to trigger the registration process <P> Initial Date: 14 juil. 2011 <br>
Register with the specified email
parameter | value | description |
---|---|---|
|
The email address |
available response representations:
available response representations:
Register with the specified email
acceptable request representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
path |
||
repoEntryKey |
parameter | value | description |
---|---|---|
repoEntryKey |
parameter | value | description |
---|---|---|
repoEntryKey |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
path |
parameter | value | description |
---|---|---|
repoEntryKey |
Description:<br> Web service to manage forums. <P> Initial Date: 26 aug. 2010 <br>
Description:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>
parameter | value | description |
---|---|---|
forumKey |
The key of the forum |
Retrieves the forum.
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
forumKey |
The key of the forum |
Retrieves the threads in the forum
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name,creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
Creates a new thread in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
forumKey |
The key of the forum |
|
threadKey |
The key of the thread |
Retrieves the messages in the thread
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
orderBy |
Default: creationDate |
(value name, creationDate) |
asc |
Default: true |
(value true/false) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
forumKey |
The key of the forum |
|
messageKey |
The id of the reply message |
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
available response representations:
available response representations:
Creates a new reply in the forum of the course node
parameter | value | description |
---|---|---|
title |
The title for the first post in the thread |
|
body |
The body for the first post in the thread |
|
authorKey |
The author user key (optional) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
forumKey |
The key of the forum |
|
messageKey |
The key of the message |
Retrieves the attachments of the message
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
acceptable request representations:
available response representations:
available response representations:
Upload the attachment of a message, as parameter:<br> filename The name of the attachment<br> file The attachment.
available response representations:
available response representations:
parameter | value | description |
---|---|---|
forumKey |
The key of the forum |
|
messageKey |
The identity key of the user being searched |
|
filename |
The name of the attachment |
Retrieves the attachment of the message
available response representations:
available response representations:
parameter | value | description |
---|---|---|
username |
parameter | value | description |
---|---|---|
password |
||
x-olat-token |
available response representations:
This web service handles functionalities related to <code>User</code>.
Creates and persists a new user entity
acceptable request representations:
available response representations:
available response representations:
available response representations:
Search users and return them in a simple form (without user properties). User properties can be added two the query parameters. If the authUsername and the authProvider are set, the search is made only with these two parameters because they are sufficient to return a single user.<br> The search with login and user properties are made default with wild cards. If an exact match is needed, the parameter msut be quoted:<br> users?login="username"<br> Don't forget the right escaping in the URL!<br> You can make a search with the user properties like this:<br> users?telMobile=39847592&login=test
parameter | value | description |
---|---|---|
login |
||
authProvider |
||
authUsername |
||
statusVisibleLimit |
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The user key identifier of the user being searched |
Update an user
acceptable request representations:
available response representations:
available response representations:
available response representations:
available response representations:
Delete an user from the system
available response representations:
available response representations:
available response representations:
Retrieves an user given its unique key identifier
parameter | value | description |
---|---|---|
withPortrait |
Default: false |
If true return the portrait as Base64 (default false) |
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The identity key identifier of the user being searched |
Retrieves the portrait of an user
available response representations:
available response representations:
Retrieves the portrait of an user
available response representations:
available response representations:
Upload the portrait of an user
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The user key identifier of the user being searched |
Retrieves the status of a user given its unique key identifier
available response representations:
available response representations:
available response representations:
Update the roles of a user given its unique key identifier: <ul> <li>1: Permanent user</li> <li>2: activ</li> <li>101: login denied</li> <li>199: deleted</li> </ul>
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The user key identifier of the user being searched |
Retrieves the roles of a user given its unique key identifier
available response representations:
available response representations:
available response representations:
Update the roles of a user given its unique key identifier
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The user key identifier of the user being searched |
Retrieves the preferences of a user given its unique key identifier
available response representations:
available response representations:
available response representations:
Update the preferences of a user given its unique key identifier
acceptable request representations:
available response representations:
available response representations:
available response representations:
parameter | value | description |
---|---|---|
size |
||
identityKey |
Retrieves the portrait of an user
available response representations:
available response representations:
Description:<br> <P> Initial Date: 16 déc. 2011 <br>
parameter | value | description |
---|---|---|
identityKey |
Retrieves a list of folders on a user base. All folders of groups where the user is participant/tutor + all folders in course where the user is a participant (owner, tutor or participant)
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
||
courseKey |
||
courseNodeId |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
||
courseKey |
||
courseNodeId |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
||
courseKey |
||
courseNodeId |
||
path |
parameter | value | description |
---|---|---|
identityKey |
||
courseKey |
||
courseNodeId |
parameter | value | description |
---|---|---|
identityKey |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
||
path |
parameter | value | description |
---|---|---|
identityKey |
parameter | value | description |
---|---|---|
identityKey |
||
groupKey |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
||
groupKey |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
||
groupKey |
||
path |
parameter | value | description |
---|---|---|
identityKey |
||
groupKey |
parameter | value | description |
---|---|---|
identityKey |
parameter | value | description |
---|---|---|
identityKey |
Retrieves the list of "My entries" but limited to courses.
parameter | value | description |
---|---|---|
start |
Default: 0 |
The first result |
limit |
Default: 25 |
Max result |
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
Retrieves the list of "My supervised courses" but limited to courses.
parameter | value | description |
---|---|---|
start |
Default: 0 |
The first result |
limit |
Default: 25 |
Max result |
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
Retrieves the list of my favorite courses.
parameter | value | description |
---|---|---|
start |
Default: 0 |
The first result |
limit |
Default: 25 |
Max result |
available response representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
externalId |
||
managed |
available response representations:
parameter | value | description |
---|---|---|
identityKey |
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
externalId |
||
managed |
available response representations:
parameter | value | description |
---|---|---|
identityKey |
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
externalId |
||
managed |
available response representations:
parameter | value | description |
---|---|---|
identityKey |
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
|
externalId |
||
managed |
available response representations:
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
available response representations:
parameter | value | description |
---|---|---|
courseId |
Description:<br> <P> Initial Date: 21 oct. 2011 <br>
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
displayType |
Default: toc |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
filename |
||
path |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
text |
||
points |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
testResourceableId |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
wikiResourceableId |
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
wikiResourceableId |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
repoEntry |
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
repoEntry |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
surveyResourceableId |
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
surveyResourceableId |
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
||
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
url |
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
url |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
parameter | value | description |
---|---|---|
enableAssignment |
||
taskAssignmentType |
||
taskAssignmentText |
||
enableTaskPreview |
||
enableTaskDeselect |
||
onlyOneUserPerTask |
||
enableDropbox |
||
enableDropboxConfirmationMail |
||
dropboxConfirmationText |
||
enableReturnbox |
||
enableScoring |
||
grantScoring |
||
scoreMin |
||
scoreMax |
||
grantPassing |
||
scorePassingThreshold |
||
enableCommentField |
||
commentForUser |
||
commentForCoaches |
||
enableSolution |
||
accessExpertRuleTask |
||
accessExpertRuleDropbox |
||
accessExpertRuleReturnbox |
||
accessExpertRuleScoring |
||
accessExpertRuleSolution |
available response representations:
parameter | value | description |
---|---|---|
enableAssignment |
||
taskAssignmentType |
||
taskAssignmentText |
||
enableTaskPreview |
||
enableTaskDeselect |
||
onlyOneUserPerTask |
||
enableDropbox |
||
enableDropboxConfirmationMail |
||
dropboxConfirmationText |
||
enableReturnbox |
||
enableScoring |
||
grantScoring |
||
scoreMin |
||
scoreMax |
||
grantPassing |
||
scorePassingThreshold |
||
enableCommentField |
||
commentForUser |
||
commentForCoaches |
||
enableSolution |
||
accessExpertRuleTask |
||
accessExpertRuleDropbox |
||
accessExpertRuleReturnbox |
||
accessExpertRuleScoring |
||
accessExpertRuleSolution |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
parameter | value | description |
---|---|---|
allowCancel |
Default: false |
|
allowNavigation |
Default: false |
|
allowSuspend |
Default: false |
|
sequencePresentation |
Default: itemPage |
|
showNavigation |
Default: true |
|
showQuestionTitle |
Default: true |
|
showSectionsOnly |
Default: false |
available response representations:
parameter | value | description |
---|---|---|
allowCancel |
Default: false |
|
allowNavigation |
Default: false |
|
allowSuspend |
Default: false |
|
sequencePresentation |
Default: itemPage |
|
showNavigation |
Default: true |
|
showQuestionTitle |
Default: true |
|
showSectionsOnly |
Default: false |
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
parameter | value | description |
---|---|---|
allowCancel |
Default: false |
|
allowNavigation |
Default: false |
|
allowSuspend |
Default: false |
|
numAttempts |
Default: 0 |
|
sequencePresentation |
Default: itemPage |
|
showNavigation |
Default: true |
|
showQuestionTitle |
Default: true |
|
showResultsAfterFinish |
Default: true |
|
showResultsDependendOnDate |
Default: false |
|
showResultsOnHomepage |
Default: false |
|
showScoreInfo |
Default: true |
|
showQuestionProgress |
Default: true |
|
showScoreProgress |
Default: true |
|
showSectionsOnly |
Default: false |
|
summaryPresentation |
Default: summaryCompact |
|
startDate |
||
endDate |
available response representations:
parameter | value | description |
---|---|---|
allowCancel |
Default: false |
|
allowNavigation |
Default: false |
|
allowSuspend |
Default: false |
|
numAttempts |
Default: 0 |
|
sequencePresentation |
Default: itemPage |
|
showNavigation |
Default: true |
|
showQuestionTitle |
Default: true |
|
showResultsAfterFinish |
Default: true |
|
showResultsDependendOnDate |
Default: false |
|
showResultsOnHomepage |
Default: false |
|
showScoreInfo |
Default: true |
|
showQuestionProgress |
Default: true |
|
showScoreProgress |
Default: true |
|
showSectionsOnly |
Default: false |
|
summaryPresentation |
Default: summaryCompact |
|
startDate |
||
endDate |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The folder node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?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 course node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The folder node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The folder node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<folder name="Course folder" courseKey="375397" courseNodeId="438950850389" subscribed="true" write="false" read="false" list="false" delete="false"/>
The course node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?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
The roles of the authenticated user are not sufficient
The forum not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
The links to the attachments
The message not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
The portrait as image
The identity or the portrait not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroBookingVO>
<bookingId>23</bookingId>
<groupId>24</groupId>
<groupName>NEW-EVENT_OLAT_938745983</groupName>
<eventName>New event</eventName>
<externalId>AC-234</externalId>
<start>2017-07-20T10:13:15.641+02:00</start>
<startBuffer>15</startBuffer>
<end>2017-07-20T10:13:15.641+02:00</end>
<endBuffer>15</endBuffer>
<roomSize>22</roomSize>
<autoSignIn>true</autoSignIn>
<timeZoneId></timeZoneId>
</viteroBookingVO>
This is the list of all bookings of a resource
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroBookingVO>
<bookingId>23</bookingId>
<groupId>24</groupId>
<groupName>NEW-EVENT_OLAT_938745983</groupName>
<eventName>New event</eventName>
<externalId>AC-234</externalId>
<start>2017-07-20T10:13:15.641+02:00</start>
<startBuffer>15</startBuffer>
<end>2017-07-20T10:13:15.641+02:00</end>
<endBuffer>15</endBuffer>
<roomSize>22</roomSize>
<autoSignIn>true</autoSignIn>
<timeZoneId></timeZoneId>
</viteroBookingVO>
The created booking
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroBookingVO>
<bookingId>23</bookingId>
<groupId>24</groupId>
<groupName>NEW-EVENT_OLAT_938745983</groupName>
<eventName>New event</eventName>
<externalId>AC-234</externalId>
<start>2017-07-20T10:13:15.641+02:00</start>
<startBuffer>15</startBuffer>
<end>2017-07-20T10:13:15.641+02:00</end>
<endBuffer>15</endBuffer>
<roomSize>22</roomSize>
<autoSignIn>true</autoSignIn>
<timeZoneId></timeZoneId>
</viteroBookingVO>
The created booking
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroGroupMemberVO>
<identityKey>23497</identityKey>
<groupRole>participant</groupRole>
</viteroGroupMemberVO>
This is the list of all bookings of a resource
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroGroupMemberVO>
<identityKey>23497</identityKey>
<groupRole>participant</groupRole>
</viteroGroupMemberVO>
This is the list of all bookings of a resource
The booking is deleted
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<trainingVO>
<key>4534759</key>
<name>Training</name>
<externalId>AC-234</externalId>
<start>2017-07-20T10:13:15.633+02:00</start>
<end>2017-07-20T10:13:15.633+02:00</end>
</trainingVO>
This is the list of all training of a resource
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<trainingVO>
<key>4534759</key>
<name>Training</name>
<externalId>AC-234</externalId>
<start>2017-07-20T10:13:15.633+02:00</start>
<end>2017-07-20T10:13:15.633+02:00</end>
</trainingVO>
Created a training
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<trainingVO>
<key>4534759</key>
<name>Training</name>
<externalId>AC-234</externalId>
<start>2017-07-20T10:13:15.633+02:00</start>
<end>2017-07-20T10:13:15.633+02:00</end>
</trainingVO>
The created booking
The training is deleted
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroBookingVO>
<bookingId>23</bookingId>
<groupId>24</groupId>
<groupName>NEW-EVENT_OLAT_938745983</groupName>
<eventName>New event</eventName>
<externalId>AC-234</externalId>
<start>2017-07-20T10:13:15.641+02:00</start>
<startBuffer>15</startBuffer>
<end>2017-07-20T10:13:15.641+02:00</end>
<endBuffer>15</endBuffer>
<roomSize>22</roomSize>
<autoSignIn>true</autoSignIn>
<timeZoneId></timeZoneId>
</viteroBookingVO>
This is the list of all bookings of a resource
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroBookingVO>
<bookingId>23</bookingId>
<groupId>24</groupId>
<groupName>NEW-EVENT_OLAT_938745983</groupName>
<eventName>New event</eventName>
<externalId>AC-234</externalId>
<start>2017-07-20T10:13:15.641+02:00</start>
<startBuffer>15</startBuffer>
<end>2017-07-20T10:13:15.641+02:00</end>
<endBuffer>15</endBuffer>
<roomSize>22</roomSize>
<autoSignIn>true</autoSignIn>
<timeZoneId></timeZoneId>
</viteroBookingVO>
The created booking
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroBookingVO>
<bookingId>23</bookingId>
<groupId>24</groupId>
<groupName>NEW-EVENT_OLAT_938745983</groupName>
<eventName>New event</eventName>
<externalId>AC-234</externalId>
<start>2017-07-20T10:13:15.641+02:00</start>
<startBuffer>15</startBuffer>
<end>2017-07-20T10:13:15.641+02:00</end>
<endBuffer>15</endBuffer>
<roomSize>22</roomSize>
<autoSignIn>true</autoSignIn>
<timeZoneId></timeZoneId>
</viteroBookingVO>
The created booking
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroGroupMemberVO>
<identityKey>23497</identityKey>
<groupRole>participant</groupRole>
</viteroGroupMemberVO>
This is the list of all bookings of a resource
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viteroGroupMemberVO>
<identityKey>23497</identityKey>
<groupRole>participant</groupRole>
</viteroGroupMemberVO>
This is the list of all bookings of a resource
The booking is deleted
<?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
The roles of the authenticated user are not sufficient
The forum not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
The links to the attachments
The message not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
The portrait as image
The identity or the portrait not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<keyValuePair>
<key>Prefered color</key>
<value>Green</value>
</keyValuePair>
The value in the course
The entry cannot be found
Green
A value of the course
The entry cannot be found
The value is saved in the course
the key value pair is remove from the db
The roles of the authenticated user are not sufficient
The entry cannot be found
The value is saved in the course
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<keyValuePairVOes>
<keyValuePairVO>
<key>Prefered color</key>
<value>Green</value>
</keyValuePairVO>
</keyValuePairVOes>
All the values in the course
the key value pair is saved on the db
the key value pair is saved on the db
the key value pair is remove from the db
The roles of the authenticated user are not sufficient
The entry cannot be found
1.0
The version of this specific Web Service
<?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
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?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
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The forum not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
The links to the attachments
The message not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
The portrait as image
The identity or the portrait not found
<?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
The roles of the authenticated user are not sufficient
<?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
The roles of the authenticated user are not sufficient
The forum not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
The links to the attachments
The message not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
The portrait as image
The identity or the portrait not found
<?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
The roles of the authenticated user are not sufficient
The forum not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
The links to the attachments
The message not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
The portrait as image
The identity or the portrait not found
The certificate as file
The roles of the authenticated user are not sufficient
The owner or the certificate cannot be found
If the certificate was created
The roles of the authenticated user are not sufficient
An unexpected error happened during the creation of the certificate
The identity or the resource cannot be found
if the certificate was uploaded
The roles of the authenticated user are not sufficient
The identity or the resource cannot be found
The portrait as image
The identity or the portrait not found
<?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
The roles of the authenticated user are not sufficient
The identity not found
Cannot create the authentication for an unkown reason
Cannot create the authentication because the authentication username is already used by someone else within the same provider
<?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
The roles of the authenticated user are not sufficient
The identity not found
The authentication successfully deleted
The roles of the authenticated user are not sufficient
The identity or the authentication not found
The password successfully changed
The roles of the authenticated user are not sufficient
The password was not changed
The identity or the authentication not found
1.0
The version of this specific Web Service
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<subscriptionInfoVOes>
<subscriptionInfoVO>
<title>Infos</title>
<items/>
</subscriptionInfoVO>
</subscriptionInfoVOes>
The notifications
The identity not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node metadatas
The roles of the authenticated user are not sufficient
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
<key>123467</key>
<description>My group description</description>
<externalId>External Identifier</externalId>
<managedFlags>title,description</managedFlags>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</groupVO>
The groups
The roles of the authenticated user are not sufficient
The course or course node not found
Registration successful
Already registered, HTTP-Header location set to redirect
Registration successful
Already registered, HTTP-Header location set to redirect
1.0
The version of this specific Web Service
<?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
The roles of the authenticated user are not sufficient
The forum not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author, forum or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
<?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
The roles of the authenticated user are not sufficient
The author or message not found
The links to the attachments
The message not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
Ok
The identity or the portrait not found
The portrait as image
The identity or the portrait not found
<?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
The roles of the authenticated user are not sufficient
<?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
<?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
The roles of the authenticated user are not sufficient
<?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
The identity not found
<?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
The user is removed from the group
The roles of the authenticated user are not sufficient
The identity not found
<?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
The identity not found
The portrait as image
The identity or the portrait not found
The portrait as image
The identity or the portrait not found
The portrait as image
Not authorized
The identity or the portrait not found
The portrait deleted
Not authorized
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<statusVO>
<status>2</status>
</statusVO>
The user
The roles of the authenticated user are not sufficient
The identity not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rolesVO>
<olatAdmin>false</olatAdmin>
<userManager>false</userManager>
<groupManager>false</groupManager>
<author>true</author>
<guestOnly>false</guestOnly>
<institutionalResourceManager>false</institutionalResourceManager>
<poolAdmin>false</poolAdmin>
<invitee>false</invitee>
</rolesVO>
The user
The roles of the authenticated user are not sufficient
The identity not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rolesVO>
<olatAdmin>false</olatAdmin>
<userManager>false</userManager>
<groupManager>false</groupManager>
<author>true</author>
<guestOnly>false</guestOnly>
<institutionalResourceManager>false</institutionalResourceManager>
<poolAdmin>false</poolAdmin>
<invitee>false</invitee>
</rolesVO>
The user
The roles of the authenticated user are not sufficient
The identity not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rolesVO>
<olatAdmin>false</olatAdmin>
<userManager>false</userManager>
<groupManager>false</groupManager>
<author>true</author>
<guestOnly>false</guestOnly>
<institutionalResourceManager>false</institutionalResourceManager>
<poolAdmin>false</poolAdmin>
<invitee>false</invitee>
</rolesVO>
The user
The roles of the authenticated user are not sufficient
The identity not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<preferencesVO>
<language>de</language>
</preferencesVO>
The preferences
The roles of the authenticated user are not sufficient
The identity not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<preferencesVO>
<language>de</language>
</preferencesVO>
The user
The roles of the authenticated user are not sufficient
The identity not found
The portrait as image
The identity or the portrait not found
1.0
The version of this specific Web Service
<?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
The roles of the authenticated user are not sufficient
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courses totalCount="0">
<courses>
<course>
<key>777</key>
<softKey>internal_fx_cp</softKey>
<displayName>Demo course</displayName>
<repoEntryKey>27684</repoEntryKey>
<externalId>External identifier</externalId>
<externalRef>External reference</externalRef>
<managedFlags>title,description</managedFlags>
<title>Demo course</title>
</course>
</courses>
</courses>
The courses
The roles of the authenticated user are not sufficient
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courses totalCount="0">
<courses>
<course>
<key>777</key>
<softKey>internal_fx_cp</softKey>
<displayName>Demo course</displayName>
<repoEntryKey>27684</repoEntryKey>
<externalId>External identifier</externalId>
<externalRef>External reference</externalRef>
<managedFlags>title,description</managedFlags>
<title>Demo course</title>
</course>
</courses>
</courses>
The courses
The roles of the authenticated user are not sufficient
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courses totalCount="0">
<courses>
<course>
<key>777</key>
<softKey>internal_fx_cp</softKey>
<displayName>Demo course</displayName>
<repoEntryKey>27684</repoEntryKey>
<externalId>External identifier</externalId>
<externalRef>External reference</externalRef>
<managedFlags>title,description</managedFlags>
<title>Demo course</title>
</course>
</courses>
</courses>
The courses
The roles of the authenticated user are not sufficient
The list of contacts