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.</p> <h2>Concepts</h2> <p>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...</p> <p>In OpenOLAT, the JRS-311 is used as a backend for the implementation of our REST API. JSR-311 is a standard from J2EE. We use the reference implementation from the following standard: <a href="https://jersey.dev.java.net/">Jersey</a>.</p> <img src="schema.jpg" title="schema" /> <h2>Security</h2> <p>The security is based on a two level mechanism, as it is in OpenOLAT.</p> <ol> <li>The first level is a servlet filter which collects all requests to the REST API. This filter determines whether the URI is open to everyone (/api, /ping, /auth...) or if it needs an authentication. The authentication itself is delegated to a web service.</li> <li>The second level happens in all entry points of the REST API. Every method checks if the user (if a user must be authenticated) has enough privileges to operate on the desired resource.</li> </ol> <p>To maintain a valid authentication over several requests, the filter proposes two methods:</p> <ol> <li>Reuse the session cookie on every request. The advantage of this method is that OpenOLAT doesn't need to create a session on every request.</li> <li>If you cannot use the session cookie, the filter always adds an HTTP Header (X-OLAT-TOKEN) to the response. Send this token with the next request to maintain your privileges.</li> </ol> <h2>Configuration</h2> <p>A spring bean allows to configure Resources, Singletons and Providers; either statically with the XML configuration of the bean (<code>/org/olat/restapi/_spring/restApiContext.xml</code>) or programmatically by adding or removing classes and singletons to/from the bean (bean id is the same as its interface: <code>org.olat.restapi.support.RestRegistrationService</code>).</p> <p>OpenOLAT uses the standard JAXB provider from Jersey to produce XML from java objects, as well as the JSON provider from <a href="http://jackson.codehaus.org/">Jackson</a>, which reuses the same JAXB annotations.</p> <p><strong>Very important!</strong> All configuration settings must be done before the Jersey's servlet starts.</p> <h2>Example</h2> <p>Here is a little example on how to create a user and add it to a learning group:</p> <ol> <li>PUT http://www.frentix.com/olat/restapi/users<br /> HTTP Header: Content-Type application/json<br /> Response: 200</li> <li>GET http://www.frentix.com/olat/restapi/groups<br /> HTTP Header: Accept application/json<br /> Response: 200</li> <li>Choose a group</li> <li>PUT http://www.frentix.com/olat/restapi/groups/{groupId}/users/{identityKey}<br /> Response: 200</li> </ol> <h2>Documentation</h2> <p>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.</p> <ol> <li>Generate a XSD schema from all the Java classes used by JAXB for mapping</li> <li>Generate Javadoc with a custom doclet for WADL</li> <li>Generate WADL with the output of the two preceding steps</li> <li>Produce the final HTML documentation with XSLT</li> </ol> <p>To add java classes annoted with JAXB, you must update the pom file in the OpenOLAT directory under the artfact <code>maven-jaxb-schemagen-plugin</code>.</p> <p>To add resources, you must add the packages to the following plugins configurations: <code>maven-javadoc-plugin</code> and <code>maven-wadl-plugin</code>. Be aware that the first uses commas to seperates the packages and the second semicolons. Both recursively search all resources under the packages.</p> <p>Examples for the documentation can only be generated for XML. This is a limitation of the maven plugin.</p> <h2>Contents of resources</h2> <p> Description:<br> <P> Initial Date: 7 févr. 2012 <br>Get courses informations viewable by the authenticated userExample<?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 coursesDescription:<br> Authenticate against OLAT Provider <P> Initial Date: 7 apr. 2010 <br>Retrieves the version of the User Authentication Web ServiceExample1.0The version of this specific Web ServiceThe usernameAuthenticates 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).The password (the password is in clear text, not encrypted)The identity not foundExample&lt;hello&gt;Hello john&lt;/hello&gt;Say hello to the authenticated user, and give it a security tokenThe authentication has failed<h3>Description:</h3> <p> Initial Date: 18 jun. 2010 <br>Return some informations about the environment.The informations about the environmentExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <environmentVO vmVersion="20.4-b02-402" vmVendor="Apple Inc." vmName="Java HotSpot(TM) 64-Bit Server VM" runtimeName="15261@agam.local" availableProcessors="4" osVersion="10.7.2" osName="Mac OS X" arch="x86_64"/> A short summary of the number of classesThe informations about the environmentThe roles of the authenticated user are not sufficientReturn the version of the instance.The informations about the memoryExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <versionVO upgradeAvailable="false" updateAvailable="false" allowAutoUpdate="false" patchAvailable="true" allowAutoPatch="true" repoRevision="" olatVersion="" buildVersion=""/> The verison of the instanceThe informations about the memoryThe roles of the authenticated user are not sufficientDescription:<br> This web service returns logFiles <P> Initial Date: 23.12.2011 <br>The version of the Log Web ServiceExample1.0The version of this specific Web ServiceReturn the configuration of the monitoring, which probes are available, which dependency...The informations about the memoryExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <monitoringInfosVO> <type>openolat</type> <description>this is an OpenOLAT instance</description> <probes> <probe>Environment</probe> <probe>System</probe> <probe>Runtime</probe> <probe>Memory</probe> </probes> <dependencies> <dependency url="localhost" type="openfire"/> <dependency url="192.168.1.120" type="mysql"/> </dependencies> </monitoringInfosVO> The verison of the instanceThe informations about the memoryThe roles of the authenticated user are not sufficientReturn the statistics about runtime: uptime, classes loaded, memory summary, threads count...The informations about runtime, uptime, classes loaded, memory summary...Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <runtimeVO upTime="21248" startTime="2012-11-16T12:45:38.063+01:00" systemLoadAverage="1.16748046875"> <classes totalLoadedClassCount="8500" unloadedClassCount="1500" loadedClassCount="7000"/> <threads peakThreadCount="123" daemonCount="45" threadCount="102"/> <memory garbageCollectionCount="0" garbageCollectionTime="0" maxNonHeap="0" committedNonHeap="0" usedNonHeap="0" initNonHeap="0" maxHeap="0" committedHeap="0" usedHeap="0" initHeap="0" totalMemory="56" freeMemory="45" usedMemory="12"/> </runtimeVO> The version of the instanceThe informations about runtime, uptime, classes loaded, memory summary...The roles of the authenticated user are not sufficientReturn some informations about the number of Java classes...The information about the classesExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <classeStatisticsVO totalLoadedClassCount="8500" unloadedClassCount="1500" loadedClassCount="7000"/> A short summary of the number of classesThe information about the classesThe roles of the authenticated user are not sufficientReturn the statistics about memoryThe informations about runtime, uptime, classes loaded, memory summary...Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <memoryStatisticsVO garbageCollectionCount="0" garbageCollectionTime="0" maxNonHeap="0" committedNonHeap="0" usedNonHeap="0" initNonHeap="0" maxHeap="0" committedHeap="0" usedHeap="0" initHeap="0" totalMemory="56" freeMemory="45" usedMemory="12"/> The version of the instanceThe informations about runtime, uptime, classes loaded, memory summary...The roles of the authenticated user are not sufficientReturn the statistics about threadsThe informations about threads countExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <threadStatisticsVO peakThreadCount="123" daemonCount="45" threadCount="102"/> The version of the instanceThe informations about threads countThe roles of the authenticated user are not sufficientReturn the statistics about database and hibernateThe informations about runtime, uptime, classes loaded, memory summary...Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <databaseVO> <connectionInfos currentConnectionCount="25" activeConnectionCount="10"/> <hibernateStatistics queryExecutionCount="1237" queryExecutionMaxTimeQueryString="select * from PLock" queryExecutionMaxTime="12000" optimisticFailureCount="23" failedTransactionsCount="2" successfulTransactionCount="13980" transactionsCount="13900" openSessionsCount="12"/> </databaseVO> The version of the instanceThe informations about runtime, uptime, classes loaded, memory summary...The roles of the authenticated user are not sufficientReturn the statistics about OpenOLAT, users count, courses count...The statistics about OpenOLATExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <openolatStatisticsVO/> The verison of the instanceThe statistics about OpenOLATThe roles of the authenticated user are not sufficientReturn the statistics about OpenOLAT usersThe statistics about OpenOLAT usersExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <userStatisticsVO totalGroupCount="0" totalUserCount="0"/> The verison of the instanceThe statistics about OpenOLAT usersThe roles of the authenticated user are not sufficientReturn the statistics about the repository, courses count, published courses...The statistics about the repositoryExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <repositoryStatisticsVO publishedCoursesCount="0" coursesCount="0"/> The verison of the instanceThe statistics about the repositoryThe roles of the authenticated user are not sufficientReturn the statistics about the indexerThe statistics about the indexerExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <indexerStatisticsVO indexingTime="0" indexSize="0" availableFolderIndexerCount="0" runningFolderIndexerCount="0" documentQueueSize="0" excludedDocumentCount="0" indexedDocumentCount="0"/> The verison of the instanceThe statistics about the indexerThe roles of the authenticated user are not sufficientReturn some statistics about session.The statistics about sessionsExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <sessionsVO instantMessagingCount="123" secureRestCount="0" restCount="0" secureWebdavCount="12" webdavCount="23" secureAuthenticatedCount="234" authenticatedCount="234" count="234"/> A short summary about sessionsThe statistics about sessionsThe roles of the authenticated user are not sufficient<h3>Description:</h3> Initial Date: 21 juin 2010 <br>Return informations about memory.The informations about the memoryInformations about memoryThe informations about the memoryThe roles of the authenticated user are not sufficientReturn some informations about memory.The informations about the memoryExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <memoryVO maxAvailable="2000" totalUsed="546" totalMem="230" date="2012-11-16T12:45:38.063+01:00"/> A short summary of the number of classesThe informations about the memoryThe roles of the authenticated user are not sufficient<h3>Description:</h3> Initial Date: 21 juin 2010 <br>Description:<br> 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. <P> Initial Date: 26 apr. 2010 <br>The version of the resources folders Web ServiceExample1.0The version of this specific Web ServiceThe course resourceable's idThis retrieves the files in the shared folderThe course or the shared folder not foundThe list of filesThe roles of the authenticated user are not sufficientThe course resourceable's idThis retrieves the files in the shared folderThe course or the shared folder not foundThe list of filesThe roles of the authenticated user are not sufficientThis retrieves the files in the course folderThe course not foundThe list of filesThe roles of the authenticated user are not sufficientThis attaches the uploaded file(s) to the supplied folder id.The course or course node not foundThe file is correctly savedThe course node is not acceptable to copy a fileThe roles of the authenticated user are not sufficientThis attaches the uploaded file(s) to the supplied folder id at the root levelThe course or course node not foundThe file is correctly savedThe course node is not acceptable to copy a fileThe roles of the authenticated user are not sufficientThis retrieves the files in the course folderThe course not foundThe list of filesThe roles of the authenticated user are not sufficientThis attaches the uploaded file(s) to the supplied folder id.The course or course node not foundThe file is correctly savedThe course node is not acceptable to copy a fileThe roles of the authenticated user are not sufficientThis attaches the uploaded file(s) to the supplied folder id at the root levelThe course or course node not foundThe file is correctly savedThe course node is not acceptable to copy a fileThe roles of the authenticated user are not sufficientDescription:<br> <P> Initial Date: 6 déc. 2011 <br>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)The forumsExample<?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 forumsThe forumsThe roles of the authenticated user are not sufficientDescription:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>Retrieves the forum.The forumThe forum not foundThe forumExample<?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 threadThe forumThe roles of the authenticated user are not sufficientRetrieves the threads in the forum(value name,creationDate)(value true/false)The list of threadsThe author, forum or message not foundThe list of threadsExample<?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 threadThe list of threadsThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientThe key of the threadRetrieves the messages in the thread(value name, creationDate)(value true/false)The messages of the threadThe author, forum or message not foundThe messages of the threadExample<?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 threadThe messages of the threadThe roles of the authenticated user are not sufficientThe id of the reply messageCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author keyThe new messageThe author or message not foundThe new messageExample<?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 threadThe new messageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientThe key of the messageRetrieves the attachments of the messageThe attachmentsThe message not foundThe attachmentsThe links to the attachmentsUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkThe name of the attachmentThe identity key of the user being searchedRetrieves the attachment of the messageThe attachmentThe identity or the portrait not foundThe attachmentThe portrait as imageDescription:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>Retrieves the forum.The forumThe forum not foundThe forumExample<?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 threadThe forumThe roles of the authenticated user are not sufficientRetrieves the threads in the forum(value name,creationDate)(value true/false)The list of threadsThe author, forum or message not foundThe list of threadsExample<?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 threadThe list of threadsThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientThe key of the threadRetrieves the messages in the thread(value name, creationDate)(value true/false)The messages of the threadThe author, forum or message not foundThe messages of the threadExample<?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 threadThe messages of the threadThe roles of the authenticated user are not sufficientThe id of the reply messageCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author keyThe new messageThe author or message not foundThe new messageExample<?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 threadThe new messageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientThe key of the messageRetrieves the attachments of the messageThe attachmentsThe message not foundThe attachmentsThe links to the attachmentsUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkThe name of the attachmentThe identity key of the user being searchedRetrieves the attachment of the messageThe attachmentThe identity or the portrait not foundThe attachmentThe portrait as imageDescription:<br> Retrieve and import course assessments <P> Initial Date: 7 apr. 2010 <br>The course resourceable's idReturns the results of the course.The course not foundExample<?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 courseThe roles of the authenticated user are not sufficientRetireves the version of the Course Assessment Web Service.Example1.0The version of this specific Web ServiceThe id of the userThe course resourceable's idReturns the results of the course.The identity or the course not foundExample<?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 courseThe roles of the authenticated user are not sufficientThe id of the course building blockThe resourceable id of the courseExports results for an assessable course node for all students.The course not foundExample<?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 courseThe roles of the authenticated user are not sufficientImports results for an assessable course node for the authenticated student.The identity not foundImport successfulThe roles of the authenticated user are not sufficientThe ident of the course building blockThe id of the userThe course resourceable's idReturns the results of a student at a specific assessable nodeThe identity or the course not foundExample<?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 nodeThe roles of the authenticated user are not sufficientThis interface provides course building capabilities from our REST API. <p> Initial Date: Feb 8, 2010 Time: 3:45:50 PM<br>The version of the Course Elements Web ServiceExample1.0The version of this specific Web ServiceThe node's idThe course resourceable's idRetrieves metadata of the course nodeThe persisted structure element (fully populated)The course or parentNode not foundThe persisted structure element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted structure element (fully populated)The roles of the authenticated user are not sufficientThis updates a Structure Element onto a given course.The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientThis attaches a Structure Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The persisted structure element (fully populated)The course or parentNode not foundThe persisted structure element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted structure element (fully populated)The roles of the authenticated user are not sufficientThis attaches a Structure Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The persisted structure element (fully populated)The course or parentNode not foundThe persisted structure element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted structure element (fully populated)The roles of the authenticated user are not sufficientThis updates a Single Page Element onto a given course.The persisted Single Page Element(fully populated)The course or parentNode not foundThe persisted Single Page Element(fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> the course node metadatasThe persisted Single Page Element(fully populated)The roles of the authenticated user are not sufficientThis attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The persisted Single Page Element(fully populated)The course or parentNode not foundThe persisted Single Page Element(fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted Single Page Element(fully populated)The roles of the authenticated user are not sufficientThis attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The persisted Single Page Element(fully populated)The course or parentNode not foundThe persisted Single Page Element(fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted Single Page Element(fully populated)The roles of the authenticated user are not sufficientThis attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The persisted Single Page Element(fully populated)The course or parentNode not foundThe persisted Single Page Element(fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> the course node metadatasThe persisted Single Page Element(fully populated)The roles of the authenticated user are not sufficientThis attaches a Single Page Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The persisted Single Page Element(fully populated)The course or parentNode not foundThe persisted Single Page Element(fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> the course node metadatasThe persisted Single Page Element(fully populated)The roles of the authenticated user are not sufficientThe node's id of this taskThe course resourceable idThis updates a Task Element onto a given course.The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The task node textThe task node's possible pointsThe persisted task element (fully populated)The course or parentNode not foundThe persisted task element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted task element (fully populated)The roles of the authenticated user are not sufficientThe course resourceable idThis attaches a Task Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The node's id which will be the parent of this taskThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The task node textThe task node's possible pointsThe persisted task element (fully populated)The course or parentNode not foundThe persisted task element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted task element (fully populated)The roles of the authenticated user are not sufficientThis attaches a Task Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The node's id which will be the parent of this taskThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The task node textThe task node's possible pointsThe persisted task element (fully populated)The course or parentNode not foundThe persisted task element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted task element (fully populated)The roles of the authenticated user are not sufficientThis updates a Test Element onto a given course.The persisted test element (fully populated)The course, parentNode or test not foundThe persisted test element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The test node metadatasThe persisted test element (fully populated)The roles of the authenticated user are not sufficientThe course resourceable idThis attaches a Test Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The node's id which will be the parent of this testThe test node's id which is retorned in the response of the import test resourceThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The persisted test element (fully populated)The course, parentNode or test not foundThe persisted test element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The test node metadatasThe persisted test element (fully populated)The roles of the authenticated user are not sufficientThis attaches a Test Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The node's id which will be the parent of this testThe test node's id which is retorned in the response of the import test resourceThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The persisted test element (fully populated)course, parentNode or test not foundThe persisted test element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> the test node metadatasThe persisted test element (fully populated)The roles of the authenticated user are not sufficientThe node's id of this assessmentThe course resourceable's idUpdates an assessment building block.The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientThe course resourceable's idAttaches an assessment building block.The node's id which will be the parent of this assessmentThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientAttaches an assessment building block.The node's id which will be the parent of this assessmentThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientThe node's id which of this wikiThe course resourceable's idAttaches an wiki building block.The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The repository entry key of the wikiThe course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientAttaches an wiki building block.The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientAttaches an wiki building block.The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientThe node's id of this blogThe course resourceable's idUpdate an blog building block.The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The softkey of the blog resourceable (optional)The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientThe course resourceable's idAttaches an blog building block.The node's id which will be the parent of this assessmentThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The softkey of the blog resourceable (optional)The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientAttaches an blog building block.The node's id which will be the parent of this assessmentThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The softkey of the blog resourceable (optional)The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientThe node's id which will be the parent of this assessmentThe course resourceable's idAttaches an survey building block.The node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientAttaches an survey building block.The node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientAttaches an survey building block.The course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientThe node's id of this external pageThe course resourceable's idUpdate an external page building block.The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The URL of the external pageThe course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientThe course resourceable's idAttaches an external page building block.The node's id which will be the parent of this assessmentThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The URL of the external pageThe course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientAttaches an external page building block.The node's id which will be the parent of this assessmentThe node's position relative to its sibling nodes (optional)The node short titleThe node long titleThe node learning objectivesThe rules to view the node (optional)The rules to access the node (optional)The URL of the external pageThe given URL is not validThe course or parentNode not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe roles of the authenticated user are not sufficientThe node's id which will be the parent of this task fileThe course resourceable idThis attaches a Task file onto a given task element.The persisted task element (fully populated)The course or parentNode not foundThe persisted task element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted task element (fully populated)The roles of the authenticated user are not sufficientThis attaches a Task file onto a given task element.The persisted task element (fully populated)The course or parentNode not foundThe persisted task element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted task element (fully populated)The course node is not of type taskThe persisted task element (fully populated)The roles of the authenticated user are not sufficientThis attaches the run-time configuration onto a given task element.The configuration is not validThe course or task node not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The task node configurationThe call is not applicable to task course nodeThe roles of the authenticated user are not sufficientThis attaches the run-time configuration onto a given task element.The configuration is not validThe course or task node not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The task node configurationThe call is not applicable to task course nodeThe roles of the authenticated user are not sufficientRetrieves configuration of the task course nodethe task course node configurationThe course or task node not foundthe task course node configurationExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node configurationthe task course node configurationThe roles of the authenticated user are not sufficientThis attaches the run-time configuration onto a given survey element.The configuration is not validThe course or survey node not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The survey node configurationThe call is not applicable to survey course nodeThe roles of the authenticated user are not sufficientThis attaches the run-time configuration onto a given survey element.The configuration is not validThe course or survey node not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The survey node configurationThe call is not applicable to survey course nodeThe roles of the authenticated user are not sufficientRetrieves configuration of the survey course nodesurvey course node configurationThe course or survey node not foundsurvey course node configurationExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node configurationsurvey course node configurationThe roles of the authenticated user are not sufficientThis attaches the run-time configuration onto a given test element.The configuration is not validThe course or test node not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The test node configurationThe call is not applicable to test course nodeThe roles of the authenticated user are not sufficientThis attaches the run-time configuration onto a given test element.The configuration is not validThe course or test node not foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The test node configurationThe call is not applicable to test course nodeThe roles of the authenticated user are not sufficientRetrieves configuration of the test course nodetest course node configurationThe course or test node not foundtest course node configurationExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node configurationtest course node configurationThe roles of the authenticated user are not sufficientDescription:<br> <P> Initial Date: 21 oct. 2011 <br>Retrieve the contacts of the logged in identity.The list of contactsThe list of contactsDescription:<br> Web service to manage forums. <P> Initial Date: 26 aug. 2010 <br>The version of the Forum Web ServiceExample1.0The version of this specific Web ServiceDescription:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>The key of the forumRetrieves the forum.The forumThe forum not foundThe forumExample<?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 threadThe forumThe roles of the authenticated user are not sufficientRetrieves the threads in the forum(value name,creationDate)(value true/false)The list of threadsThe author, forum or message not foundThe list of threadsExample<?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 threadThe list of threadsThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientThe key of the threadRetrieves the messages in the thread(value name, creationDate)(value true/false)The messages of the threadThe author, forum or message not foundThe messages of the threadExample<?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 threadThe messages of the threadThe roles of the authenticated user are not sufficientThe id of the reply messageCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author keyThe new messageThe author or message not foundThe new messageExample<?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 threadThe new messageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientThe key of the messageRetrieves the attachments of the messageThe attachmentsThe message not foundThe attachmentsThe links to the attachmentsUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkThe name of the attachmentThe identity key of the user being searchedRetrieves the attachment of the messageThe attachmentThe identity or the portrait not foundThe attachmentThe portrait as imageDescription:<br> This handles the learning groups. <P> Initial Date: 23 mar. 2010 <br>Create a group.The business group cannot be foundExample<?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 groupThe roles of the authenticated user are not sufficientReturn the list of all groups if you have group manager permission, or all learning group that you particip with or owne.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <groups totalCount="0"> <groups> <group> <key>123467</key> <description>My group description</description> <name>My group</name> <minParticipants>0</minParticipants> <maxParticipants>0</maxParticipants> </group> </groups> </groups> This is the list of all groups in OLAT systemRetrieves the version of the Group Web Service.Example1.0The version of this specific Web ServiceThe key of the groupReturn the group specified by the key of the group.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <groupVO> <key>123467</key> <description>My group description</description> <name>My group</name> <minParticipants>0</minParticipants> <maxParticipants>0</maxParticipants> </groupVO> A business group in the OLAT systemUpdates a group.The business group cannot be foundExample<?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 groupThe roles of the authenticated user are not sufficientDeletes the business group specified by the groupKey.The business group cannot be foundThe business group is deletedThe roles of the authenticated user are not sufficientThe key of the groupReturns the informations of the group specified by the groupKey.The business group cannot be foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <groupInfoVO> <key>123467</key> <description>My group description</description> <name>My group</name> <minParticipants>0</minParticipants> <maxParticipants>0</maxParticipants> <news>&lt;p&gt;Hello world&lt;/p&gt;</news> <forumKey>374589</forumKey> <hasWiki>false</hasWiki> <hasFolder>false</hasFolder> </groupInfoVO> Participants of the business groupThe key of the groupReturns the list of owners of the group specified by the groupKey.The business group cannot be foundExample<?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 groupThe key of the groupReturns the list of participants of the group specified by the groupKey.The business group cannot be foundExample<?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 groupThe key of the groupThe user's idAdds an owner to the group.The business group or the user cannot be foundThe user is added as owner of the groupThe roles of the authenticated user are not sufficientRemoves the owner from the group.The business group or the user cannot be foundThe user is removed as owner from the groupThe roles of the authenticated user are not sufficientThe key of the groupThe id of the userAdds a participant to the group.The business group or the user cannot be foundThe user is added as participant of the groupThe roles of the authenticated user are not sufficientRemoves a participant from the group.The business group or the user cannot be foundThe user is remove from the group as participantThe roles of the authenticated user are not sufficientDescription:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>The key of the groupRetrieves the forum.The forumThe forum not foundThe forumExample<?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 threadThe forumThe roles of the authenticated user are not sufficientRetrieves the threads in the forum(value name,creationDate)(value true/false)The list of threadsThe author, forum or message not foundThe list of threadsExample<?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 threadThe list of threadsThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientThe key of the threadRetrieves the messages in the thread(value name, creationDate)(value true/false)The messages of the threadThe author, forum or message not foundThe messages of the threadExample<?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 threadThe messages of the threadThe roles of the authenticated user are not sufficientThe id of the reply messageCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author keyThe new messageThe author or message not foundThe new messageExample<?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 threadThe new messageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientThe key of the messageRetrieves the attachments of the messageThe attachmentsThe message not foundThe attachmentsThe links to the attachmentsUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkThe name of the attachmentThe identity key of the user being searchedRetrieves the attachment of the messageThe attachmentThe identity or the portrait not foundThe attachmentThe portrait as imageThe key of the groupDescription:<br> Service for general informations on the OLAT REST Api. <P> Initial Date: 14 apr. 2010 <br>Version number of the whole REST API of OLAT.The version numberExample1.0Return the version numberReturns images for the documentation of OLAT.ImagesImages for the documentationReturns images for the documentation of OLAT.ImagesImages for the documentationReturns the copyright of OLAT.The copyrightThe copyright of the REST API.Returns the copyright of OLAT.The copyrightThe copyright of the REST API.Description:<br> This handles translations from the i18n module of OLAT. <P> Initial Date: 14 apr. 2010 <br>Retrieves the version of the i18n Web Service.Example1.0The version of this specific Web ServiceThe name of the packageThe key to translateReturn 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.The locale (optional)ExampleOKThe translation of the package + keyDescription:<br> This web service handles the courses. <P> Initial Date: 27 apr. 2010 <br>Get all courses viewable by the authenticated userExample<?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 coursesCreates an empty course, or a copy from a course if the parameter copyFrom is set.The short titleThe titleThe repository entry key of a shared folder (optional)The cours key to make a copy from (optional)It returns the id of the newly created CourseExample<?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 courseIt returns the id of the newly created CourseThe roles of the authenticated user are not sufficientThe version of the Course Web ServiceExample1.0The version of this specific Web ServiceDescription:<br> <P> Initial Date: 16 déc. 2011 <br>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)The foldersExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <folders totalCount="1"> <folders> <folder delete="false" list="false" read="false" write="false" subscribed="true" courseNodeId="438950850389" courseKey="375397" name="Course folder"/> </folders> </folders> The foldersThe foldersThe roles of the authenticated user are not sufficientDescription:<br> REST API implementation for forum course node <P> Initial Date: 20.12.2010 <br>Retrieves metadata of the published course nodeThe persisted structure element (fully populated)The course or parentNode not foundThe persisted structure element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <forums totalCount="1"> <forums> <forums subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/> </forums> </forums> The course node metadatasThe persisted structure element (fully populated)The roles of the authenticated user are not sufficientThis attaches a Forum Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The persisted Forum Element (fully populated)The course or parentNode not foundThe persisted Forum Element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted Forum Element (fully populated)The roles of the authenticated user are not sufficientThis attaches a Forum Element onto a given course. The element will be inserted underneath the supplied parentNodeId.The persisted Forum Element (fully populated)The course or parentNode not foundThe persisted Forum Element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseNodeVO> <id>id</id> </courseNodeVO> The course node metadatasThe persisted Forum Element (fully populated)The roles of the authenticated user are not sufficientThe node's idThe course resourceable's idRetrieves metadata of the published course nodeThe persisted structure element (fully populated)The course or parentNode not foundThe persisted structure element (fully populated)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <forum subscribed="false" courseNodeId="2784628" courseKey="286" forumKey="3865487" detailsName="It is a forum" name="My forum"/> The course node metadatasThe persisted structure element (fully populated)The roles of the authenticated user are not sufficientThe id of the course node.The id of the course.Creates a new thread in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author identity name (optional)Creates sticky thread.The new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientThe id of the course node.The id of the course.Creates a new forum message in the forum of the course nodeThe id of the parent message.The title for the first post in the threadThe body for the first post in the threadThe author identity name (optional)The new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientDescription:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>Retrieves the forum.The forumThe forum not foundThe forumExample<?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 threadThe forumThe roles of the authenticated user are not sufficientRetrieves the threads in the forum(value name,creationDate)(value true/false)The list of threadsThe author, forum or message not foundThe list of threadsExample<?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 threadThe list of threadsThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientThe key of the threadRetrieves the messages in the thread(value name, creationDate)(value true/false)The messages of the threadThe author, forum or message not foundThe messages of the threadExample<?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 threadThe messages of the threadThe roles of the authenticated user are not sufficientThe id of the reply messageCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author keyThe new messageThe author or message not foundThe new messageExample<?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 threadThe new messageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientThe key of the messageRetrieves the attachments of the messageThe attachmentsThe message not foundThe attachmentsThe links to the attachmentsUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkThe name of the attachmentThe identity key of the user being searchedRetrieves the attachment of the messageThe attachmentThe identity or the portrait not foundThe attachmentThe portrait as imageThis web service handles functionalities related to authentication credentials of users.The username of the user to retrieve authenticationCreates and persists an authenticationthe saved authenticationThe identity not foundthe saved authenticationExample<?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 authenticationthe saved authenticationThe roles of the authenticated user are not sufficientReturns all user authenticationsThe identity not foundExample<?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 systemThe roles of the authenticated user are not sufficientThe username of the userThe authentication key identifierDeletes an authentication from the system<code>Response</code> object. The operation status (success or fail)The identity or the authentication not found<code>Response</code> object. The operation status (success or fail)The authentication successfully deleted<code>Response</code> object. The operation status (success or fail)The roles of the authenticated user are not sufficientThe version of the User Authentication Web ServiceThe version numberExample1.0The version of this specific Web ServiceThe username of the userFallback method for browsersthe saved authenticationThe identity not foundthe saved authenticationExample<?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 authenticationthe saved authenticationThe roles of the authenticated user are not sufficientThe username of the userThe authentication key identifierFallback method for browsers<code>Response</code> object. The operation status (success or fail)The identity or the authentication not found<code>Response</code> object. The operation status (success or fail)The authentication successfully deleted<code>Response</code> object. The operation status (success or fail)The roles of the authenticated user are not sufficientThis web service handles functionalities related to <code>User</code>.Creates and persists a new user entitythe new persisted <code>User</code>Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <userVO> <key>345</key> <login>john</login> <password></password> <firstName>John</firstName> <lastName>Smith</lastName> <email>john.smith@frentix.com</email> <properties> <property> <name>telPrivate</name> <value>238456782</value> </property> <property> <name>telMobile</name> <value>238456782</value> </property> </properties> </userVO> The persisted userthe new persisted <code>User</code>Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <errorVOes> <errorVO> <code>org.olat.restapi:error</code> <translation>Hello world, there is an error</translation> </errorVO> </errorVOes> The list of errorsthe new persisted <code>User</code>The roles of the authenticated user are not sufficientSearch 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.The login (search with like)An authentication provider (optional)An specific username from the authentication providerAn array of usersExample<?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 systemAn array of usersThe roles of the authenticated user are not sufficientThe user key identifier of the user being searchedDelete an user from the system<code>Response</code> object. The operation status (success or fail)The identity not found<code>Response</code> object. The operation status (success or fail)The user is removed from the group<code>Response</code> object. The operation status (success or fail)The roles of the authenticated user are not sufficientUpdate an user<code>User</code> object. The operation status (success or fail)The identity not found<code>User</code> object. The operation status (success or fail)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <userVO> <key>345</key> <login>john</login> <password></password> <firstName>John</firstName> <lastName>Smith</lastName> <email>john.smith@frentix.com</email> <properties> <property> <name>telPrivate</name> <value>238456782</value> </property> <property> <name>telMobile</name> <value>238456782</value> </property> </properties> </userVO> The user<code>User</code> object. The operation status (success or fail)Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <errorVOes> <errorVO> <code>org.olat.restapi:error</code> <translation>Hello world, there is an error</translation> </errorVO> </errorVOes> The list of validation errors<code>User</code> object. The operation status (success or fail)The roles of the authenticated user are not sufficientRetrieves an user given its unique key identifierIf true return the portrait as Base64 (default false)an xml or json representation of a the user being search. The xml correspond to a <code>UserVO</code>. <code>UserVO</code> is a simplified representation of the <code>User</code> and <code>Identity</code>The identity not foundan xml or json representation of a the user being search. The xml correspond to a <code>UserVO</code>. <code>UserVO</code> is a simplified representation of the <code>User</code> and <code>Identity</code>Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <userVO> <key>345</key> <login>john</login> <password></password> <firstName>John</firstName> <lastName>Smith</lastName> <email>john.smith@frentix.com</email> <properties> <property> <name>telPrivate</name> <value>238456782</value> </property> <property> <name>telMobile</name> <value>238456782</value> </property> </properties> </userVO> The useran xml or json representation of a the user being search. The xml correspond to a <code>UserVO</code>. <code>UserVO</code> is a simplified representation of the <code>User</code> and <code>Identity</code>The roles of the authenticated user are not sufficientThe version of the User Web ServiceThe version numberExample1.0The version of this specific Web ServiceRetrieves the roles of a user given its unique key identifieran xml or json representation of a the roles being search.The identity not foundan xml or json representation of a the roles being search.The useran xml or json representation of a the roles being search.The roles of the authenticated user are not sufficientThe user key identifierFallback method for browsersThe identity not foundThe user is removed from the groupThe roles of the authenticated user are not sufficientThe identity key identifier of the user being searchedRetrieves the portrait of an userThe imageThe identity or the portrait not foundThe imageThe portrait as imageUpload the portrait of an userThe imageThe identity or the portrait not foundThe imageThe portrait as imageThe imageNot authorizedDeletes the portrait of an userThe imageThe portrait deletedThe imageNot authorizedDescription:<br> <P> Initial Date: 18 oct. 2011 <br>Return all groups of a userThe first resultThe maximum resultsThe list of groups informationsThe identity not foundThe list of groups informationsExample<?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 userReturn all groups with information of a user. Paging is mandatory!The first resultThe maximum resultsThe list of groups with additional informationsExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <groups totalCount="0"> <groups> <group> <key>123467</key> <description>My group description</description> <name>My group</name> <minParticipants>0</minParticipants> <maxParticipants>0</maxParticipants> <news>&lt;p&gt;Hello world&lt;/p&gt;</news> <forumKey>374589</forumKey> <hasWiki>false</hasWiki> <hasFolder>false</hasFolder> </group> </groups> </groups> The groups of the userThe list of groups with additional informationsThe request hasn't paging informationDescription:<br> Ping to test the presence of the REST Api <P> Initial Date: 7 apr. 2010 <br>Return a stringExamplePingReturn a small stringThe version of the Ping Web ServiceExample1.0The version of this specific Web ServiceReturn a stringExamplePingReturn a small stringDescription:<br> A web service for the catalog <P> Initial Date: 5 may 2010 <br>Returns the list of root catalog entries.The responseExample<?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 entriesThe pathThe id of the userRetrieves data of an owner of the local sub treeThe responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedAdd an owner of the local sub treeThe responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedRemove an owner of the local sub treeThe responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedRetrieves the version of the Catalog Web Service.Example1.0The version of this specific Web ServiceThe pathReturns a list of catalog entries.The responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entriesThe pathReturns the metadata of the catalog entry.The responseExample<?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 entryThe responseThe path could not be resolved to a valid catalog entryAdds a catalog entry under the path specified in the URL.The nameThe descriptionThe type (leaf or node)The id of the repository entryThe responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedAdds a catalog entry under the path specified in the URL.The responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedUpdates the catalog entry under the path specified in the URL.The nameThe descriptionThe parent key to move the entry (optional)The responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedUpdates the catalog entry with the path specified in the URL.The responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedUpdates the catalog entry with the path specified in the URL.The responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedDeletes the catalog entry with the path specified in the URL.The responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedThe pathGet the owners of the local sub treeThe responseThe path could not be resolved to a valid catalog entryThe responseExample<?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 entryThe responseNot authorizedDescription:<br> This web service will handle the functionality related to <code>Course</code> and its contents. <P> Initial Date: 27 apr. 2010 <br>The course resourceable's idGet the metadatas of the course by idIt returns the <code>CourseVO</code> object representing the course.The course not foundIt returns the <code>CourseVO</code> object representing the course.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseVO> <key>777</key> <title>Demo course</title> <displayName>Demo course</displayName> </courseVO> The metadatas of the created courseDelete a course by idIt returns the XML representation of the <code>Structure</code> object representing the course.The course not foundIt returns the XML representation of the <code>Structure</code> object representing the course.The metadatas of the created courseIt returns the XML representation of the <code>Structure</code> object representing the course.The roles of the authenticated user are not sufficientThe version of the Course Web ServiceExample1.0The version of this specific Web ServiceThe course resourceable's idGet the configuration of the courseIt returns the XML representation of the <code>Structure</code> object representing the course.The course not foundIt returns the XML representation of the <code>Structure</code> object representing the course.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseVO> <sharedFolderSoftKey>head_1_olat_43985684395</sharedFolderSoftKey> </courseVO> The configuration of the courseIt returns the XML representation of the <code>Structure</code> object representing the course.The roles of the authenticated user are not sufficientUpdate the course configurationEnable/disable the calendar (value: true/false) (optional)Enable/disable the chat (value: true/false) (optional)Set the custom CSS file for the layout (optional)Enable/disable the efficencyStatement (value: true/false) (optional)Set the glossary (optional)Set the shared folder (optional)It returns the XML/Json representation of the <code>CourseConfig</code> object representing the course configuration.The course not foundIt returns the XML/Json representation of the <code>CourseConfig</code> object representing the course configuration.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseVO> <sharedFolderSoftKey>head_1_olat_43985684395</sharedFolderSoftKey> </courseVO> The metadatas of the created courseIt returns the XML/Json representation of the <code>CourseConfig</code> object representing the course configuration.The roles of the authenticated user are not sufficientThe course resourceable's idGet all owners and authors of the courseIt returns an array of <code>UserVO</code>The course not foundIt returns an array of <code>UserVO</code>The array of authorsIt returns an array of <code>UserVO</code>The roles of the authenticated user are not sufficientThe course resourceable's idPublish the course.The course localeIt returns the metadatas of the published course.The course not foundIt returns the metadatas of the published course.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <courseVO> <key>777</key> <title>Demo course</title> <displayName>Demo course</displayName> </courseVO> The metadatas of the created courseIt returns the metadatas of the published course.The roles of the authenticated user are not sufficientExport the courseIt returns the <code>CourseVO</code> object representing the course.The course not foundIt returns the <code>CourseVO</code> object representing the course.The course as a ZIP fileIt returns the <code>CourseVO</code> object representing the course.Not authorized to export the courseThe course resourceable's idGet the runstructure of the course by idIt returns the XML representation of the <code>Structure</code> object representing the course.The course not foundIt returns the XML representation of the <code>Structure</code> object representing the course.The run structure of the courseIt returns the XML representation of the <code>Structure</code> object representing the course.The roles of the authenticated user are not sufficientThe course resourceable's idGet the editor tree model of the course by idIt returns the XML representation of the <code>Editor model</code> object representing the course.The course not foundIt returns the XML representation of the <code>Editor model</code> object representing the course.The editor tree model of the courseIt returns the XML representation of the <code>Editor model</code> object representing the course.The roles of the authenticated user are not sufficientThe user identifierThe course resourceable's idGet this specific author and owner of the courseIt returns an <code>UserVO</code>The course not found or the user is not an onwer or author of the courseIt returns an <code>UserVO</code>The authorIt returns an <code>UserVO</code>The roles of the authenticated user are not sufficientAdd an owner and author to the courseIt returns 200 if the user is added as owner and author of the courseThe course or the user not foundIt returns 200 if the user is added as owner and author of the courseThe user is an author and owner of the courseIt returns 200 if the user is added as owner and author of the courseThe roles of the authenticated user are not sufficientRemove an owner and author to the courseIt returns 200 if the user is removed as owner of the courseThe course or the user not foundIt returns 200 if the user is removed as owner of the courseThe user was successfully removed as owner of the courseIt returns 200 if the user is removed as owner of the courseThe roles of the authenticated user are not sufficientDescription:<br> CourseGroupWebService <P> Initial Date: 7 apr. 2010 <br>Lists all learn groups of the specified course.The context of the group not foundExample<?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 courseCreates a new group for the course.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <groupVO> <key>123467</key> <description>My group description</description> <name>My group</name> <minParticipants>0</minParticipants> <maxParticipants>0</maxParticipants> </groupVO> The persisted groupThe roles of the authenticated user are not sufficientRetrieves the version of the Course Group Web Service.Example1.0The version of this specific Web ServiceThe group's idDeletes the business group specified by the key of the group.The business group cannot be foundThe business group is deletedThe roles of the authenticated user are not sufficientRetrieves the metadata of the specified group.The business group cannot be foundExample<?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 systemUpdates the metadata for the specified group.The business group cannot be foundExample<?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 groupThe roles of the authenticated user are not sufficientFallback method for the browser.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <groupVO> <key>123467</key> <description>My group description</description> <name>My group</name> <minParticipants>0</minParticipants> <maxParticipants>0</maxParticipants> </groupVO> The persisted groupThe roles of the authenticated user are not sufficientDescription:<br> Web service to manage a forum. <P> Initial Date: 20 apr. 2010 <br>The key of the groupRetrieves the forum.The forumThe forum not foundThe forumExample<?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 threadThe forumThe roles of the authenticated user are not sufficientRetrieves the threads in the forum(value name,creationDate)(value true/false)The list of threadsThe author, forum or message not foundThe list of threadsExample<?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 threadThe list of threadsThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientCreates a new thread in the forum of the course nodeThe new threadThe author, forum or message not foundThe new threadExample<?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 threadThe new threadThe roles of the authenticated user are not sufficientThe key of the threadRetrieves the messages in the thread(value name, creationDate)(value true/false)The messages of the threadThe author, forum or message not foundThe messages of the threadExample<?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 threadThe messages of the threadThe roles of the authenticated user are not sufficientThe id of the reply messageCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author keyThe new messageThe author or message not foundThe new messageExample<?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 threadThe new messageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe title for the first post in the threadThe body for the first post in the threadThe author user key (optional)The new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientCreates a new reply in the forum of the course nodeThe new MessageThe author or message not foundThe new MessageExample<?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 threadThe new MessageThe roles of the authenticated user are not sufficientThe key of the messageRetrieves the attachments of the messageThe attachmentsThe message not foundThe attachmentsThe links to the attachmentsUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkUpload the attachment of a message, as parameter:<br/> filename The name of the attachment<br/> file The attachment.OkThe identity or the portrait not foundOkOkThe name of the attachmentThe identity key of the user being searchedRetrieves the attachment of the messageThe attachmentThe identity or the portrait not foundThe attachmentThe portrait as imageDescription:<br> This handles the repository entries <P> Initial Date: 19.05.2009 <br>List all entries in the OLAT repositoryExample<?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 repositoryList all entries in the OLAT repositoryExample<?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 repositoryImport a resource in the repositoryExample<?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 entryThe roles of the authenticated user are not sufficientThe version number of this web serviceSearch for repository entries, possible search attributes are name, author and typeFilter by the file resource type of the repository entryFilter by the author's usernameFilter by name of repository entryOnly search entries the requester ownsExample<?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 entriesThe roles of the authenticated user are not sufficientDescription:<br> Repository entry resource <P> Initial Date: 19.05.2009 <br>Delete a course by idIt returns the XML representation of the <code>Structure</code> object representing the course.The course not foundIt returns the XML representation of the <code>Structure</code> object representing the course.The metadatas of the created courseIt returns the XML representation of the <code>Structure</code> object representing the course.The roles of the authenticated user are not sufficientget a resource in the repositoryThe repository entry not foundExample<?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 resourceReplace a resource in the repository and update its display name. The implementation is limited to CP.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <repositoryEntryVO> <key>479286</key> <softkey>internal_cp</softkey> <resourcename>fdhasl</resourcename> <displayname>CP-demo</displayname> <resourceableId>4368567</resourceableId> <resourceableTypeName>CourseModule</resourceableTypeName> </repositoryEntryVO> Replace the resource and return the updated repository entryThe roles of the authenticated user are not sufficientThe key of the repository entryReturns the list of participants of the repository entry.The repository entry cannot be foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <users totalCount="0"> <users> <user> <key>345</key> <login>john</login> <password></password> <firstName>John</firstName> <lastName>Smith</lastName> <email>john.smith@frentix.com</email> <properties> <property> <name>telPrivate</name> <value>238456782</value> </property> <property> <name>telMobile</name> <value>238456782</value> </property> </properties> </user> </users> </users> Coaches of the repository entryThe key of the repository entryThe user's idAdds a participant to the repository entry.The repository entry or the user cannot be foundThe user is added as participant of the repository entryThe roles of the authenticated user are not sufficientRemoves the participant from the repository entry.The repository entry or the user cannot be foundThe user is removed as participant from the repository entryThe roles of the authenticated user are not sufficientDownload the export zip file of a repository entry.The resource is lockedThe resource could not foundExample<?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 fileDownload of this resource is not possibleThe roles of the authenticated user are not sufficientThe key of the repository entryReturns the list of owners of the repository entry specified by the groupKey.The repository entry cannot be foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <users totalCount="0"> <users> <user> <key>345</key> <login>john</login> <password></password> <firstName>John</firstName> <lastName>Smith</lastName> <email>john.smith@frentix.com</email> <properties> <property> <name>telPrivate</name> <value>238456782</value> </property> <property> <name>telMobile</name> <value>238456782</value> </property> </properties> </user> </users> </users> Owners of the repository entryThe key of the repository entryThe user's idAdds an owner to the repository entry.The repository entry or the user cannot be foundThe user is added as owner of the repository entryThe roles of the authenticated user are not sufficientRemoves the owner from the repository entry.The repository entry or the user cannot be foundThe user is removed as owner from the repository entryThe roles of the authenticated user are not sufficientThe key of the repository entryReturns the list of coaches of the repository entry.The repository entry cannot be foundExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <users totalCount="0"> <users> <user> <key>345</key> <login>john</login> <password></password> <firstName>John</firstName> <lastName>Smith</lastName> <email>john.smith@frentix.com</email> <properties> <property> <name>telPrivate</name> <value>238456782</value> </property> <property> <name>telMobile</name> <value>238456782</value> </property> </properties> </user> </users> </users> Coaches of the repository entryThe key of the repository entryThe user's idAdds a coach to the repository entry.The repository entry or the user cannot be foundThe user is added as coach of the repository entryThe roles of the authenticated user are not sufficientRemoves the coach from the repository entry.The repository entry or the user cannot be foundThe user is removed as coach from the repository entryThe roles of the authenticated user are not sufficient<h3>Description:</h3> REST API for notifications <p> Initial Date: 25 aug 2010 <br>Retrieves the notification of the logged in user.The date (optional)The type of notifications (User, Forum...) (optional)an xml or json representation of a the user being search. The xml correspond to a <code>SubscriptionInfoVO</code>. <code>SubscriptionInfoVO</code>The identity not foundan xml or json representation of a the user being search. The xml correspond to a <code>SubscriptionInfoVO</code>. <code>SubscriptionInfoVO</code>Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <subscriptionInfoVOes> <subscriptionInfoVO> <title>Infos</title> <items/> </subscriptionInfoVO> </subscriptionInfoVOes> The notifications