Api

Welcome to the RWTH - L2P API documentation page. This documentation describes the list of available methods of the RWTH - L2P2013 API. The methods are shown alphabetically and provided with a description of the method itself, the parameters, an example call, and a live testing mechanism. The base URL of the API is the URL to this site without the "Documentation" at its end. If you wish to receive updates of this API changelog please subscribe to this Mailing List.

In order to use this API your application must:

  1. Authenticate to the OAuth2 system of IT center.
  2. Obtain a Client ID from the IT-Center.
Please contact the IT-Center for more information about these tasks.

The API Calls return also http status codes. The most common codes are:

  • OK (200) Everything worked fine
  • Unauthorized (401) The access token is invalid or the user has no access to the room
  • Forbidden (403) User has not enogh right to peform this action
  • Bad Request (400) The Call was malformed (e.g. missing mandatory parameters)
  • Internal Server Error (500)
  • An error inside the API occured. If this error persists, please inform us

Except the downloadFile-Call, all Calls will return valid JSON objects. These always contain a status field (boolean) indicating whether the Call was successfull. In case of Error, the fields ErrorDescription and ErrorId provide further information.


addAnnouncement

Description

Add an announcement in the Announcement module.
This method will add an announcement in the Announcement module. The annoucement's title parameter is mandatory and body, expiretime parameters are optional. Once the announcement is successfully added, then associated docuements (if any) can be uploaded using the UploadFile method using the added announcement's itemId parameter. Only authenticated users who are member of the specified courseroom can call this method and the item will be added if the authenticated user has sufficient permission for adding.

Parameters

NameRangeDescription
*bodystring(Optional) The body/content of the announcement.
*expiretimelong(Optional) Desired time when this element should expire. If the expiretime parameter needs to be a valid unixtimestamp.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
titlestringThe title of the announcement.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST addAnnouncement?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"title":"This is a sample announcement.","body":"Here goes the description of the announcement","expireTime":123456789}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

addAssignment

Description

Add an assignment in the Assignments module.
This method will add an assignment in the Assignments module. The assignment's title and description parameters are mandatory and dueDate, groupSubmissionAllowed and TotalMarksparameters are optional. Once the assignment is successfully added, then associated docuements (if any) can be uploaded using the UploadFile method using the added assignment's itemId parameter. Only authenticated users who are member of the specified courseroom can call this method and the item will be added if the authenticated user has sufficient permission for adding.

Parameters

NameRangeDescription
*dueDatelong(Optional) Desired time of the assignment's deadline. If the parameter is not a valid unixtimestamp then it will be set as 0.
*groupSubmissionAllowedboolean(Optional) A boolean value indicating wheather or not the solutions should be submitted as group.
*totalMarksdouble(Optional) Total marks of the assignment.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
descriptionstringDescription of the assignment.
titlestringThe title of the assignment.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST addAssignment?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"title":"Excellence means greatness — the very best (e.g. RWTH)","description":"Excellence means greatness — the very best (e.g. RWTH)","totalMarks":0,"dueDate":42,"groupSubmissionAllowed":false}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

addCourseEvents

Description

Adds Event to calendar.
This method will add events to calendar. Only authenticated users who are member of the specified courseroom can call this method and the item will be added if the authenticated user has sufficient permission for adding.

Parameters

NameRangeDescription
*allDayBoolean(Optional) If event is all day, set to true.
*categorystring(Optional) Whether it is a lecture, event, or a custom category.
*contentTypestring(Optional) The type of Event (e.g. CampusEvent).
*descriptionstring(Optional) Description of the event.
*locationstring(Optional) Location of the event.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
endDatelongEnd date of event. Must be in unix time.
eventDatelongDate of event. Must be in unix time.
titlestringThe title of the event.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST addCourseEvent?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"title":"Class Time","contentType":"CampusEvent","location":"Informatik 9","eventDate":1435586400,"endDate":1435590000,"allDay":true,"description":"Party at Chair! Bring some Coockies!","category":"Lecture"}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

addDiscussionThread

Description

Add a new discussion thread in the Discussion Forum module.
This method will add a new discussion thread in the Discussion Forum module. Only authenticated users who are member of the specified courseroom can call this method and the item will be added if the authenticated user has sufficient permission for adding.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
bodystringThe body/content of the discussion thread.
cidstringDesired courseroom id.
subjectstringTitle/Subject of the discussion thread.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST addDiscussionThread?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

addDiscussionThreadReply

Description

Add a new reply in the Discussion Forum module.
This method will add a new reply in the Discussion Forum module. The reply must be posted as a response to another reply or an existing discussion thread, as specified with the replyToId parameter. Only authenticated users who are member of the specified courseroom can call this method and the item will be added if the authenticated user has sufficient permission for adding.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
bodystringThe body/content of the discussion thread.
cidstringDesired courseroom id.
replyToIdintSelfid value of the desired thread or reply, in whose response this reply is posted.
subjectstringTitle/Subject of the discussion thread reply.

Return Value

Range Description
JSON A status flag and metadata about the updated item.

Sample Call

Protocol
POST addDiscussionThreadReply?accessToken={accessToken}&cid={cid}&replyToId={replyToId}

<div class="codeJavaScript">{"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

addEmail

Description

Add an email in the Email module.
This method will add an email in the Email module. At least one entry in recipients field must be provided, however entries in cc field are optional. The email's subject parameter is mandatory and body, replyto parameters are optional. If replyto attribute is not set as
true
then it will be set as
No reply address
. Only authenticated users who are member of the specified courseroom can call this method and the item will be added if the authenticated user has sufficient permission for adding.

Parameters

NameRangeDescription
*attachmentsToUploadJSON array(Optional) Each element of this array must have an element 'filename' with the attachment filename and an element 'stream', which contains the Base64 encoded value from the byte array of the file which should be uploaded.
*bodystring(Optional) The body/content of the email.
*ccstringA semicolon separated list of desired recipients in cc field of the email.
*replytobool(Optional) Either
true
or
false
. If set to
true
, then authenticated user's email will be set into the replyto field of the email. Otherwise it will be left as empty.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
recipientsstringA semicolon separated list of desired recipients. Accepted values are:
managers
,
students
,
extras
or any valid gws_name_alias parameter's value.
subjectstringTitle/Subject of the email.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST addEmail?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"attachmentsToUpload":[{"fileName":"abcd.text","stream":"cnd0aC1hYWNoZW4uZGU="}],"recipients":"managers;tutors;students;","cc":"administrator@example.rwth-aachen.de","body":"This is a sample email.","subject":"This is the subject of the email","replyTo":"Reply to my address"}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

addLearningObject

Description

Adds a Learning Object.
This method will add a new Learning Object to the course room. The related Media needs to be a video of the media library or the Learning Object Module of L2P may not be able to show it. The Learning Object uses a set of references to items of other modules.

Parameters

NameRangeDescription
*hyperlinksList of int(optional) IDs of the Hyperlinks to be referenced.
*literatureList of int(optional) IDs of the literature elements to be referenced.
*materialsList of int(optional) IDs of the Learning Materials to be referenced.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
descriptionstringThe description of the Learning Object.
relatedMediainteger(optional) ID of the Media Library element to be referenced (needs to be a video!).
titlestringThe title of the Learning Object.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST addLearningObject?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"title":"LO-Title","description":"A simple LearningObject","literature":[42],"materials":[42],"hyperlinks":[42],"relatedMedia":2}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

addLiterature

Description

Add a literature element in the literature module.
This method will add a literature element in the module. Depending on the content type, different parameters are mandatory. These fields are marked correspondingly. If the title exceeds 255 characters, it will be shortened. Only authenticated users who are member of the specified courseroom can call this method and the item will be added if the authenticated user has sufficient permission for adding.

Parameters

NameRangeDescription
*addressstring(Optional) The address of the literature item (e.g. where to find).
*commentsstring(Optional) a comment for this item.
*doistring(Optional) The doi of the literature item.
*editionstring(Optional) The edition of the literature item.
*isxnstring(Optional) The isxn/isbn identifier of the literature item.
*numberstring(Optional) The number of the literature item.
*relevancestring(Optional) The relevance of the literature item. Possible values are Mandatory, Optional, None or Invalid.
*rolestring(Optional) The role of the literature item. Possible values are Primary Literature, Secondary Literature, None and Invalid.
*seriesstring(Optional) The series of the literature item.
*urlstring(Optional) The url for more information or the literature itself.
*urlCommentstring(Optional) The name of the url. This will be shown in L2P instead of the link url if set.
*volumestring(Optional) The volume of the literature item.
accessTokenstringThe OAuth access token.
authorsstringThe authors of the literature item.
booktitlestring(Optional for New Article, Book and Add Literature) The title of the book of the literature item.
cidstringDesired courseroom id.
contentTypestringThe Conent type of this element. Depending on this parameter, the other parameters may be mandatory. Possible values are Book, In Book, In Proceedings, New Article and Add Literature (for misc. literature).
fromPagestring(Optional for New Article, Book and Add Literature) The first page of the relevant part of a book.
journalNamestring(Optional for In Book, In Proceedings, Book and Add Literature) The name of the journal, where the item was published in.
publisherstring(Optional for New Article and Add Literature) The publisher of the literature item.
titlestringThe title of the literature.
toPagestring(Optional for New Article, Book and Add Literature) The last page of the relevant part of a book.
yearstringThe year of publication.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST addLiterature?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

addWiki

Description

Add a wiki in the Wiki module.
This method will add a wiki in the Wiki module. The wiki's TITLE parameter is mandatory and BODY parameter is optional. If desired title already exist in the module, then an error will be generated. Only authenticated users who are member of the specified courseroom can call this method and the item will be added if the authenticated user has sufficient permission for adding.

Parameters

NameRangeDescription
*bodystring(Optional) The body/content of the Wiki.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
titlestringThe title of the Wiki.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST addWiki?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"title":"Codemates group","body":"Codemates group is consists of four people who love to code."}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

createFolder

Description

