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 OLAT, 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 OLAT.
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
).
OLAT 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 OLAT 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.
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
downloadExpertRules |
||
uploadExpertRules |
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
||
courseId |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
This interface provides course building capabilities from our REST API.
Initial Date: Feb 8, 2010 Time: 3:45:50 PM
The version of the Course Elements Web Service
available response representations:
parameter | value | description |
---|---|---|
nodeId |
The node's id |
|
courseId |
The course resourceable's id |
Retrieves metadata of the course node
available response representations:
parameter | value | description |
---|---|---|
nodeId |
The node's id of this structure |
|
courseId |
The course resourceable's id |
This updates a Structure Element onto a given course.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
This attaches a Structure Element onto a given course. The element will be inserted underneath the supplied parentNodeId.
acceptable request representations:
available response representations:
This attaches a Structure 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 |
||
displayType |
Default: toc |
available response representations:
parameter | value | description |
---|---|---|
nodeId |
||
courseId |
This updates a Single Page Element onto a given course.
parameter | value | description |
---|---|---|
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
This attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.
acceptable request representations:
available response representations:
This attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.
acceptable request representations:
available response representations:
This attaches a Single Page 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 single page |
|
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) |
acceptable request representations:
available response representations:
This attaches a Single Page 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 single page |
|
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) |
|
filename |
The single page file name |
|
path |
available response representations:
parameter | value | description |
---|---|---|
nodeId |
The node's id of this task |
|
courseId |
The course resourceable id |
This updates a Task Element onto a given course.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable id |
This attaches a Task Element onto a given course. The element will be inserted underneath the supplied parentNodeId.
acceptable request representations:
available response representations:
This attaches a Task 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 task |
|
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) |
|
text |
The task node text |
|
points |
The task node's possible points |
available response representations:
parameter | value | description |
---|---|---|
nodeId |
||
courseId |
This updates a Test Element onto a given course.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable id |
This attaches a Test Element onto a given course. The element will be inserted underneath the supplied parentNodeId.
acceptable request representations:
available response representations:
This attaches a Test 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 test |
|
position |
The test node's id which is retorned in the response of the import test resource |
|
shortTitle |
Default: undefined |
The node's position relative to its sibling nodes (optional) |
longTitle |
Default: undefined |
The node short title |
objectives |
Default: undefined |
The node long title |
visibilityExpertRules |
The node learning objectives |
|
accessExpertRules |
The rules to view the node (optional) |
|
testResourceableId |
The rules to access the node (optional) |
available response representations:
parameter | value | description |
---|---|---|
nodeId |
The node's id of this assessment |
|
courseId |
The course resourceable's id |
Updates an assessment building block.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
Attaches an assessment building block.
acceptable request representations:
available response representations:
Attaches an assessment building block.
parameter | value | description |
---|---|---|
parentNodeId |
The node's id which will be the parent of this assessment |
|
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) |
available response representations:
parameter | value | description |
---|---|---|
nodeId |
The node's id which of this wiki |
|
courseId |
The course resourceable's id |
Attaches an wiki building block.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
Attaches an wiki building block.
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
wikiResourceableId |
available response representations:
Attaches an wiki building block.
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
wikiResourceableId |
available response representations:
parameter | value | description |
---|---|---|
nodeId |
The node's id of this blog |
|
courseId |
The course resourceable's id |
Update an blog building block.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
Attaches an blog building block.
parameter | value | description |
---|---|---|
parentNodeId |
The node's id which will be the parent of this assessment |
|
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) |
|
repoEntry |
The softkey of the blog resourceable (optional) |
available response representations:
Attaches an blog building block.
parameter | value | description |
---|---|---|
parentNodeId |
The node's id which will be the parent of this assessment |
|
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) |
|
repoEntry |
The softkey of the blog resourceable (optional) |
available response representations:
parameter | value | description |
---|---|---|
nodeId |
The node's id which will be the parent of this assessment |
|
courseId |
The course resourceable's id |
Attaches an survey building block.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
Attaches an survey building block.
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
The node's position relative to its sibling nodes (optional) |
longTitle |
Default: undefined |
The node short title |
objectives |
Default: undefined |
The node long title |
visibilityExpertRules |
The node learning objectives |
|
accessExpertRules |
The rules to view the node (optional) |
|
surveyResourceableId |
The rules to access the node (optional) |
available response representations:
Attaches an survey building block.
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
surveyResourceableId |
available response representations:
parameter | value | description |
---|---|---|
parentNodeId |
The node's id of this external page |
|
courseId |
The course resourceable's id |
Update an external page building block.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
Attaches an external page building block.
parameter | value | description |
---|---|---|
parentNodeId |
The node's id which will be the parent of this assessment |
|
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) |
|
url |
The URL of the external page |
available response representations:
Attaches an external page building block.
parameter | value | description |
---|---|---|
parentNodeId |
The node's id which will be the parent of this assessment |
|
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) |
|
url |
The URL of the external page |
available response representations:
parameter | value | description |
---|---|---|
nodeId |
||
courseId |
This attaches a Task file onto a given task element.
acceptable request representations:
available response representations:
This attaches a Task file onto a given task element.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
nodeId |
||
courseId |
This attaches the run-time configuration onto a given task element.
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:
This attaches the run-time configuration onto a given task element.
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:
Retrieves configuration of the task course node
available response representations:
parameter | value | description |
---|---|---|
nodeId |
||
courseId |
This attaches the run-time configuration onto a given survey element.
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:
This attaches the run-time configuration onto a given survey element.
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:
Retrieves configuration of the survey course node
available response representations:
parameter | value | description |
---|---|---|
nodeId |
||
courseId |
This attaches the run-time configuration onto a given test element.
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:
This attaches the run-time configuration onto a given test element.
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:
Retrieves configuration of the test course node
available response representations:
Description:
Initial Date: 21 oct. 2011
Retrieve the contacts of the logged in identity.
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
available response representations:
Initial Date: 25 aug 2010
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:
Description:
This will handle the resources folders in the course: the course storage folder
and the shared folder. The course folder has a read-write access but the shared
folder can only be read.
Initial Date: 26 apr. 2010
The version of the resources folders Web Service
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
This retrieves the files in the shared folder
available response representations:
parameter | value | description |
---|---|---|
path |
||
courseId |
The course resourceable's id |
This retrieves the files in the shared folder
available response representations:
parameter | value | description |
---|---|---|
courseId |
This retrieves the files in the course folder
available response representations:
This attaches the uploaded file(s) to the supplied folder id.
acceptable request representations:
available response representations:
This attaches the uploaded file(s) to the supplied folder id at the root level
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
path |
||
courseId |
This retrieves the files in the course folder
available response representations:
This attaches the uploaded file(s) to the supplied folder id.
acceptable request representations:
available response representations:
This attaches the uploaded file(s) to the supplied folder id at the root level
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 |
||
groups |
||
cancelEnabled |
Default: false |
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
||
courseId |
Description:
This handles the repository entries
Initial Date: 19.05.2009
List all entries in the OLAT repository
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
available response representations:
List all entries in the OLAT repository
available response representations:
Import a resource in the repository
acceptable request representations:
available response representations:
Search for repository entries, possible search attributes are name, author and type
parameter | value | description |
---|---|---|
type |
Filter by the file resource type of the repository entry |
|
author |
Default: * |
Filter by the author's username |
name |
Default: * |
Filter by name of repository entry |
myentries |
Default: false |
Only search entries the requester owns |
available response representations:
Description:
Repository entry resource
Initial Date: 19.05.2009
parameter | value | description |
---|---|---|
repoEntryKey |
Delete a course by id
available response representations:
get a resource in the repository
available response representations:
Replace a resource in the repository and update its display name. The implementation is limited to CP.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
repoEntryKey |
||
repoEntryKey |
Download the export zip file of a repository entry.
available response representations:
Get courses informations viewable by the authenticated user
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
available response representations:
Description:
This web service will handle the functionality related to Course
and its contents.
Initial Date: 27 apr. 2010
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
Get the metadatas of the course by id
available response representations:
Delete a course by id
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
The version of the Course Web Service
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
The course resourceable's id |
Get the configuration of the course
available response representations:
Update the course configuration
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
The course resourceable's id |
Get all owners and authors of the course
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
The course resourceable's id |
Publish the course.
parameter | value | description |
---|---|---|
locale |
The course locale |
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
Export the course
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
The course resourceable's id |
Get the runstructure of the course by id
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
The course resourceable's id |
Get the editor tree model of the course by id
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
identityKey |
The user identifier |
|
courseId |
The course resourceable's id |
Get this specific author and owner of the course
available response representations:
Add an owner and author to the course
available response representations:
Remove an owner and author to the course
available response representations:
Description:
CourseGroupWebService
Initial Date: 7 apr. 2010
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
Lists all learn groups of the specified course.
available response representations:
Creates a new group for the course.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
Retrieves the version of the Course Group Web Service.
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
groupKey |
The group's id |
Retrieves the metadata of the specified group.
available response representations:
Deletes the business group specified by the key of the group.
available response representations:
Updates the metadata for the specified group.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
Fallback method for the browser.
acceptable request representations:
available response representations:
Description:
Web service to manage a forum.
Initial Date: 20 apr. 2010
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
groupKey |
The key of the group |
Retrieves the forum.
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
groupKey |
The key of the group |
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:
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:
Creates a new thread in the forum of the course node
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
groupKey |
The key of the group |
|
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:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
groupKey |
The key of the group |
|
messageKey |
The id of the reply message |
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
Creates a new reply in the forum of the course node
acceptable request 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:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
groupKey |
The key of the group |
|
messageKey |
Retrieves the attachments of the message
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
groupKey |
The key of the group |
|
filename |
The name of the attachment |
|
messageKey |
The identity key of the user being searched |
Retrieves the attachment of the message
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
courseId |
||
groupKey |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
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 |
||
groupKey |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
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 |
||
groupKey |
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:
Returns all user authentications
available response representations:
parameter | value | description |
---|---|---|
username |
The username of the user to retrieve authentication |
|
username |
The username of the user |
|
authKey |
The authentication key identifier |
Deletes an authentication from the system
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:
parameter | value | description |
---|---|---|
username |
The username of the user to retrieve authentication |
|
username |
The username of the user |
Fallback method for browsers
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
username |
The username of the user to retrieve authentication |
|
username |
The username of the user |
|
authKey |
The authentication key identifier |
Fallback method for browsers
available response representations:
Description:
Initial Date: 6 déc. 2011
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:
Description:
Web service to manage a forum.
Initial Date: 20 apr. 2010
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
Retrieves the forum.
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:
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:
Creates a new thread in the forum of the course node
acceptable request 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:
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:
Creates a new reply in the forum of the course node
acceptable request 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:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
||
messageKey |
Retrieves the attachments of the message
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
||
filename |
The name of the attachment |
|
messageKey |
The identity key of the user being searched |
Retrieves the attachment of the message
available response representations:
Description:
Web service to manage a forum.
Initial Date: 20 apr. 2010
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
Retrieves the forum.
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:
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:
Creates a new thread in the forum of the course node
acceptable request 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:
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:
Creates a new reply in the forum of the course node
acceptable request 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:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
||
messageKey |
Retrieves the attachments of the message
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
||
filename |
The name of the attachment |
|
messageKey |
The identity key of the user being searched |
Retrieves the attachment of the message
available response representations:
Description:
Authenticate against OLAT Provider
Initial Date: 7 apr. 2010
Retrieves the version of the User Authentication Web Service
available response representations:
parameter | value | description |
---|---|---|
username |
The username |
Authenticates against OLAT Provider and provides a security token if authentication is successful. The security token is returned as a header named X-OLAT-TOKEN. Given that the password is sent in clear text and not encrypted, it is not advisable to use this service over a none secure connection (https).
parameter | value | description |
---|---|---|
password |
The password (the password is in clear text, not encrypted) |
available response representations:
This web service handles functionalities related to User
.
Creates and persists a new user entity
acceptable request 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.
parameter | value | description |
---|---|---|
login |
The login (search with like) |
|
authProvider |
An authentication provider (optional) |
|
authUsername |
An specific username from the authentication provider |
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The user key identifier of the user being searched |
Delete an user from the system
available response representations:
Update an user
acceptable request 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:
The version of the User Web Service
available response representations:
Fallback method for browser
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The user key identifier |
Fallback method for browsers
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:
Upload the portrait of an user
acceptable request representations:
available response representations:
Deletes the portrait of an user
available response representations:
Description:
Initial Date: 18 oct. 2011
parameter | value | description |
---|---|---|
identityKey |
Return all groups of a user
parameter | value | description |
---|---|---|
start |
Default: 0 |
The first result |
limit |
Default: 25 |
The maximum results |
available response representations:
parameter | value | description |
---|---|---|
identityKey |
Return all groups with information of a user. Paging is mandatory!
parameter | value | description |
---|---|---|
start |
Default: 0 |
The first result |
limit |
Default: 25 |
The maximum results |
available response representations:
Description:
Retrieve and import course assessments
Initial Date: 7 apr. 2010
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
Returns the results of the course.
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
Retireves the version of the Course Assessment Web Service.
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
identityKey |
The id of the user |
|
courseId |
The course resourceable's id |
Returns the results of the course.
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
nodeId |
The id of the course building block |
|
courseId |
The resourceable id of the course |
Exports results for an assessable course node for all students.
available response representations:
Imports results for an assessable course node for the authenticated student.
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
The course resourceable's id |
|
nodeId |
The ident of the course building block |
|
identityKey |
The id of the user |
|
courseId |
The course resourceable's id |
Returns the results of a student at a specific assessable node
available response representations:
Description:
Web service to manage forums.
Initial Date: 26 aug. 2010
The version of the Forum Web Service
available response representations:
Description:
Web service to manage a forum.
Initial Date: 20 apr. 2010
parameter | value | description |
---|---|---|
forumKey |
The key of the forum |
Retrieves the forum.
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:
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:
Creates a new thread in the forum of the course node
acceptable request 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:
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:
Creates a new reply in the forum of the course node
acceptable request 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:
parameter | value | description |
---|---|---|
forumKey |
The key of the forum |
|
messageKey |
Retrieves the attachments of the message
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
forumKey |
The key of the forum |
|
filename |
The name of the attachment |
|
messageKey |
The identity key of the user being searched |
Retrieves the attachment of the message
available response representations:
Description:
A web service for the catalog
Initial Date: 5 may 2010
Returns the list of root catalog entries.
available response representations:
parameter | value | description |
---|---|---|
path |
The path |
|
identityKey |
The id of the user |
Retrieves data of an owner of the local sub tree
available response representations:
Add an owner of the local sub tree
available response representations:
Remove an owner of the local sub tree
available response representations:
Retrieves the version of the Catalog Web Service.
available response representations:
parameter | value | description |
---|---|---|
path |
The path |
Returns a list of catalog entries.
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
available response representations:
parameter | value | description |
---|---|---|
path |
The path |
Returns the metadata of the catalog entry.
available response representations:
Adds a catalog entry under the path specified in the URL.
parameter | value | description |
---|---|---|
name |
The name |
|
description |
The description |
|
type |
The type (leaf or node) |
|
repoEntryKey |
The id of the repository entry |
available response representations:
Adds a catalog entry under the path specified in the URL.
acceptable request representations:
available response representations:
Updates the catalog entry under the path specified in the URL.
acceptable request representations:
available response representations:
Updates the catalog entry with the path specified in the URL.
parameter | value | description |
---|---|---|
newParentKey |
acceptable request representations:
available response representations:
Updates the catalog entry with the path specified in the URL.
parameter | value | description |
---|---|---|
name |
||
description |
||
newParentKey |
available response representations:
Deletes the catalog entry with the path specified in the URL.
available response representations:
parameter | value | description |
---|---|---|
path |
The path |
Get the owners of the local sub tree
available response representations:
Description:
This web service handles the courses.
Initial Date: 27 apr. 2010
Get all courses viewable by the authenticated user
parameter | value | description |
---|---|---|
start |
Default: 0 |
|
limit |
Default: 25 |
available response representations:
Creates an empty course, or a copy from a course if the parameter copyFrom is set.
parameter | value | description |
---|---|---|
shortTitle |
The short title |
|
title |
The title |
|
sharedFolderSoftKey |
The repository entry key of a shared folder (optional) |
|
copyFrom |
The cours key to make a copy from (optional) |
available response representations:
The version of the Course Web Service
available response representations:
Description:
Ping to test the presence of the REST Api
Initial Date: 7 apr. 2010
The version of the Ping Web Service
available response representations:
parameter | value | description |
---|---|---|
name |
Description:
This handles the learning groups.
Initial Date: 23 mar. 2010
Return the list of all groups if you have group manager permission, or all learning group that you particip with or owne.
available response representations:
Retrieves the version of the Group Web Service.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
Return the group specified by the key of the group.
available response representations:
Updates a group.
acceptable request representations:
available response representations:
Deletes the business group specified by the groupKey.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
Returns the informations of the group specified by the groupKey.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
Returns the list of owners of the group specified by the groupKey.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
Returns the list of participants of the group specified by the groupKey.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
|
identityKey |
The user's id |
Adds an owner to the group.
available response representations:
Removes the owner from the group.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
|
identityKey |
The user's id |
Fallback method for browser.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
|
identityKey |
The user's id |
Fallback method for browser.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
|
identityKey |
The id of the user |
Adds a participant to the group.
available response representations:
Removes a participant from the group.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The id of the group |
|
identityKey |
The user's id |
Fallback method for browser.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
|
identityKey |
The id of the user |
Fallback method for browser.
available response representations:
Description:
Web service to manage a forum.
Initial Date: 20 apr. 2010
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
Retrieves the forum.
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
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:
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:
Creates a new thread in the forum of the course node
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
|
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:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
|
messageKey |
The id of the reply message |
Creates a new reply in the forum of the course node
acceptable request representations:
available response representations:
Creates a new reply in the forum of the course node
acceptable request 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:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
|
messageKey |
Retrieves the attachments of the message
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
The key of the group |
|
filename |
The name of the attachment |
|
messageKey |
The identity key of the user being searched |
Retrieves the attachment of the message
available response representations:
parameter | value | description |
---|---|---|
groupKey |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
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:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
groupKey |
Description:
Service for general informations on the OLAT REST Api.
Initial Date: 14 apr. 2010
Version number of the whole REST API of OLAT.
available response representations:
parameter | value | description |
---|---|---|
filename |
Returns images for the documentation of OLAT.
available response representations:
parameter | value | description |
---|---|---|
filename |
Returns images for the documentation of OLAT.
available response representations:
Returns the copyright of OLAT.
available response representations:
Description:
REST API implementation for forum course node
Initial Date: 20.12.2010
parameter | value | description |
---|---|---|
courseId |
Retrieves metadata of the published course node
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:
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:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
The node's id |
|
courseId |
The course resourceable's id |
Retrieves metadata of the published course node
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
The id of the course node. |
|
courseId |
The id of the course. |
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:
parameter | value | description |
---|---|---|
courseId |
||
nodeId |
The id of the course node. |
|
courseId |
The id of the course. |
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:
Description:
Web service to manage a forum.
Initial Date: 20 apr. 2010
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
Retrieves the forum.
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:
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:
Creates a new thread in the forum of the course node
acceptable request 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:
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:
Creates a new reply in the forum of the course node
acceptable request 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:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
||
messageKey |
Retrieves the attachments of the message
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
Upload the attachment of a message
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
courseId |
||
courseId |
||
nodeId |
||
filename |
The name of the attachment |
|
messageKey |
The identity key of the user being searched |
Retrieves the attachment of the message
available response representations:
Description:
This handles translations from the i18n module of OLAT.
Initial Date: 14 apr. 2010
Retrieves the version of the i18n Web Service.
available response representations:
parameter | value | description |
---|---|---|
package |
The name of the package |
|
key |
The key to translate |
Return the translation of the key. If the "locale" parameter is not specified, the method try to use the "locale" of the user and if it hasn't, take the default locale.
parameter | value | description |
---|---|---|
locale |
The locale (optional) |
available response representations:
parameter | value | description |
---|---|---|
courseId |
parameter | value | description |
---|---|---|
parentNodeId |
||
position |
||
shortTitle |
Default: undefined |
|
longTitle |
Default: undefined |
|
objectives |
Default: undefined |
|
visibilityExpertRules |
||
accessExpertRules |
||
coaches |
Default: false |
|
participants |
Default: false |
|
groups |
||
areas |
||
to |
||
defaultSubject |
||
defaultBody |
available response representations:
acceptable request representations:
available response representations:
Description:
This web service returns logFiles
Initial Date: 23.12.2011
The version of the Log Web Service
available response representations:
parameter | value | description |
---|---|---|
date |
Description:
Initial Date: 16 déc. 2011
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
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:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
identityKey |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
identityKey |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
identityKey |
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
groupKey |
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
||
path |
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
acceptable request representations:
available response representations:
parameter | value | description |
---|---|---|
identityKey |
The key of the user (IdentityImpl) |
|
courseKey |
||
courseNodeId |
1.0
The version of this specific Web Service
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"?>
<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"?>
<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"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node metadatas
The roles of the authenticated user are not sufficient
The course, parentNode or test not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The test node metadatas
The roles of the authenticated user are not sufficient
The course, parentNode or test not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The test node metadatas
The roles of the authenticated user are not sufficient
course, parentNode or test not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
the test 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"?>
<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"?>
<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"?>
<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 given URL is not valid
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 course node is not of type task
The roles of the authenticated user are not sufficient
The configuration is not valid
The course or task node not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The task node configuration
The call is not applicable to task course node
The roles of the authenticated user are not sufficient
The configuration is not valid
The course or task node not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The task node configuration
The call is not applicable to task course node
The roles of the authenticated user are not sufficient
The course or task node not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node configuration
The roles of the authenticated user are not sufficient
The configuration is not valid
The course or survey node not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The survey node configuration
The call is not applicable to survey course node
The roles of the authenticated user are not sufficient
The configuration is not valid
The course or survey node not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The survey node configuration
The call is not applicable to survey course node
The roles of the authenticated user are not sufficient
The course or survey node not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node configuration
The roles of the authenticated user are not sufficient
The configuration is not valid
The course or test node not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The test node configuration
The call is not applicable to test course node
The roles of the authenticated user are not sufficient
The configuration is not valid
The course or test node not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The test node configuration
The call is not applicable to test course node
The roles of the authenticated user are not sufficient
The course or test node not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseNodeVO>
<id>id</id>
</courseNodeVO>
The course node configuration
The roles of the authenticated user are not sufficient
The list of contacts
The identity not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<subscriptionInfoVOes>
<subscriptionInfoVO>
<title>Infos</title>
<items/>
</subscriptionInfoVO>
</subscriptionInfoVOes>
The notifications
1.0
The version of this specific Web Service
The course or the shared folder not found
The list of files
The roles of the authenticated user are not sufficient
The course or the shared folder not found
The list of files
The roles of the authenticated user are not sufficient
The course not found
The list of files
The roles of the authenticated user are not sufficient
The course or course node not found
The file is correctly saved
The course node is not acceptable to copy a file
The roles of the authenticated user are not sufficient
The course or course node not found
The file is correctly saved
The course node is not acceptable to copy a file
The roles of the authenticated user are not sufficient
The course not found
The list of files
The roles of the authenticated user are not sufficient
The course or course node not found
The file is correctly saved
The course node is not acceptable to copy a file
The roles of the authenticated user are not sufficient
The course or course node not found
The file is correctly saved
The course node is not acceptable to copy a file
The roles of the authenticated user are not sufficient
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntries totalCount="1">
<repositoryEntries>
<repositoryEntrie>
<key>479286</key>
<softkey>internal_cp</softkey>
<resourcename>fdhasl</resourcename>
<displayname>CP-demo</displayname>
<resourceableId>4368567</resourceableId>
<resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntrie>
</repositoryEntries>
</repositoryEntries>
List all entries in the repository
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntries totalCount="1">
<repositoryEntries>
<repositoryEntrie>
<key>479286</key>
<softkey>internal_cp</softkey>
<resourcename>fdhasl</resourcename>
<displayname>CP-demo</displayname>
<resourceableId>4368567</resourceableId>
<resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntrie>
</repositoryEntries>
</repositoryEntries>
List all entries in the repository
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
<key>479286</key>
<softkey>internal_cp</softkey>
<resourcename>fdhasl</resourcename>
<displayname>CP-demo</displayname>
<resourceableId>4368567</resourceableId>
<resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>
Import the resource and return the repository entry
The roles of the authenticated user are not sufficient
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
<key>479286</key>
<softkey>internal_cp</softkey>
<resourcename>fdhasl</resourcename>
<displayname>CP-demo</displayname>
<resourceableId>4368567</resourceableId>
<resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>
Search for repository entries
The roles of the authenticated user are not sufficient
The course not found
The metadatas of the created course
The roles of the authenticated user are not sufficient
The repository entry not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
<key>479286</key>
<softkey>internal_cp</softkey>
<resourcename>fdhasl</resourcename>
<displayname>CP-demo</displayname>
<resourceableId>4368567</resourceableId>
<resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>
Get the repository resource
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
<key>479286</key>
<softkey>internal_cp</softkey>
<resourcename>fdhasl</resourcename>
<displayname>CP-demo</displayname>
<resourceableId>4368567</resourceableId>
<resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>
Replace the resource and return the updated repository entry
The roles of the authenticated user are not sufficient
The resource is locked
The resource could not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryEntryVO>
<key>479286</key>
<softkey>internal_cp</softkey>
<resourcename>fdhasl</resourcename>
<displayname>CP-demo</displayname>
<resourceableId>4368567</resourceableId>
<resourceableTypeName>CourseModule</resourceableTypeName>
</repositoryEntryVO>
Download the repository entry as export zip file
Download of this resource is not possible
The roles of the authenticated user are not sufficient
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courses totalCount="0">
<courses>
<course>
<key>777</key>
<title>Demo course</title>
<displayName>Demo course</displayName>
</course>
</courses>
</courses>
List of visible courses
The course not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
<key>777</key>
<title>Demo course</title>
<displayName>Demo course</displayName>
</courseVO>
The metadatas of the created course
The course not found
The metadatas of the created course
The roles of the authenticated user are not sufficient
1.0
The version of this specific Web Service
The course not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
<sharedFolderSoftKey>head_1_olat_43985684395</sharedFolderSoftKey>
</courseVO>
The configuration of the course
The roles of the authenticated user are not sufficient
The course not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
<sharedFolderSoftKey>head_1_olat_43985684395</sharedFolderSoftKey>
</courseVO>
The metadatas of the created course
The roles of the authenticated user are not sufficient
The course not found
The array of authors
The roles of the authenticated user are not sufficient
The course not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
<key>777</key>
<title>Demo course</title>
<displayName>Demo course</displayName>
</courseVO>
The metadatas of the created course
The roles of the authenticated user are not sufficient
The course not found
The course as a ZIP file
Not authorized to export the course
The course not found
The run structure of the course
The roles of the authenticated user are not sufficient
The course not found
The editor tree model of the course
The roles of the authenticated user are not sufficient
The course not found or the user is not an onwer or author of the course
The author
The roles of the authenticated user are not sufficient
The course or the user not found
The user is an author and owner of the course
The roles of the authenticated user are not sufficient
The course or the user not found
The user was successfully removed as owner of the course
The roles of the authenticated user are not sufficient
The context of the group not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups totalCount="0">
<groups>
<group>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</group>
</groups>
</groups>
The list of all learning group of the course
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</groupVO>
The persisted group
The roles of the authenticated user are not sufficient
1.0
The version of this specific Web Service
The business group cannot be found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</groupVO>
This is the list of all groups in OLAT system
The business group cannot be found
The business group is deleted
The roles of the authenticated user are not sufficient
The business group cannot be found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</groupVO>
The saved group
The roles of the authenticated user are not sufficient
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</groupVO>
The persisted group
The roles of the authenticated user are not sufficient
The forum not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
The root message of the thread
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, 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 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 message not found
The links to the attachments
The identity or the portrait 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 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
<?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 or the authentication not found
The authentication successfully deleted
The roles of the authenticated user are not sufficient
1.0
The version of this specific Web Service
The identity 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 or the authentication not found
The authentication successfully deleted
The roles of the authenticated user are not sufficient
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
The forums
The roles of the authenticated user are not sufficient
The forum not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
The root message of the thread
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, 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 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 message not found
The links to the attachments
The identity or the portrait 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 forum not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
The root message of the thread
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, 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 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 message not found
The links to the attachments
The identity or the portrait 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
1.0
The version of this specific Web Service
The identity not found
<hello>Hello john</hello>
Say hello to the authenticated user, and give it a security token
The authentication has failed
<?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
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorVOes>
<errorVO>
<code>org.olat.restapi:error</code>
<translation>Hello world, there is an error</translation>
</errorVO>
</errorVOes>
The list of errors
The roles of the authenticated user are not sufficient
<?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
The identity not found
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
<?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 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
1.0
The version of this specific Web Service
<?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
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorVOes>
<errorVO>
<code>org.olat.restapi:error</code>
<translation>Hello world, there is an error</translation>
</errorVO>
</errorVOes>
The list of errors
The roles of the authenticated user are not sufficient
The identity not found
The user is removed from the group
The roles of the authenticated user are not sufficient
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 portrait deleted
Not authorized
The identity not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups totalCount="0">
<groups>
<group>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</group>
</groups>
</groups>
The groups of the user
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups totalCount="0">
<groups>
<group>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
<news><p>Hello world</p></news>
<forumKey>374589</forumKey>
<hasWiki>false</hasWiki>
<hasFolder>false</hasFolder>
</group>
</groups>
</groups>
The groups of the user
The request hasn't paging information
The course not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assessableResultsVOes>
<assessableResultsVO>
<identityKey>345</identityKey>
<score>34.0</score>
<passed>true</passed>
</assessableResultsVO>
</assessableResultsVOes>
Array of results for the whole the course
The roles of the authenticated user are not sufficient
1.0
The version of this specific Web Service
The identity or the course not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assessableResultsVO>
<identityKey>345</identityKey>
<score>34.0</score>
<passed>true</passed>
</assessableResultsVO>
The result of the course
The roles of the authenticated user are not sufficient
The course not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assessableResultsVOes>
<assessableResultsVO>
<identityKey>345</identityKey>
<score>34.0</score>
<passed>true</passed>
</assessableResultsVO>
</assessableResultsVOes>
Export all results of all user of the course
The roles of the authenticated user are not sufficient
The identity not found
Import successful
The roles of the authenticated user are not sufficient
The identity or the course not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assessableResultsVO>
<identityKey>345</identityKey>
<score>34.0</score>
<passed>true</passed>
</assessableResultsVO>
The result of a user at a specific node
The roles of the authenticated user are not sufficient
1.0
The version of this specific Web Service
The forum not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
The root message of the thread
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, 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 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 message not found
The links to the attachments
The identity or the portrait 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
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntries totalCount="0">
<catalogEntries>
<catalogEntry>
<key>478</key>
<name>Category</name>
<description>Description of the category</description>
<type>0</type>
</catalogEntry>
</catalogEntries>
</catalogEntries>
The list of roots catalog entries
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
<users>
<user>
<key>345</key>
<login>john</login>
<password></password>
<firstName>John</firstName>
<lastName>Smith</lastName>
<email>john.smith@frentix.com</email>
<properties>
<property>
<name>telPrivate</name>
<value>238456782</value>
</property>
<property>
<name>telMobile</name>
<value>238456782</value>
</property>
</properties>
</user>
</users>
</users>
The catalog entry
Not authorized
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
<users>
<user>
<key>345</key>
<login>john</login>
<password></password>
<firstName>John</firstName>
<lastName>Smith</lastName>
<email>john.smith@frentix.com</email>
<properties>
<property>
<name>telPrivate</name>
<value>238456782</value>
</property>
<property>
<name>telMobile</name>
<value>238456782</value>
</property>
</properties>
</user>
</users>
</users>
The catalog entry
Not authorized
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
<users>
<user>
<key>345</key>
<login>john</login>
<password></password>
<firstName>John</firstName>
<lastName>Smith</lastName>
<email>john.smith@frentix.com</email>
<properties>
<property>
<name>telPrivate</name>
<value>238456782</value>
</property>
<property>
<name>telMobile</name>
<value>238456782</value>
</property>
</properties>
</user>
</users>
</users>
The catalog entry
Not authorized
1.0
The version of this specific Web Service
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntries totalCount="0">
<catalogEntries>
<catalogEntry>
<key>478</key>
<name>Category</name>
<description>Description of the category</description>
<type>0</type>
</catalogEntry>
</catalogEntries>
</catalogEntries>
The list of catalog entries
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
<key>478</key>
<name>Category</name>
<description>Description of the category</description>
<type>0</type>
</catalogEntryVO>
The catalog entry
The path could not be resolved to a valid catalog entry
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
<key>478</key>
<name>Category</name>
<description>Description of the category</description>
<type>0</type>
</catalogEntryVO>
The catalog entry
Not authorized
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
<key>478</key>
<name>Category</name>
<description>Description of the category</description>
<type>0</type>
</catalogEntryVO>
The catalog entry
Not authorized
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
<key>478</key>
<name>Category</name>
<description>Description of the category</description>
<type>0</type>
</catalogEntryVO>
The catalog entry
Not authorized
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
<key>478</key>
<name>Category</name>
<description>Description of the category</description>
<type>0</type>
</catalogEntryVO>
The catalog entry
Not authorized
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
<key>478</key>
<name>Category</name>
<description>Description of the category</description>
<type>0</type>
</catalogEntryVO>
The catalog entry
Not authorized
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<catalogEntryVO>
<key>478</key>
<name>Category</name>
<description>Description of the category</description>
<type>0</type>
</catalogEntryVO>
The catalog entry
Not authorized
The path could not be resolved to a valid catalog entry
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
<users>
<user>
<key>345</key>
<login>john</login>
<password></password>
<firstName>John</firstName>
<lastName>Smith</lastName>
<email>john.smith@frentix.com</email>
<properties>
<property>
<name>telPrivate</name>
<value>238456782</value>
</property>
<property>
<name>telMobile</name>
<value>238456782</value>
</property>
</properties>
</user>
</users>
</users>
The catalog entry
Not authorized
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courses totalCount="0">
<courses>
<course>
<key>777</key>
<title>Demo course</title>
<displayName>Demo course</displayName>
</course>
</courses>
</courses>
List of visible courses
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<courseVO>
<key>777</key>
<title>Demo course</title>
<displayName>Demo course</displayName>
</courseVO>
The metadatas of the created course
The roles of the authenticated user are not sufficient
1.0
The version of this specific Web Service
Ping
Return a small string
1.0
The version of this specific Web Service
Ping
Return a small string
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups totalCount="0">
<groups>
<group>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</group>
</groups>
</groups>
This is the list of all groups in OLAT system
1.0
The version of this specific Web Service
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</groupVO>
A business group in the OLAT system
The business group cannot be found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupVO>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
</groupVO>
The saved business group
The roles of the authenticated user are not sufficient
The business group cannot be found
The business group is deleted
The roles of the authenticated user are not sufficient
The business group cannot be found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupInfoVO>
<key>123467</key>
<description>My group description</description>
<name>My group</name>
<minParticipants>0</minParticipants>
<maxParticipants>0</maxParticipants>
<news><p>Hello world</p></news>
<forumKey>374589</forumKey>
<hasWiki>false</hasWiki>
<hasFolder>false</hasFolder>
</groupInfoVO>
Participants of the business group
The business group cannot be found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
<users>
<user>
<key>345</key>
<login>john</login>
<password></password>
<firstName>John</firstName>
<lastName>Smith</lastName>
<email>john.smith@frentix.com</email>
<properties>
<property>
<name>telPrivate</name>
<value>238456782</value>
</property>
<property>
<name>telMobile</name>
<value>238456782</value>
</property>
</properties>
</user>
</users>
</users>
Owners of the business group
The business group cannot be found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users totalCount="0">
<users>
<user>
<key>345</key>
<login>john</login>
<password></password>
<firstName>John</firstName>
<lastName>Smith</lastName>
<email>john.smith@frentix.com</email>
<properties>
<property>
<name>telPrivate</name>
<value>238456782</value>
</property>
<property>
<name>telMobile</name>
<value>238456782</value>
</property>
</properties>
</user>
</users>
</users>
Participants of the business group
The business group or the user cannot be found
The user is added as owner of the group
The roles of the authenticated user are not sufficient
The business group or the user cannot be found
The user is removed as owner from the group
The roles of the authenticated user are not sufficient
The business group or the user cannot be found
The user is added as owner of the group
The roles of the authenticated user are not sufficient
The business group or the user cannot be found
The user is removed as owner from the group
The roles of the authenticated user are not sufficient
The business group or the user cannot be found
The user is added as participant of the group
The roles of the authenticated user are not sufficient
The business group or the user cannot be found
The user is remove from the group as participant
The roles of the authenticated user are not sufficient
The business group or the user cannot be found
The user is added as participant of the group
The roles of the authenticated user are not sufficient
The business group or the user cannot be found
The user is remove from the group as participant
The roles of the authenticated user are not sufficient
The forum not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
The root message of the thread
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, 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 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 message not found
The links to the attachments
The identity or the portrait 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
1.0
Return the version number
Images for the documentation
Images for the documentation
The copyright of the REST API.
The copyright of the REST API.
The course or parentNode not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forums totalCount="1">
<forums>
<forums subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
</forums>
</forums>
The course node metadatas
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 subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
The course node metadatas
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 forum not found
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/>
The root message of the thread
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, 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 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 message not found
The links to the attachments
The identity or the portrait 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
1.0
The version of this specific Web Service
OK
The translation of the package + key
1.0
The version of this specific Web Service
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<folders totalCount="1">
<folders>
<folders delete="false" list="false" read="false" write="false" subscribed="true" courseNodeId="438950850389" courseKey="375397" name="Course folder"/>
</folders>
</folders>
The folders
The roles of the authenticated user are not sufficient