Create a folder in L2P.
This method will create a folder into the specified module, as specified with the moduleNumber parameter. Desired folder's folderName and moduleNumber parameters are mandatory and sourceDirectory URL parameter is optional. If sourceDirectory URL parameter is provided but the directory does not exists, then folder will be created in root directory in the specified module. Only authenticated users who are member of the specified courseroom can call this method and if the authenticated user has permission to create a folder then the folder will be created. .

Parameters

NameRangeDescription
*sourceDirectorystring(Optional) A directory URL in which the new folder should be created. If it is left empty, then folder will be created in the root directory of the module.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
desiredFolderNamestringDesired folder's name.
moduleNumberintDesired module's number. Currently available modules and their moduleNumbers are:
{'LearningMaterials' = 0, 'MediaLibrary' = 1, 'SharedDocuments' = 2 }
.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
GET createFolder?accessToken={accessToken}&cid={cid}&moduleNumber={moduleNumber}&desiredFolderName={desiredFolderName}&sourceDirectory={sourceDirectory}
Live

Sample Response

{"sourceDirectory":"/ss14/14ss-0000/List/SharedDocs/abcd","itemId":29,"modifiedTimestamp":987654321,"name":"readme","selfUrl":"/ws13/13ws-00001/Lists/SharedDocs/abcd/readme","Status":true}

deleteAnnouncement

Description

Delete an announcement from the Announcement module.
This method will delete an existing announcement, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteAnnouncement?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteAssignment

Description

Delete an assignment from the Assignments module.
This method will delete an existing assignment, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteAssignment?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteAssignmentSolution

Description

Delete an assignment's solution from the Assignments module.
This method will delete an existing assignment's solution, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteAssignmentSolution?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteCourseEvent

Description

Delete a calendar Event from a course. Warning: Deletes all items if the item is part of a recurring sequence.
This method will delete an existing calendar, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteCourseEvent?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteDiscussionItem

Description

Delete an item from the Discussion Forum module.
This method will delete an item from the Discussion Forum module, as specified with the selfid parameter. If the item is a discussion thread, then its replies will also be deleted. However, If the item is a reply inside a discussion thread, then only the reply item will be deleted. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteDiscussionItem?accessToken={accessToken}&cid={cid}&selfid={selfid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteEmail

Description

Delete an email from the Email module.
This method will delete an existing email, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteEmail?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteLearningMaterial

Description

Delete a learning material item from the Learning Materials module.
This method will delete an existing learning material item, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteLearningMaterial?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteLearningObject

Description

Delete a Learning Object from the Learning Object module.
This method will delete an existing learning object, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteLearningObject?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteLiterature

Description

Delete an literature element from the literature module.
This method will delete an existing literature, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteLiterature?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteMediaLibrary

Description

Delete an item from the Media Library module.
This method will delete an existing media library item, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteMediaLibrary?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteSharedDocument

Description

Delete an item from the Shared Documents module.
This method will delete an existing shared documents item, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteSharedDocument?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deleteWiki

Description

Delete a wikipage from the Wiki module.
This method will delete an existing wikipage, as specified with the itemid parameter. Once deleted, the item cannot be restored by courseroom users. Only authenticated users who are member of the specified courseroom can call this method and the item will be deleted if the authenticated user has sufficient permission for deleting.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET deleteWiki?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

deregisterParticipant

Description

Removes a user from the given group (works only for managers).
This method will deregister a user, as specified with the uid parameter. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
groupNamestringthe role, which the user should be removed from (e.g.
managers, extra, tutors
).
uidstringmatriculation number or TIM-ID or userPrincipalName.

Return Value

Range Description

Sample Call

Protocol
POST deregisterParticipant?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"groupName":"managers","uid":"ab123789"}</div>
Live

Sample Response

{"success":false,"Status":true}

Documentation

Description

Generates this documentation.

Parameters

NameRangeDescription

Return Value

Range Description

Sample Call

Protocol
GET Documentation
Live

Sample Response

null

downloadFile

Description

Returns a stream to download a file.
This method will return a stream object to download a file. The {FILENAME} parameter is optional, however it is advised to provide desired filename. Only authenticated users who are member of the specified courseroom can call this method and if the authenticated user has permission to view this item then a stream to download the file will be returned.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
downloadUrlstringprovided downloadUrl parameter's value in downloadable item's fileinformation parameter.

Return Value

Range Description
STREAM A stream to download object.

Sample Call

Protocol
GET downloadFile/{fileName}?accessToken={accessToken}&cid={cid}&downloadUrl={downloadUrl}
Live

Sample Response

null

gwsInviteMemberInGroup

Description

Invite users to an existing group of the Group Workspace module.
This method will invite users in an already existing group from the Group Workspace module. Intended group's systemGeneratedAlias parameter is necessary and users emails must be separated by semicolon (;). Only authenticated users who are member of the specified courseroom can call this method and members will be invited if the authenticated user has permission to invite them.

Parameters

NameRangeDescription
*commentstring(Optional) A comment for the invitee.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
emailsstringEmail address of the invitee(s), can be obtained by clicking on the users from Courseroom>Participants. If more than one, separate with semicolon (;).
systemGeneratedAliasstringSystem generated name for the group, can be found using the method viewMyGroupWorkspace or from the field SPGroupName from Courseroom>Group Workspace>All Groups and then clicking on the desired group.

Return Value

Range Description
JSON Status of the invitation request

Sample Call

Protocol
POST gwsInviteMemberInGroup?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"emails":"someone@example.lol;phil@excample.not","systemGeneratedAlias":"GWS_The_Worskpace","comment":"Please join our group!"}</div>
Live

Sample Response

{"comment":"Process successful","Status":true}

gwsLeaveGroup

Description

Execute a request to leave a group in the Group Workspace module.
This method will execute a request to leave a group in the Group Workspace module, as specified with the groupId parameter. Only authenticated users who are member of the specified courseroom can call this method and request will be processed if the authenticated user is a member of the group.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
groupIdintID of the group, from which the user wants to leave.

Return Value

Range Description
JSON Status of the leave request.

Sample Call

Protocol
GET gwsLeaveGroup?accessToken={accessToken}&cid={cid}&groupId={groupId}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

gwsRespondToInvitation

Description

Manage invitation request in the Group Workspace module.
An invitation is made by another member of the courseroom that is member of a group to the user. This method will manage an invitation request (for joining a group) in the Group Workspace module, as specified with the itemid parameter. Users can respond to accept a request or they can deny the request. Only authenticated users who are member of the specified courseroom can call this method and requests will be processed if the authenticated user has permission to process them.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
actionstringUser's intended action on the invitation. Only
1
and
2
are accepted values for requested action, where 2 represent deny and 1 represent accept.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET gwsRespondToInvitation?accessToken={accessToken}&cid={cid}&itemId={itemId}&action={action}
Live

Sample Response

{"comment":"Process successful","Status":true}

gwsRespondToRequest

Description

Manage joining request in the Group Workspace module.
A request is when another user member of the same courseroom requests the present user allowance to join a group that the current user is member of. This method will manage a joining request (for joining a group) in the Group Workspace module, as specified with the itemid parameter. Users can respond to accept a request or they can deny the request. Only authenticated users who are member of the specified courseroom can call this method and requests will be processed if the authenticated user has permission to process them.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
actionstringUser's intended action on the request. Only
1
and
2
are accepted values for requested action, where 2 represent deny and 1 represent accept.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET gwsRespondToRequest?accessToken={accessToken}&cid={cid}&itemId={itemId}&action={action}
Live

Sample Response

{"comment":"Process successful","Status":true}

Ping

Description

Respond to a ping request.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
pStringAny string from the user.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
GET Ping?accessToken={accessToken}&p={p}
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

provideAssignmentSolution

Description

Provide a solution in the Assignments module.
This method will provide a solution in the Assignments module, as specified with the assignmentId parameter. Each user can provide only one solution per assignment, hence if an existing solution exist then it will be updated otherwise a new one will be created. As assignments may support group submission, so for group submission the gws_name_alias parameter is used to submit as a group. A separate call to UPLOADFILE API is necessary to provide solution documents (if necessary). The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. If the itemid does not fall within the valid range of existing itemids, then an error will be reported. Only authenticated users who are member of the specified courseroom can call this method and the item will be updated if the authenticated user has sufficient permission for updating.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
assignmentidintItemId of the desired assignment.
cidstringDesired courseroom id.
commentstringUser's comment/note on the submission.
gws_name_aliasstringFor group submissions this field is used to identify the corresponding group, it can left empty for individual submission. (if now group submissions are allowed).

Return Value

Range Description

Sample Call

Protocol
POST provideAssignmentSolution?accessToken={ACCESSTOKEN}&cid={CID}&assignmentid={ASSIGNMENTID}&gws_name_alias={GWS_NAME_ALIAS}

<div class="codeJavaScript">{"comment":"Solution of our 1st assignment"}</div>
Live

Sample Response

{"creationTimestamp":123456789,"modifiedTimestamp":987654321,"studentComment":"Our draft submission- A and B.","solutionDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"solutionDirectory":"/example/ws13/13ws-00001/Lists/LA_SolutionsList/A01/S07","submittedByStudents":["Excellence means greatness — the very best (e.g. RWTH)"],"itemId":2,"Status":true}

registerParticipant

Description

Adds a user to the given group (works only for managers).
This method will register a user, as specified with the uid parameter. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
groupNamestringthe role, to which the user should be added (e.g. tutors, managers, extra).
uidstringmatriculation number or TIM-ID or userPrincipalName.

Return Value

Range Description

Sample Call

Protocol
POST registerParticipant?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"groupName":"managers","uid":"ab123789"}</div>
Live

Sample Response

{"success":false,"Status":true}

updateAnnouncement

Description

Update an announcement in the Announcement module.
This method will update an announcement in the Announcement module. The annoucement's itemid and title parameters are mandatory and body, expiretime parameters are optional. Associated docuements (if any) can be uploaded using the UploadFile method. The Description and ExpireTime will be overwritten by these information, excluding the parameters will delete the information onthe old announcement. If the itemid does not fall within the valid range of existing itemids, then an error will be reported. Only authenticated users who are member of the specified courseroom can call this method and the item will be updated if the authenticated user has sufficient permission for updating.

Parameters

NameRangeDescription
*bodystring(Optional) The body/content of the announcement.
*expiretimelong(Optional) Desired time when this element should expire. If the expiretime parameter needs to be a valid unixtimestamp.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.
titlestringThe title of the announcement.

Return Value

Range Description
JSON A status flag and metadata about the updated item.

Sample Call

Protocol
POST updateAnnouncement?accessToken={accessToken}&cid={cid}&itemid={itemid}

<div class="codeJavaScript">{"title":"This is a sample announcement.","body":"Here goes the description of the announcement","expireTime":123456789}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

updateCourseEvents

Description

update existing calendar item.
This method will update the calender event of a specific course room. If the itemid does not fall within the valid range of existing itemids, then an error will be reported. Only authenticated users who are member of the specified courseroom can call this method and the item will be updated if the authenticated user has sufficient permission for updating.

Parameters

NameRangeDescription
*allDaystring(Optional) If event is all day, set to true.
*contentTypestring(Optional) Whether it is a lecture, event, or a custom category.
*descriptionstring(Optional) Description of the event.
*locationstring(Optional) Location of the event.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
endDatelongEnd date of event. Must be in unix time.
eventDatelongDate of event. Must be in unix time.
itemidintItemid of the desired item.
titlestringThe title of the event.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST updateCourseEvent?accessToken={accessToken}&cid={cid}&itemid={itemid}

<div class="codeJavaScript">{"title":"Class Time","contentType":"CampusEvent","location":"Informatik 9","eventDate":1435586400,"endDate":1435590000,"allDay":true,"description":"Party at Chair! Bring some Coockies!","category":"Lecture"}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

updateDiscussionThread

Description

Update an existing discussion thread in the Discussion Forum module.
This method will update an existing discussion thread in the Discussion Forum module, as specified with the selfid parameter. Using the selfid value as an itemid, an additional check will be performed to ensure that the thread exists. If the itemid does not fall within the valid range of existing itemids, then an error will be reported. Only authenticated users who are member of the specified courseroom can call this method and the item will be updated if the authenticated user has sufficient permission for updating.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
bodystringThe body/content of the discussion thread.
cidstringDesired courseroom id.
selfidintSelfid value of the desired thread.
subjectstringTitle/Subject of the discussion thread.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST updateDiscussionThread?accessToken={accessToken}&cid={cid}&selfid={selfid}

<div class="codeJavaScript">{"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

updateDiscussionThreadReply

Description

Update an existing reply in the Discussion Forum module.
This method will update an existing reply in the Discussion Forum module, as specified with the selfid parameter. If the selfid does not fall within the valid range of existing selfids, then an error will be reported. If the itemid does not fall within the valid range of existing itemids, then an error will be reported. Only authenticated users who are member of the specified courseroom can call this method and the item will be updated if the authenticated user has sufficient permission for updating.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
bodystringThe body/content of the discussion thread.
cidstringDesired courseroom id.
selfidintSelfid value of the desired reply.
subjectstringTitle/Subject of the discussion thread reply.

Return Value

Range Description
JSON A status flag and metadata about the updated item.

Sample Call

Protocol
POST updateDiscussionThreadReply?accessToken={accessToken}&cid={cid}&selfid={selfid}

<div class="codeJavaScript">{"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

updateLearningObject

Description

Updates a Learning Object.
This method will update a Learning Object of the course room. The related Media needs to be a video of the media library or the Learning Object Module of L2P may not be able to show it. The Learning Object uses a set of references to items of other modules.

Parameters

NameRangeDescription
*hyperlinksList of int(optional) IDs of the Hyperlinks to be referenced.
*literatureList of int(optional) IDs of the literature elements to be referenced.
*materialsList of int(optional) IDs of the Learning Materials to be referenced.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
descriptionstringThe description of the Learning Object.
itemidintItemid of the desired item.
relatedMediainteger(optional) ID of the Media Library element to be referenced (needs to be a video!).
titlestringThe title of the Learning Object.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST updateLearningObject?accessToken={accessToken}&cid={cid}&itemid={itemid}

<div class="codeJavaScript">{"title":"LO-Title","description":"A simple LearningObject","literature":[42],"materials":[42],"hyperlinks":[42],"relatedMedia":2}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

updateLiterature

Description

Add a literature element in the literature module.
This method will update a literature element in the module. Depending on the content type, different parameters are mandatory. These fields are marked correspondingly. If the title exceeds 255 characters, it will be shortened. If the itemid does not fall within the valid range of existing itemids, then an error will be reported. Only authenticated users who are member of the specified courseroom can call this method and the item will be updated if the authenticated user has sufficient permission for updating.

Parameters

NameRangeDescription
*addressstring(Optional) The address of the literature item (e.g. where to find).
*commentsstring(Optional) a comment for this item.
*doistring(Optional) The doi of the literature item.
*editionstring(Optional) The edition of the literature item.
*isxnstring(Optional) The isxn/isbn identifier of the literature item.
*numberstring(Optional) The number of the literature item.
*relevancestring(Optional) The relevance of the literature item. Possible values are
Mandatory, Optional, None
or
Invalid
.
*rolestring(Optional) The role of the literature item. Possible values are
Primary Literature, Secondary Literature, None
and
Invalid
.
*seriesstring(Optional) The series of the literature item.
*urlstring(Optional) The url for more information or the literature itself.
*urlCommentstring(Optional) The name of the url. This will be shown in L2P instead of the link url if set.
*volumestring(Optional) The volume of the literature item.
accessTokenstringThe OAuth access token.
authorsstringThe authors of the literature item.
booktitlestring(Optional for
New Article, Book
and
Add Literature
) The title of the book of the literature item.
cidstringDesired courseroom id.
contentTypestringThe Conent type of this element. Depending on this parameter, the other parameters may be mandatory. Possible values are
Book, In Book, In Proceedings, New Article
and
Add Literature
(for misc. literature).
fromPagestring(Optional for
New Article, Book
and
Add Literature
) The first page of the relevant part of a book.
itemidintItemid of the desired item.
journalNamestring(Optional for
In Book, In Proceedings, Book
and
Add Literature
) The name of the journal, where the item was published in.
publisherstring(Optional for
New Article
and
Add Literature
) The publisher of the literature item.
titlestringThe title of the literature.
toPagestring(Optional for
New Article, Book
and
Add Literature
) The last page of the relevant part of a book.
yearstringThe year of publication.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST updateLiterature?accessToken={accessToken}&cid={cid}&itemid={itemid}

<div class="codeJavaScript">{"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

updateWiki

Description

Update a wikipage in the Wiki module.
This method will update a wikipage in the Wiki module. The wikipage's TITLE, ITEMID parameters are mandatory and BODY parameter is optional. If desired title already exist in the module, then an error will be generated. If the itemid does not fall within the valid range of existing itemids, then an error will be reported. Only authenticated users who are member of the specified courseroom can call this method and the item will be updated if the authenticated user has sufficient permission for updating.

Parameters

NameRangeDescription
*bodystring(Optional) The body/content of the Wiki.
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.
titlestringThe title of the Wiki.

Return Value

Range Description
JSON A status flag and metadata about the added item.

Sample Call

Protocol
POST updateWiki?accessToken={accessToken}&cid={cid}&itemid={itemid}

<div class="codeJavaScript">{"title":"Codemates group","body":"Codemates group is consists of four people who love to code."}</div>
Live

Sample Response

{"itemId":29,"itemUrl":"https://example.com/ssYY/YYss-12345/Lists/ExampleList/AllItems.aspx?id=29","modifiedTimestamp":987654321,"creationTimestamp":123456789,"attachmentFolderPath":"null","comment":"Excellence means greatness — the very best (e.g. RWTH)","Status":true}

uploadInAnnouncement

Description

Upload a file into the announcement module.
This method will upload an attachment in the announcement module. Only authenticated users who are member of the specified courseroom can call this method and the file will be uploaded if the authenticated user has sufficient permission for uploading.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
attachmentDirectorystringDesired folder where the file should be uploaded. Path pattern: /[semester]/[cid]/Lists/AnnouncementDocuments.
cidstringDesired courseroom id.
fileNamestringIf a file already exists with the same name then the a new file will created with the same name as well as having timestamp as suffix.
streambase64 stringBase64 encoded value from the byte array of the file which should be uploaded.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
POST uploadInAnnouncement?accessToken={accessToken}&cid={cid}&attachmentDirectory={attachmentDirectory}

<div class="codeJavaScript">{"fileName":"abcd.text","stream":"cnd0aC1hYWNoZW4uZGU="}</div>
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

uploadInAssignments

Description

Upload a file into the Assignments module.
This method will upload an attachment in the Assignments module. Only authenticated users who are member of the specified courseroom can call this method and the file will be uploaded if the authenticated user has sufficient permission for uploading.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
fileNamestringIf a file already exists with the same name then the a new file will created with the same name as well as having timestamp as suffix.
solutionDirectorystringDesired folder where the file should be uploaded. The folder path can be checked using the method provideAssignmentSolution or viewAssignment. They provide a field solutionDirectory with the structure [itemId]|/[semesterid]/[cid]/assessment/Lists/LA_SolutionDocuments/A[itemId]/S[solutionName].
streambase64 stringBase64 encoded value from the byte array of the file which should be uploaded.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
POST uploadInAssignments?accessToken={accessToken}&cid={cid}&solutionDirectory={solutionDirectory}

<div class="codeJavaScript">{"fileName":"abcd.text","stream":"cnd0aC1hYWNoZW4uZGU="}</div>
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

uploadInEmail

Description

Upload a file into the email module.
This method will upload an attachment in the email module. Only authenticated users who are member of the specified courseroom can call this method and the file will be uploaded if the authenticated user has sufficient permission for uploading.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
fileNamestringIf a file already exists with the same name then the a new file will created with the same name as well as having timestamp as suffix.
streambase64 stringBase64 encoded value from the byte array of the file which should be uploaded.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
POST uploadInEmail?accessToken={accessToken}&cid={cid}

<div class="codeJavaScript">{"fileName":"abcd.text","stream":"cnd0aC1hYWNoZW4uZGU="}</div>
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

uploadInLearningMaterials

Description

Upload a file into the Learning Materials module.
This method will upload an attachment in the Learning Materials module. Only authenticated users who are member of the specified courseroom can call this method and the file will be uploaded if the authenticated user has sufficient permission for uploading.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
fileNamestringIf a file already exists with the same name then the a new file will created with the same name as well as having timestamp as suffix.
sourceDirectory*stringDesired folder where the file should be uploaded. Path pattern: /[semester]/[cid]/Lists/StructuredMaterials.
streambase64 stringBase64 encoded value from the byte array of the file which should be uploaded.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
POST uploadInLearningMaterials?accessToken={accessToken}&cid={cid}&sourceDirectory={sourceDirectory}

<div class="codeJavaScript">{"fileName":"abcd.text","stream":"cnd0aC1hYWNoZW4uZGU="}</div>
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

uploadInMediaLibrary

Description

Upload a file into the Media Library module.
This method will upload an attachment in the Media Library module. Only authenticated users who are member of the specified courseroom can call this method and the file will be uploaded if the authenticated user has sufficient permission for uploading.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
fileNamestringIf a file already exists with the same name then the a new file will created with the same name as well as having timestamp as suffix.
sourceDirectorystringDesired folder where the file should be uploaded. Path pattern: /[semester]/[cid]/Lists/MediaLibrary/[*folder] where the *folder parameter is optional.
streambase64 stringBase64 encoded value from the byte array of the file which should be uploaded.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
POST uploadInMediaLibrary?accessToken={accessToken}&cid={cid}&sourceDirectory={sourceDirectory}

<div class="codeJavaScript">{"fileName":"abcd.text","stream":"cnd0aC1hYWNoZW4uZGU="}</div>
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

uploadInSharedDocuments

Description

Upload a file into the Shared Documents module.
This method will upload an attachment in the Shared Documents module. Only authenticated users who are member of the specified courseroom can call this method and the file will be uploaded if the authenticated user has sufficient permission for uploading.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
fileNamestringIf a file already exists with the same name then the a new file will created with the same name as well as having timestamp as suffix.
sourceDirectorystringDesired folder where the file should be uploaded. Path pattern: /[semester]/[cid]/collaboration/Lists/SharedDocuments/[*folder] where the *folder parameter is optional.
streambase64 stringBase64 encoded value from the byte array of the file which should be uploaded.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
POST uploadInSharedDocuments?accessToken={accessToken}&cid={cid}&sourceDirectory={sourceDirectory}

<div class="codeJavaScript">{"fileName":"abcd.text","stream":"cnd0aC1hYWNoZW4uZGU="}</div>
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

uploadInTutorDomain

Description

Upload a file into the Tutor Domain module.
This method will upload an attachment in the Tutor Domain module. Only authenticated users who are member of the specified courseroom can call this method and the file will be uploaded if the authenticated user has sufficient permission for uploading.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
fileNamestringIf a file already exists with the same name then the a new file will created with the same name as well as having timestamp as suffix.
sourceDirectorystringDesired folder where the file should be uploaded. relative Path pattern: [/folder][/folder]{...} -- if string is empty, the root folder is used - use this parameter to choose a subfolder. If they are not existing, they will be created.
streambase64 stringBase64 encoded value from the byte array of the file which should be uploaded.

Return Value

Range Description
JSON A status flag and a system generated comment after the request.

Sample Call

Protocol
POST uploadInTutorDomain?accessToken={accessToken}&cid={cid}&sourceDirectory={sourceDirectory}

<div class="codeJavaScript">{"fileName":"abcd.text","stream":"cnd0aC1hYWNoZW4uZGU="}</div>
Live

Sample Response

{"comment":"Requested operation has been completed successfully.","Status":true}

viewActiveFeatures

Description

Get (in)active features.
This method will return lists of active ind inactive features in the course room. Users cannot work with inactive features (like Wiki). This Call only shows features that managers can (de)activate for this course room. Special modules that have to be activated from ITC/CiL will only appear in this list after that.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON Lists of (in)active Features

Sample Call

Protocol
GET viewActiveFeatures?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"active":["Excellence means greatness — the very best (e.g. RWTH)"],"inactive":["Excellence means greatness — the very best (e.g. RWTH)"],"Status":true}

viewAllAnnouncementCount

Description

Return number of announcements from the Announcement module.
This method will return the number of all announcements from the Announcement module. Expired and non-expired announcents both will be counted. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of announcement items. If no item exist in announcement module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllAnnouncementCount?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"count":5,"Status":true}

viewAllAnnouncements

Description

Return all announcements from the Announcement module.
This method will return all announcements from the Announcement module. Expired and non-expired announcents both will be returned from the list and items with null expirytime will be reported as
"expireTime": 0
. If an announcement item contains attachements then metadata about the attachement(s) will be provided. A separate call to downloadFile API is necessary to download the attachment(s). The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of announcement items. If no item exist in announcement module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllAnnouncements?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"modifiedTimestamp":123456798,"created":123456798,"itemId":29,"attachmentDirectory":"/ss14/14ss-0000/Lists/AnnouncementDocuments/","title":"This is a sample announcement.","body":"Here goes the description of the announcement","expireTime":123456789}],"Status":true}

viewAllAssignments

Description

Return all assignments from the Assignments module.
This method will return all assignments from the Assignment module. If the assignment has associated documents, then A separate call to downloadFile API is necessary to download the assignment documents. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of assignment items. If no item exist in assignment module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllAssignments?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"itemId":29,"title":"Getting started","description":"This excercise will teach you how about basics","totalPoint":100,"dueDate":987654321,"assignmentPublishDate":987651221,"groupSubmissionAllowed":false,"assignmentDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"correction":null,"solution":null,"SampleSolutionDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}]}],"Status":true}

viewAllCount

Description

Get Item Counts of different modules.
This method will return the number of items of different modules of the l2p. In case, one module is deactivated the method will still respond with counts of the other modules.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON item Counts of the modules

Sample Call

Protocol
GET viewAllCount?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"DiscussionItems":7,"Hyperlinks":71,"Announcements":3,"LearningMaterials":2,"Wikis":27,"SharedDocuments":9,"MediaLibraryItems":0,"LiteratureItems":8,"failed":"Discussions,wikis,","Status":true}

viewAllCourseEvents

Description

View events from all courses.
This method will retrieve all the calendar events from every course in the current semester. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.

Return Value

Range Description
JSON A status flag and an array of calendar items. If no item exist in calendar module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllCourseEvents?accessToken={accessToken}
Live

Sample Response

{"dataSet":[{"createdBy":"Mr. Schneider","modifiedBy":"Mrs. Smith","courseID":"14ws-14118","lastModified":124458566,"created":124458566,"itemID":1,"isRecurringItem":false,"title":"Class Time","contentType":"CampusEvent","location":"Informatik 9","eventDate":1435586400,"endDate":1435590000,"allDay":true,"description":"Party at Chair! Bring some Coockies!","category":"Lecture"}],"Status":true}

viewAllCourseInfo

Description

Get all course information.
This method returns all course information from L2P. The CourseStatus can be either
open, closed, reaadonly, readonly+closed, downgraded or unknown.
Both authenticated user and annonymously authenticated user can call this method and returned dataset will be same for all.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.

Return Value

Range Description
JSON Public information about a course.

Sample Call

Protocol
GET viewAllCourseInfo?accessToken={accessToken}
Live

Sample Response

{"dataSet":[{"uniqueid":"12ws-00000","semester":"ws12","courseTitle":"Introduction to API","description":"A sample courseroom for sandbox usage.","url":"https://www3.elearning.rwth-aachen.de/ws12/12ws-00000","courseStatus":"open","itemId":29,"Status":true}],"Status":true}

viewAllCourseInfoByCurrentSemester

Description

Get all course information of the current semester.
This method returns all course information from L2P for the current semester (e.g. ws14). The CourseStatus can be either
open, closed, reaadonly, readonly+closed, downgraded or unknown
. Both authenticated user and annonymously authenticated user can call this method and returned dataset will be same for all.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.

Return Value

Range Description
JSON Public information about a course.

Sample Call

Protocol
GET viewAllCourseInfoByCurrentSemester?accessToken={accessToken}
Live

Sample Response

{"dataSet":[{"uniqueid":"12ws-00000","semester":"ws12","courseTitle":"Introduction to API","description":"A sample courseroom for sandbox usage.","url":"https://www3.elearning.rwth-aachen.de/ws12/12ws-00000","courseStatus":"open","itemId":29,"Status":true}],"Status":true}

viewAllCourseInfoBySemester

Description

Get all course information of the semester.
This method returns all course information from L2P for the given semester (e.g. ws14). The CourseStatus can be either
open, closed, reaadonly, readonly+closed, downgraded or unknown.
Both authenticated user and annonymously authenticated user can call this method and returned dataset will be same for all. .

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
semesterstringDesired semester id.

Return Value

Range Description
JSON Public information about a course.

Sample Call

Protocol
GET viewAllCourseInfoBySemester?accessToken={accessToken}&semester={semester}
Live

Sample Response

{"dataSet":[{"uniqueid":"12ws-00000","semester":"ws12","courseTitle":"Introduction to API","description":"A sample courseroom for sandbox usage.","url":"https://www3.elearning.rwth-aachen.de/ws12/12ws-00000","courseStatus":"open","itemId":29,"Status":true}],"Status":true}

viewAllDiscussionItemCount

Description

Return number of all discussion items from the Discussion Forum module.
This method will return the number of discussion items from Discussion Forum module. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of discussion forum items. If no item exist in discussion forum module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllDiscussionItemCount?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"count":5,"Status":true}

viewAllDiscussionItems

Description

Return all discussion threads from the Discussion Forum module.
This method will return all discussion thread and replies to those discussion threads from Discussion Forum module. parentDiscussionId, replyToId and selfId attributes can be used to compute a tree of the discussion threads. Among the returned items,
"replyToId": 0
represent a discussion thread and items will be returned from all the available tabs (recent, my discussions, unanswered questions). The item bodies may contain HTML-tags for formatting. The byMe field indicates whether the item was created by the current user. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of discussion forum items. If no item exist in discussion forum module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllDiscussionItems?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"from":"A courseroom user","byMe":false,"modifiedTimestamp":789456132,"created":789456132,"selfId":8,"replyToId":0,"parentDiscussionId":7,"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}],"Status":true}

viewAllDiscussionRootItems

Description

Return the root elements of all discussion threads from the Discussion Forum module.
This method will return the root elements (thread-starting items) from Discussion Forum module. The item bodies may contain HTML-tags for formatting. The byMe field indicates whether the item was created by the current user. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of discussion forum items. If no item exist in discussion forum module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllDiscussionRootItems?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"from":"A courseroom user","byMe":false,"modifiedTimestamp":789456132,"created":789456132,"selfId":8,"replyToId":0,"parentDiscussionId":7,"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}],"Status":true}

viewAllEmails

Description

Return all emails from the Email module.
This method will return all emails from the Email module. If an email item contains attachements then metadata about the attachement(s) will be provided. A separate call to DOWNLOADFILE API is necessary to download the attachment(s). Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of email items. If no item exist in email module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllEmails?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"from":"ab123456@rwth-aachen.de;","itemId":212,"modifiedTimestamp":123456798,"created":123456798,"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"recipients":"managers;tutors;students;","cc":"administrator@example.rwth-aachen.de","body":"This is a sample email.","subject":"This is the subject of the email","replyTo":"Reply to my address"}],"Status":true}

viewAllHyperlinkCount

Description

Return number of all hyperlinks from the Hyperlinks module.
This method will return the number of all hyperlinks from the Hyperlinks module. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of hyperlink items. If no item exist in hyperlink module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllHyperlinkCount?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"count":3,"Status":true}

viewAllLearningMaterials

Description

Return all learning material items from the Learning Materials module.
This method will return all learning material items from the Learning Material module. The items are accesible in at least one of the available views (Default View| Topic Matrix| All Files| Date Matrix). From the returned items, parentFolderId parameter can be used to build a folder tree of items in the module. Items with identical parentFolderId and itemId represent items in the root folder. Metadata information about the item will be provided in fileInformation attribute of the returned item. A separate call to downloadFile API is necessary to download the item. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. The field selfUrl of the response is returned for both folders and files, it allows to locate the resource in the file tree. Although sometimes the downloadUrl is the same as the selfUrl (files), the selfUrl does not work for the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description

Sample Call

Protocol
GET viewAllLearningMaterials?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"sourceDirectory":"/ss14/14ss-0000/List/Materials/","itemId":29,"name":"readme.txt","parentFolderId":98,"isDirectory":true,"created":123488992,"lastModified":123488992,"selfUrl":"/ss14/14ss-12345/Lists/StructuredMaterials/Test","relatedLectureDates":[42],"byMe":true,"fileInformation":null}],"Status":true}

viewAllLearningObjects

Description

Return all Learning Objects.
This method will return all Learning Objects of a course room. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of learning object items. If no item exist in learning object module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllLearningObjects?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"title":"Title","itemId":29,"description":"This Learning object is nice","created":123456789,"lastModified":123456789,"relatedLiterature":[{"state":"Digitalization Successful","availability":"not available","itemID":2,"modified":12346579,"created":13456789,"author":"Dr. Gustav Geier","editor":"Dr. Gisela Geier","literatureCategory":"Good stuff","attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}],"relatedLearningMaterials":[{"sourceDirectory":"/ss14/14ss-0000/List/Materials/","itemId":29,"name":"readme.txt","parentFolderId":98,"isDirectory":true,"created":123488992,"lastModified":123488992,"selfUrl":"/ss14/14ss-12345/Lists/StructuredMaterials/Test","relatedLectureDates":[42],"byMe":true,"fileInformation":null}],"relatedMediaElements":[{"sourceDirectory":"/ss14/14ss-0000/List/MediaLibrary/","thumbnailUrl":"/ss14/14ss-0000/List/MediaLibrary/{folder}/_t/CAPTURE.jpg","name":"CAPTURE.JPG","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"/ss14/14ss-0000/List/MediaLibrary/Test","created":134299422,"lastModified":134299422,"fileInformation":null}],"relatedHyperlinks":[{"itemId":29,"lastModified":1447769942,"created":1447769941,"url":"http://www.example.com","notes":"We can use this url for any kind of url documentation.","description":"This url is the standard url for referencing as defined by standard authority."}],"relatedLectureDates":[42]}],"Status":true}

viewAllLiterature

Description

Return all Literature from the Literature module.
This method will return all Literature items from a specific course room. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of literature items. If no item exist in literature module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllLiterature?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"state":"Digitalization Successful","availability":"not available","itemID":2,"modified":12346579,"created":13456789,"author":"Dr. Gustav Geier","editor":"Dr. Gisela Geier","literatureCategory":"Good stuff","attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}],"Status":true}

viewAllLiteratureCount

Description

Return number of all Literature elements from the Literature module.
This method will return the number of all Literature items from a specific course room. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of literature items. If no item exist in literature module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllLiteratureCount?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"count":2,"Status":true}

viewAllMediaLibraries

Description

Return all items from the Media Library module.
This method will return all items from the Media Library module. From the returned items, parentFolderId parameter can be used to build a folder tree of items in the module. Items with identical parentFolderId and itemId represent items in the root folder. Metadata information about the item will be provided in fileInformation attribute of the returned item. A separate call to downloadFile API is necessary to download the item. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. The field selfUrl of the response is returned for both folders and files, it allows to locate the resource in the file tree. Although sometimes the downloadUrl is the same as the selfUrl (files), the selfUrl does not work for the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and a single media library item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllMediaLibraries?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"sourceDirectory":"/ss14/14ss-0000/List/MediaLibrary/","thumbnailUrl":"/ss14/14ss-0000/List/MediaLibrary/{folder}/_t/CAPTURE.jpg","name":"CAPTURE.JPG","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"/ss14/14ss-0000/List/MediaLibrary/Test","created":134299422,"lastModified":134299422,"fileInformation":null}],"Status":true}

viewAllMediaLibraryCount

Description

Return number of all items from the Media Library module.
This method will return the number of all items from the Media Library module. Caution: From the returned items, parentFolderId parameter can be used to build a folder tree of items in the module. Items with identical parentFolderId and itemId represent items in the root folder. Metadata information about the item will be provided in fileInformation attribute of the returned item. A separate call to downloadFile API is necessary to download the item. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. The field selfUrl of the response is returned for both folders and files, it allows to locate the resource in the file tree. Although sometimes the downloadUrl is the same as the selfUrl (files), the selfUrl does not work for the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and a single media library item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllMediaLibraryCount?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"count":2,"Status":true}

viewAllSharedDocumentCount

Description

Return number of items from the Shared Documents module.
This method will return number of all items from the Shared Documents module. Caution: This will not count folder definitions - only documents. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and a single shared document item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllSharedDocumentCount?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"count":3,"Status":true}

viewAllSharedDocuments

Description

Return all items from the Shared Documents module.
This method will return all items from the Shared Documents module. From the returned items, parentFolderId parameter can be used to build a folder tree of items in the module. Items with identical parentFolderId and itemId represent items in the root folder. Metadata information about the item will be provided in fileInformation attribute of the returned item. A separate call to downloadFile API is necessary to download the item. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. The field selfUrl of the response is returned for both folders and files, it allows to locate the resource in the file tree. Although sometimes the downloadUrl is the same as the selfUrl (files), the selfUrl does not work for the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and a single shared document item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllSharedDocuments?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"sourceDirectory":"/ss14/14ss-0000/List/SharedDocs/abcd","name":"readme.text","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"Excellence means greatness — the very best (e.g. RWTH)","lastModified":1447769942,"created":1447769941,"byMe":true,"fileInformation":null}],"Status":true}

viewAllTutorDomainDocuments

Description

Returns all material items from the Tutor Domain module.
This method will return all Tutor Domain material items from the Tutor Domain module. From the returned items, parentFolderId parameter can be used to build a folder tree of items in the module. Items with identical parentFolderId and itemId represent items in the root folder. Metadata information about the item will be provided in fileInformation attribute of the returned item. A separate call to downloadFile API is necessary to download the item. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. The field selfUrl of the response is returned for both folders and files, it allows to locate the resource in the file tree. Although sometimes the downloadUrl is the same as the selfUrl (files), the selfUrl does not work for the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description

Sample Call

Protocol
GET viewAllTutorDomainDocuments?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"sourceDirectory":"/ss14/14ss-0000/List/Materials/","itemId":29,"name":"readme.txt","parentFolderId":98,"isDirectory":true,"created":123488992,"lastModified":123488992,"selfUrl":"/ss14/14ss-12345/Lists/StructuredMaterials/Test","byMe":true,"fileInformation":null}],"Status":true}

viewAllWikiCount

Description

Return number of all wiki pages from the Wiki module.
This method will return the number of all wiki pages from the Wiki module. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of wiki items. If no item exist in wiki module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllWikiCount?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"count":2,"Status":true}

viewAllWikis

Description

Return all wiki pages from the Wiki module.
This method will return all wiki pages from the Wiki module. If a wiki page has several versions, then only Latest verison will be provided. The wiki's description field will not be returned, a separate call to viewWiki or viewWikiVersion is necessary to get the body of the wiki. In case, the Wiki was edited or athored by the curent user, the string by me will be returned for these fields. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of wiki items. If no item exist in wiki module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAllWikis?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"itemId":4,"url":"http://example.com/ss14/14ss-00002/Lists/WikiList1/MyWiki%202.aspx","authors":"Excellence means greatness — the very best (e.g. RWTH)","versionIds":[42],"lastModified":123456789,"editor":"Gisela Geier","title":"Codemates group","body":"Codemates group is consists of four people who love to code."}],"Status":true}

viewAnnouncement

Description

Return single announcement from the Announcement module.
This method will return a single announcement from the Announcement module, as specified with the itemid parameter. Returned annoucement can be expired or non-expired and items with null expirytime will be reported as
"expireTime": 0
. If an announcement item contains attachements then metadata about the attachement(s) will be provided. A separate call to downloadFile API is necessary to download the attachment(s). The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a single announcement item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAnnouncement?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"dataSet":[{"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"modifiedTimestamp":123456798,"created":123456798,"itemId":29,"attachmentDirectory":"/ss14/14ss-0000/Lists/AnnouncementDocuments/","title":"This is a sample announcement.","body":"Here goes the description of the announcement","expireTime":123456789}],"Status":true}

viewAssignment

Description

Return requested assignment from the Assignments module.
This method will return the assignment from the Assignment module. If the assignment has associated documents, then A separate call to downloadFile API is necessary to download the assignment documents. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. The field selfUrl of the response is returned for both folders and files, it allows to locate the resource in the file tree. Although sometimes the downloadUrl is the same as the selfUrl (files), the selfUrl does not work for the downloadFile Method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and an array of assignment items. If no item exist in assignment module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewAssignment?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"dataSet":[{"itemId":29,"title":"Getting started","description":"This excercise will teach you how about basics","totalPoint":100,"dueDate":987654321,"assignmentPublishDate":987651221,"groupSubmissionAllowed":false,"assignmentDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"correction":null,"solution":null,"SampleSolutionDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}]}],"Status":true}

viewAvailableGroupsInGroupWorkspace

Description

Return all groups available for joining from the Group Workspace module.
This method will return all groups available for joining from the Group Workspace module. Returned items have at least 1 available slot remaining in the moment the api call was made into the system. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A list of available groups where at least 1 place is available to join.

Sample Call

Protocol
GET viewAvailableGroupsInGroupWorkspace?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"systemGeneratedAlias":"GWS_learn_programming","groupId":4,"members":["Excellence means greatness — the very best (e.g. RWTH)"],"memberCount":4,"workspaceUrl":"ss14/14ss-00001/collaboration/GWS_learn_programming/GWSHome.aspx","description":"Group for programmers...","name":"Learn programming"}],"Status":true}

viewCourseEvents

Description

View events from one course.
This method will retrieve all the calendar events from a specific course. When querying old courses, this call might fail due to problems of the Calender Module. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of calendar items. If no item exist in calendar module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewCourseEvents?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"createdBy":"Mr. Schneider","modifiedBy":"Mrs. Smith","courseID":"14ws-14118","lastModified":124458566,"created":124458566,"itemID":1,"isRecurringItem":false,"title":"Class Time","contentType":"CampusEvent","location":"Informatik 9","eventDate":1435586400,"endDate":1435590000,"allDay":true,"description":"Party at Chair! Bring some Coockies!","category":"Lecture"}],"Status":true}

viewCourseInfo

Description

Get information about a course.
This method returns information about a course. The CourseStatus can be either
open, closed, reaadonly, readonly+closed, downgraded or unknown.
Both authenticated user and annonymously authenticated user can call this method and returned dataset will be same for all.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON Public information about a course.

Sample Call

Protocol
GET viewCourseInfo?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"uniqueid":"12ws-00000","semester":"ws12","courseTitle":"Introduction to API","description":"A sample courseroom for sandbox usage.","url":"https://www3.elearning.rwth-aachen.de/ws12/12ws-00000","courseStatus":"open","itemId":29,"Status":true}],"Status":true}

viewDiscussionItem

Description

Return single item from the Discussion Forum module.
This method will return a single thread and/or replies from Discussion Forum module, as specified with the itemid parameter. It will return the item with the id of itemid and all replies to this item inside the forum. If the item is a thread, then all replies to that thread will also be returned. The returned item is available in atleast one of the available tabs (recent, my discussions, unanswered questions) The item bodies may contain HTML-tags for formatting. The byMe field indicates whether the item was created by the current user. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a single discussion forum item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewDiscussionItem?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"dataSet":[{"from":"A courseroom user","byMe":false,"modifiedTimestamp":789456132,"created":789456132,"selfId":8,"replyToId":0,"parentDiscussionId":7,"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}],"Status":true}

viewEmail

Description

Return single email from the Email module.
This method will return a single email from the email module, as specified with the itemid parameter. If the email contains attachements then metadata about the attachement(s) will be provided. A separate call to DOWNLOADFILE API is necessary to download the attachment(s). Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a single email item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewEmail?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"dataSet":[{"from":"ab123456@rwth-aachen.de;","itemId":212,"modifiedTimestamp":123456798,"created":123456798,"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"recipients":"managers;tutors;students;","cc":"administrator@example.rwth-aachen.de","body":"This is a sample email.","subject":"This is the subject of the email","replyTo":"Reply to my address"}],"Status":true}

viewExamResults

Description

View Exam Results.
View the exam results for a course room. If the user is manager, all items will be returned. Otherwise, only the item belonging to the user is returned if it is published by the managers. The custom fields will be returned as a List of Key/Value-Pairs (string/string) because these fields will vary depending on course and user. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and a single exam results item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewExamResults?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"matNr":"100201","firstname":"Gustav Gesinde","lastname":"Geier","grade":"4.0","freiVermerk":"nice one","pversuch":"Versuch","pvermerk":"Vermerk","isPublished":true,"studentUser":"Gustav Geier","customFields":{"pairs":[]}}],"Status":true}

viewExamResultsStatistics

Description

View Grade Distribution.
View the Grade Distribution of exam results for a course room. If the grades are not published yet, an empty set of grades is returned. The call will only provide statistics about published grades. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and a single grade distribution item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewExamResultsStatistics?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataset":[{"grade":"1.0","count":5}],"Status":true}

viewGradeBook

Description

View Grade Book.
View the Grade Book data for a course room. If the user is manager, all items will be returned. Otherwise, only the item belonging to the user is returned. The custom fields will be returned as a List of Key/Value-Pairs (string/string) because these fields will vary depending on course and user. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and a single grade book item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewGradeBook?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"dataSet":[{"student":"Gereon Geier","fields":{"pairs":[]}}],"Status":true}

viewLearningMaterial

Description

Return a learning material item from the Learning Materials module.
This method will return a learning material item from the Learning Material module, as specified with the itemid parameter. The item is accesible in atleast one of the available views (Default View| Topic Matrix| All Files| Date Matrix). From the returned items, parentFolderId parameter can be used to build a folder tree of items in the module. Items with identical parentFolderId and itemId represent items in the root folder. Metadata information about the item will be provided in fileInformation attribute of the returned item. A separate call to downloadFile API is necessary to download the item. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. The field selfUrl of the response is returned for both folders and files, it allows to locate the resource in the file tree. Although sometimes the downloadUrl is the same as the selfUrl (files), the selfUrl does not work for the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description

Sample Call

Protocol
GET viewLearningMaterial?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"dataSet":[{"sourceDirectory":"/ss14/14ss-0000/List/Materials/","itemId":29,"name":"readme.txt","parentFolderId":98,"isDirectory":true,"created":123488992,"lastModified":123488992,"selfUrl":"/ss14/14ss-12345/Lists/StructuredMaterials/Test","relatedLectureDates":[42],"byMe":true,"fileInformation":null}],"Status":true}

viewLearningMaterialCount

Description

Return number of learning material items from the Learning Materials module.
This method will return the number of learning material items from the Learning Material module. Caution: This method counts the actual learning material objects. Folder definitions are not counted. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description

Sample Call

Protocol
GET viewLearningMaterialCount?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"count":5,"Status":true}

viewLearningObject

Description

Return a Learning Object.
This method will return a Learning Object of a course room. The Object is datermined by the itemid. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a single learning object item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewLearningObject?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"dataSet":[{"title":"Title","itemId":29,"description":"This Learning object is nice","created":123456789,"lastModified":123456789,"relatedLiterature":[{"state":"Digitalization Successful","availability":"not available","itemID":2,"modified":12346579,"created":13456789,"author":"Dr. Gustav Geier","editor":"Dr. Gisela Geier","literatureCategory":"Good stuff","attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}],"relatedLearningMaterials":[{"sourceDirectory":"/ss14/14ss-0000/List/Materials/","itemId":29,"name":"readme.txt","parentFolderId":98,"isDirectory":true,"created":123488992,"lastModified":123488992,"selfUrl":"/ss14/14ss-12345/Lists/StructuredMaterials/Test","relatedLectureDates":[42],"byMe":true,"fileInformation":null}],"relatedMediaElements":[{"sourceDirectory":"/ss14/14ss-0000/List/MediaLibrary/","thumbnailUrl":"/ss14/14ss-0000/List/MediaLibrary/{folder}/_t/CAPTURE.jpg","name":"CAPTURE.JPG","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"/ss14/14ss-0000/List/MediaLibrary/Test","created":134299422,"lastModified":134299422,"fileInformation":null}],"relatedHyperlinks":[{"itemId":29,"lastModified":1447769942,"created":1447769941,"url":"http://www.example.com","notes":"We can use this url for any kind of url documentation.","description":"This url is the standard url for referencing as defined by standard authority."}],"relatedLectureDates":[42]}],"Status":true}

viewLiterature

Description

Return one Literature element from the Literature module.
This method will return one Literature item from a specific course room identified by its ID. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and an array of literature items. If no item exist in literature module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewLiterature?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"dataSet":[{"state":"Digitalization Successful","availability":"not available","itemID":2,"modified":12346579,"created":13456789,"author":"Dr. Gustav Geier","editor":"Dr. Gisela Geier","literatureCategory":"Good stuff","attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}],"Status":true}

viewMediaLibrary

Description

Return single item from the Media Library module.
This method will return a single item from the Media Library module, as specified with the itemid parameter. From the returned items, parentFolderId parameter can be used to build a folder tree of items in the module. Items with identical parentFolderId and itemId represent items in the root folder. Metadata information about the item will be provided in fileInformation attribute of the returned item. A separate call to downloadfile API is necessary to download the item. The response contains a downloadUrl element which purpose is exclusively to be used in the downloadFile method. The field selfUrl of the response is returned for both folders and files, it allows to locate the resource in the file tree. Although sometimes the downloadUrl is the same as the selfUrl (files), the selfUrl does not work for the downloadFile method. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a single media library item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewMediaLibrary?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"dataSet":[{"sourceDirectory":"/ss14/14ss-0000/List/MediaLibrary/","thumbnailUrl":"/ss14/14ss-0000/List/MediaLibrary/{folder}/_t/CAPTURE.jpg","name":"CAPTURE.JPG","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"/ss14/14ss-0000/List/MediaLibrary/Test","created":134299422,"lastModified":134299422,"fileInformation":null}],"Status":true}

viewMyGroupWorkspace

Description

Return a list of groups for a specific user from the Group Workspace module.
This method will return a list of groups from Group Workspace module, where in each group the authenticated user is a member. Any courseroom user can invite other courseroom users to join into a group where the courseroom user is a member, such invitations to the authenticated user (from other courseroom users) will be wrapped as
'invitationFromOtherUsers': []
in the result dataSet. Moreover, any courseroom user can request to join into any other groups where atleast one place is available. Such requests to the authenticated user will be wrapped as
'requestFromOtherUsers': []
and such requests from the authenticated user will be wrapped as
'requestToOtherGroups': []
in the returned result. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and an array of group workspace items. If no item exist in group workspace module, then an empty dataset will be returned.

Sample Call

Protocol
GET viewMyGroupWorkspace?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"invitationFromOtherUsers":[{"itemId":1,"groupName":"Le 1337 Group","comment":"A great working group."}],"requestFromOtherUsers":[{"itemId":1,"groupName":"Le 1337 Group","comment":"A great working group."}],"requestToOtherGroups":[{"itemId":1,"groupName":"Le 1337 Group","comment":"A great working group."}],"dataSet":[{"systemGeneratedAlias":"GWS_learn_programming","groupId":4,"members":["Excellence means greatness — the very best (e.g. RWTH)"],"memberCount":4,"workspaceUrl":"ss14/14ss-00001/collaboration/GWS_learn_programming/GWSHome.aspx","description":"Group for programmers...","name":"Learn programming"}],"Status":true}

viewUserRole

Description

Get role information of an user in a courseroom.
This method will return the groups the user is member of in the courseroom. Groups are
students, tutors, managers, extra
for the default course room groups. Every user of a course room can use this method to get their own role(s) in this room.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON Role information of user

Sample Call

Protocol
GET viewUserRole?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"role":"students;managers;extra;","Status":true}

viewWiki

Description

Return single wiki page from the Wiki module.
This method will return a single wiki page from the Wiki module, as specified with the itemid parameter. If the wiki page has several versions, then only Latest verison will be provided. In case, the Wiki was edited or athored by the curent user, the string by me will be returned for these fields. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.

Return Value

Range Description
JSON A status flag and a single wiki item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewWiki?accessToken={accessToken}&cid={cid}&itemid={itemid}
Live

Sample Response

{"dataSet":[{"itemId":4,"url":"http://example.com/ss14/14ss-00002/Lists/WikiList1/MyWiki%202.aspx","authors":"Excellence means greatness — the very best (e.g. RWTH)","versionIds":[42],"lastModified":123456789,"editor":"Gisela Geier","title":"Codemates group","body":"Codemates group is consists of four people who love to code."}],"Status":true}

viewWikiVersion

Description

Return single wiki page's specific version from the Wiki module.
This method will return a single wiki page's specific version from the Wiki module, as specified with the itemid and versionid parameter. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
itemidintItemid of the desired item.
versionidintSpecific version label of the item.

Return Value

Range Description
JSON A status flag and a single wiki item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET viewWikiVersion?accessToken={accessToken}&cid={cid}&itemid={itemid}&versionid={versionid}
Live

Sample Response

{"dataSet":[{"itemId":4,"url":"http://example.com/ss14/14ss-00002/Lists/WikiList1/MyWiki%202.aspx","authors":"Excellence means greatness — the very best (e.g. RWTH)","versionIds":[42],"lastModified":123456789,"editor":"Gisela Geier","title":"Codemates group","body":"Codemates group is consists of four people who love to code."}],"Status":true}

whatsAllNewSince

Description

Get new items of all your Courserooms with definable timespan.
This method will return the items that were modified in the last pastMinutes minutes in all course rooms. Only positive values of pastMinutes are allowed. Remark: Only the courses of the current Semester will be queried. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
pastMinutesintthe number of minutes in the past.

Return Value

Range Description
JSON A status flag and an array of whats new items. If no item exist in whats new module, then an empty dataset will be returned.

Sample Call

Protocol
GET whatsAllNewSince?accessToken={accessToken}&pastMinutes={pastMinutes}
Live

Sample Response

{"dataset":[{"cid":"14ss-00003","announcements":[{"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"modifiedTimestamp":123456798,"created":123456798,"itemId":29,"attachmentDirectory":"/ss14/14ss-0000/Lists/AnnouncementDocuments/","title":"This is a sample announcement.","body":"Here goes the description of the announcement","expireTime":123456789}],"assignments":[{"itemId":29,"title":"Getting started","description":"This excercise will teach you how about basics","totalPoint":100,"dueDate":987654321,"assignmentPublishDate":987651221,"groupSubmissionAllowed":false,"assignmentDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"correction":null,"solution":null,"SampleSolutionDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}]}],"discussionItems":[{"from":"A courseroom user","byMe":false,"modifiedTimestamp":789456132,"created":789456132,"selfId":8,"replyToId":0,"parentDiscussionId":7,"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}],"emails":[{"from":"ab123456@rwth-aachen.de;","itemId":212,"modifiedTimestamp":123456798,"created":123456798,"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"recipients":"managers;tutors;students;","cc":"administrator@example.rwth-aachen.de","body":"This is a sample email.","subject":"This is the subject of the email","replyTo":"Reply to my address"}],"hyperlinks":[{"itemId":29,"lastModified":1447769942,"created":1447769941,"url":"http://www.example.com","notes":"We can use this url for any kind of url documentation.","description":"This url is the standard url for referencing as defined by standard authority."}],"literature":[{"state":"Digitalization Successful","availability":"not available","itemID":2,"modified":12346579,"created":13456789,"author":"Dr. Gustav Geier","editor":"Dr. Gisela Geier","literatureCategory":"Good stuff","attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}],"learningMaterials":[{"sourceDirectory":"/ss14/14ss-0000/List/Materials/","itemId":29,"name":"readme.txt","parentFolderId":98,"isDirectory":true,"created":123488992,"lastModified":123488992,"selfUrl":"/ss14/14ss-12345/Lists/StructuredMaterials/Test","relatedLectureDates":[42],"byMe":true,"fileInformation":null}],"mediaLibraries":[{"sourceDirectory":"/ss14/14ss-0000/List/MediaLibrary/","thumbnailUrl":"/ss14/14ss-0000/List/MediaLibrary/{folder}/_t/CAPTURE.jpg","name":"CAPTURE.JPG","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"/ss14/14ss-0000/List/MediaLibrary/Test","created":134299422,"lastModified":134299422,"fileInformation":null}],"sharedDocuments":[{"sourceDirectory":"/ss14/14ss-0000/List/SharedDocs/abcd","name":"readme.text","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"Excellence means greatness — the very best (e.g. RWTH)","lastModified":1447769942,"created":1447769941,"byMe":true,"fileInformation":null}],"wikis":[{"itemId":4,"url":"http://example.com/ss14/14ss-00002/Lists/WikiList1/MyWiki%202.aspx","authors":"Excellence means greatness — the very best (e.g. RWTH)","versionIds":[42],"lastModified":123456789,"editor":"Gisela Geier","title":"Codemates group","body":"Codemates group is consists of four people who love to code."}],"Status":true}],"Status":true}

whatsAllNewSinceForSemester

Description

Get new items of all your Courserooms with definable timespan and definable semester.
This method will return the items that were modified in the last pastMinutes minutes in all course rooms of the semester semester. Only positive values of pastMinutes are allowed. Remark: Only the courses of the current Semester will be queried. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
pastMinutesintthe number of minutes in the past.
semesterstringthe identifier for the semester that should be queried (e.g. ws15.

Return Value

Range Description
JSON A status flag and an array of whats new items. If no item exist in whats new module, then an empty dataset will be returned.

Sample Call

Protocol
GET whatsAllNewSinceForSemester?accessToken={accessToken}&pastMinutes={pastMinutes}&semester={semester}
Live

Sample Response

{"dataset":[{"cid":"14ss-00003","announcements":[{"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"modifiedTimestamp":123456798,"created":123456798,"itemId":29,"attachmentDirectory":"/ss14/14ss-0000/Lists/AnnouncementDocuments/","title":"This is a sample announcement.","body":"Here goes the description of the announcement","expireTime":123456789}],"assignments":[{"itemId":29,"title":"Getting started","description":"This excercise will teach you how about basics","totalPoint":100,"dueDate":987654321,"assignmentPublishDate":987651221,"groupSubmissionAllowed":false,"assignmentDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"correction":null,"solution":null,"SampleSolutionDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}]}],"discussionItems":[{"from":"A courseroom user","byMe":false,"modifiedTimestamp":789456132,"created":789456132,"selfId":8,"replyToId":0,"parentDiscussionId":7,"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}],"emails":[{"from":"ab123456@rwth-aachen.de;","itemId":212,"modifiedTimestamp":123456798,"created":123456798,"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"recipients":"managers;tutors;students;","cc":"administrator@example.rwth-aachen.de","body":"This is a sample email.","subject":"This is the subject of the email","replyTo":"Reply to my address"}],"hyperlinks":[{"itemId":29,"lastModified":1447769942,"created":1447769941,"url":"http://www.example.com","notes":"We can use this url for any kind of url documentation.","description":"This url is the standard url for referencing as defined by standard authority."}],"literature":[{"state":"Digitalization Successful","availability":"not available","itemID":2,"modified":12346579,"created":13456789,"author":"Dr. Gustav Geier","editor":"Dr. Gisela Geier","literatureCategory":"Good stuff","attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}],"learningMaterials":[{"sourceDirectory":"/ss14/14ss-0000/List/Materials/","itemId":29,"name":"readme.txt","parentFolderId":98,"isDirectory":true,"created":123488992,"lastModified":123488992,"selfUrl":"/ss14/14ss-12345/Lists/StructuredMaterials/Test","relatedLectureDates":[42],"byMe":true,"fileInformation":null}],"mediaLibraries":[{"sourceDirectory":"/ss14/14ss-0000/List/MediaLibrary/","thumbnailUrl":"/ss14/14ss-0000/List/MediaLibrary/{folder}/_t/CAPTURE.jpg","name":"CAPTURE.JPG","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"/ss14/14ss-0000/List/MediaLibrary/Test","created":134299422,"lastModified":134299422,"fileInformation":null}],"sharedDocuments":[{"sourceDirectory":"/ss14/14ss-0000/List/SharedDocs/abcd","name":"readme.text","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"Excellence means greatness — the very best (e.g. RWTH)","lastModified":1447769942,"created":1447769941,"byMe":true,"fileInformation":null}],"wikis":[{"itemId":4,"url":"http://example.com/ss14/14ss-00002/Lists/WikiList1/MyWiki%202.aspx","authors":"Excellence means greatness — the very best (e.g. RWTH)","versionIds":[42],"lastModified":123456789,"editor":"Gisela Geier","title":"Codemates group","body":"Codemates group is consists of four people who love to code."}],"Status":true}],"Status":true}

whatsNew

Description

Get new items from last 24h.
This method will return the items that were modified in the last 24h. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.

Return Value

Range Description
JSON A status flag and a single whats new item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET whatsNew?accessToken={accessToken}&cid={cid}
Live

Sample Response

{"announcements":[{"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"modifiedTimestamp":123456798,"created":123456798,"itemId":29,"attachmentDirectory":"/ss14/14ss-0000/Lists/AnnouncementDocuments/","title":"This is a sample announcement.","body":"Here goes the description of the announcement","expireTime":123456789}],"assignments":[{"itemId":29,"title":"Getting started","description":"This excercise will teach you how about basics","totalPoint":100,"dueDate":987654321,"assignmentPublishDate":987651221,"groupSubmissionAllowed":false,"assignmentDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"correction":null,"solution":null,"SampleSolutionDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}]}],"discussionItems":[{"from":"A courseroom user","byMe":false,"modifiedTimestamp":789456132,"created":789456132,"selfId":8,"replyToId":0,"parentDiscussionId":7,"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}],"emails":[{"from":"ab123456@rwth-aachen.de;","itemId":212,"modifiedTimestamp":123456798,"created":123456798,"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"recipients":"managers;tutors;students;","cc":"administrator@example.rwth-aachen.de","body":"This is a sample email.","subject":"This is the subject of the email","replyTo":"Reply to my address"}],"hyperlinks":[{"itemId":29,"lastModified":1447769942,"created":1447769941,"url":"http://www.example.com","notes":"We can use this url for any kind of url documentation.","description":"This url is the standard url for referencing as defined by standard authority."}],"literature":[{"state":"Digitalization Successful","availability":"not available","itemID":2,"modified":12346579,"created":13456789,"author":"Dr. Gustav Geier","editor":"Dr. Gisela Geier","literatureCategory":"Good stuff","attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}],"learningMaterials":[{"sourceDirectory":"/ss14/14ss-0000/List/Materials/","itemId":29,"name":"readme.txt","parentFolderId":98,"isDirectory":true,"created":123488992,"lastModified":123488992,"selfUrl":"/ss14/14ss-12345/Lists/StructuredMaterials/Test","relatedLectureDates":[42],"byMe":true,"fileInformation":null}],"mediaLibraries":[{"sourceDirectory":"/ss14/14ss-0000/List/MediaLibrary/","thumbnailUrl":"/ss14/14ss-0000/List/MediaLibrary/{folder}/_t/CAPTURE.jpg","name":"CAPTURE.JPG","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"/ss14/14ss-0000/List/MediaLibrary/Test","created":134299422,"lastModified":134299422,"fileInformation":null}],"sharedDocuments":[{"sourceDirectory":"/ss14/14ss-0000/List/SharedDocs/abcd","name":"readme.text","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"Excellence means greatness — the very best (e.g. RWTH)","lastModified":1447769942,"created":1447769941,"byMe":true,"fileInformation":null}],"wikis":[{"itemId":4,"url":"http://example.com/ss14/14ss-00002/Lists/WikiList1/MyWiki%202.aspx","authors":"Excellence means greatness — the very best (e.g. RWTH)","versionIds":[42],"lastModified":123456789,"editor":"Gisela Geier","title":"Codemates group","body":"Codemates group is consists of four people who love to code."}],"Status":true}

whatsNewSince

Description

Get new items with definable timespan.
This method will return the items that were modified in the last pastMinutes minutes. Only positive values of pastMinutes are allowed. Only authenticated users who are member of the specified courseroom can call this method and returned items will be dependant on authenticated user's permission.

Parameters

NameRangeDescription
accessTokenstringThe OAuth access token.
cidstringDesired courseroom id.
pastMinutesintthe number of minutes in the past.

Return Value

Range Description
JSON A status flag and a single whats new item dataset. If the itemid does not fall within the valid range of existing itemids, then an empty dataset will be returned.

Sample Call

Protocol
GET whatsNewSince?accessToken={accessToken}&cid={cid}&pastMinutes={pastMinutes}
Live

Sample Response

{"announcements":[{"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"modifiedTimestamp":123456798,"created":123456798,"itemId":29,"attachmentDirectory":"/ss14/14ss-0000/Lists/AnnouncementDocuments/","title":"This is a sample announcement.","body":"Here goes the description of the announcement","expireTime":123456789}],"assignments":[{"itemId":29,"title":"Getting started","description":"This excercise will teach you how about basics","totalPoint":100,"dueDate":987654321,"assignmentPublishDate":987651221,"groupSubmissionAllowed":false,"assignmentDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"correction":null,"solution":null,"SampleSolutionDocuments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}]}],"discussionItems":[{"from":"A courseroom user","byMe":false,"modifiedTimestamp":789456132,"created":789456132,"selfId":8,"replyToId":0,"parentDiscussionId":7,"subject":"This is a sample discussion thread.","body":"This is the content body \u003cp\u003eof the thread.\u003c/p\u003e"}],"emails":[{"from":"ab123456@rwth-aachen.de;","itemId":212,"modifiedTimestamp":123456798,"created":123456798,"attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"recipients":"managers;tutors;students;","cc":"administrator@example.rwth-aachen.de","body":"This is a sample email.","subject":"This is the subject of the email","replyTo":"Reply to my address"}],"hyperlinks":[{"itemId":29,"lastModified":1447769942,"created":1447769941,"url":"http://www.example.com","notes":"We can use this url for any kind of url documentation.","description":"This url is the standard url for referencing as defined by standard authority."}],"literature":[{"state":"Digitalization Successful","availability":"not available","itemID":2,"modified":12346579,"created":13456789,"author":"Dr. Gustav Geier","editor":"Dr. Gisela Geier","literatureCategory":"Good stuff","attachments":[{"downloadUrl":"collaboration|/ws13/13ws-00001/Lists/wikiList1/1_.000","itemId":29,"fileSize":"44","modifiedTimestamp":987654321,"fileName":"readme.txt"}],"title":"History of RWTH Aachen University","authors":"Dr. Gustav Geier","year":"2015","url":"https://www.rwth-aachen.de","publisher":"RWTH Aachen Publishing","relevance":"Mandatory","address":"Templergraben","booktitle":"RWTH - The full story","comments":"Nice book","doi":"10.1371/journal.pbio.0020449.g001","edition":"Standard","fromPage":"9","isxn":"987-3-86680-192-9","journalName":"Fancy Journal","number":"5","role":"Primary Literature","series":"Standard","toPage":"IX","type":"Standard-Type","volume":"8","urlComment":"The link for more information","contentType":"Book"}],"learningMaterials":[{"sourceDirectory":"/ss14/14ss-0000/List/Materials/","itemId":29,"name":"readme.txt","parentFolderId":98,"isDirectory":true,"created":123488992,"lastModified":123488992,"selfUrl":"/ss14/14ss-12345/Lists/StructuredMaterials/Test","relatedLectureDates":[42],"byMe":true,"fileInformation":null}],"mediaLibraries":[{"sourceDirectory":"/ss14/14ss-0000/List/MediaLibrary/","thumbnailUrl":"/ss14/14ss-0000/List/MediaLibrary/{folder}/_t/CAPTURE.jpg","name":"CAPTURE.JPG","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"/ss14/14ss-0000/List/MediaLibrary/Test","created":134299422,"lastModified":134299422,"fileInformation":null}],"sharedDocuments":[{"sourceDirectory":"/ss14/14ss-0000/List/SharedDocs/abcd","name":"readme.text","itemId":29,"parentFolderId":98,"isDirectory":true,"selfUrl":"Excellence means greatness — the very best (e.g. RWTH)","lastModified":1447769942,"created":1447769941,"byMe":true,"fileInformation":null}],"wikis":[{"itemId":4,"url":"http://example.com/ss14/14ss-00002/Lists/WikiList1/MyWiki%202.aspx","authors":"Excellence means greatness — the very best (e.g. RWTH)","versionIds":[42],"lastModified":123456789,"editor":"Gisela Geier","title":"Codemates group","body":"Codemates group is consists of four people who love to code."}],"Status":true}
Documentation generated at 2017-09-23 14:52 UTC