RWTHApp Proxy Documentation

AddAccountingLogEduroamLogging

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST EduroamLog/AddAccountingLog?mode={mode}&timestamp={secTimestamp}&token={token}

Live

Sample Response

{"Data":42,"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

AddAuthLogEduroamLogging

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST EduroamLog/AddAuthLog?mode={mode}&timestamp={secTimestamp}&token={token}

Live

Sample Response

{"Data":42,"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

AddChannel

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST eLearning/DAS/Manage/AddChannel?channelName={channelName}&unit={unit}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

AddEvent

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

* Events/Timetable/AddAppointment?appointmentId={appointmentId}&lang={lang}&token={token}

Live

Sample Response

{"Data":[{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

CancelPrebookUBAPI

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Library/CancelPrebookedMedia?mediaId={mediaId}&lang={lang}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetAccountUBAPI

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Library/GetAccount?lang={lang}&clearCache={clearCache}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

RenewLoanedMediaUBAPI

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Library/RenewLoanedMedia?mediaId={mediaId}&lang={lang}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

ChangeIsChecked

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Apps/RWTHApp/Feedback/ChangeIsChecked?id={id}&value={value}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

ChangeMessageTags

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST eLearning/DAS/Teacher/ChangeMessageTags?messageID={messageID}&channelSecret={channelSecret}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

ClearChannel

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST eLearning/DAS/Teacher/ClearChannel?channelSecret={channelSecret}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

CloseHeatMap

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST elearning/DAS/Teacher/CloseHeatMap?channelSecret={channelSecret}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

CloseSurvey

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST elearning/DAS/Teacher/CloseSurvey?channelSecret={channelSecret}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

CreateAccount

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Eduroam/CreateAccount?deviceName={deviceName}&deviceType={deviceType}&token={token}

Live

Sample Response

{"Data":{"loginID":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","realm":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","password":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","deviceName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","deviceType":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

Default

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

* *

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

DeleteAccount

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Eduroam/DeleteAccount?deviceId={deviceId}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

DeleteChannel

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST eLearning/DAS/Teacher/DeleteChannel?channelSecret={channelSecret}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

DeleteEvent

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

* Events/Timetable/DeleteAppointment?appointmentId={appointmentId}&lang={lang}&token={token}

Live

Sample Response

{"Data":[{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

DeletePicture

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST PictureManagement/DeletePicture?systemCode={systemCode}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

Documentation

Description

Generates this documentation.

Parameters

Name	Range	Description

Return Value

Range	Description
text/html	Documentation in HTML format.

Sample Call

Protocol

GET Documentation

Live

Sample Response

null

FindStation

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET PublicTransport/FindStation?query={query}&maxResults={maxResults}&token={token}

Live

Sample Response

{"Data":[{"id":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","latitude":0,"longitude":0},{"id":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","latitude":0,"longitude":0}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetAccountActivity

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Eduroam/GetAccountActivity?deviceId={deviceId}&onlyLast={onlyLast}&token={token}

Live

Sample Response

{"Data":[{"LoginTimestamp":42,"Location":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Ip":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SuccessfulLogin":false,"MultiUsedMac":false,"MacAddress":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","MultiMac":null},{"LoginTimestamp":42,"Location":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Ip":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SuccessfulLogin":false,"MultiUsedMac":false,"MacAddress":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","MultiMac":null}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetAccounts

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Eduroam/GetAccounts?token={token}

Live

Sample Response

{"Data":null,"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetAdminChannels

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/Manage/GetChannels?token={token}

Live

Sample Response

{"Data":[{"id":"00000000-0000-0000-0000-000000000000","channelName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","channelId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdateTimestamp":42,"secret":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openTimestamp":42,"closeDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closeTimestamp":42,"active":false,"unit":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openForStudents":false,"hasPassword":false,"password":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","welcomeMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","state":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ownerGuid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closingMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"id":"00000000-0000-0000-0000-000000000000","channelName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","channelId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdateTimestamp":42,"secret":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openTimestamp":42,"closeDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closeTimestamp":42,"active":false,"unit":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openForStudents":false,"hasPassword":false,"password":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","welcomeMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","state":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ownerGuid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closingMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetAdminMessages

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/Teacher/GetMessages?channelSecret={channelSecret}&stream={stream}&nextIndex={nextIndex}&token={token}

Live

Sample Response

{"Data":[{"channel":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","stream":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","messageID":42,"nextIndex":42,"message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","user":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","formattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestamp":42,"updateId":42,"id":"00000000-0000-0000-0000-000000000000","tags":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"surveyResults":[{"answer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","count":42},{"answer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","count":42}],"heatMapAnswer":null,"possibleAnswers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"photo":null,"photoThumb":null,"scaleFactor":0,"questionTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"channel":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","stream":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","messageID":42,"nextIndex":42,"message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","user":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","formattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestamp":42,"updateId":42,"id":"00000000-0000-0000-0000-000000000000","tags":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"surveyResults":[{"answer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","count":42},{"answer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","count":42}],"heatMapAnswer":null,"possibleAnswers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"photo":null,"photoThumb":null,"scaleFactor":0,"questionTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetAllSystems

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET PictureManagement/GetAllSystems?token={token}

Live

Sample Response

{"Data":[{"SystemCode":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SystemName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Cut":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ResolutionX":42,"ResolutionY":42,"TermsOfUseToast":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","TermsOfUseText":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","AdditionalToast":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","CheckList":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Transaction":null,"Localizations":null},{"SystemCode":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SystemName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Cut":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ResolutionX":42,"ResolutionY":42,"TermsOfUseToast":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","TermsOfUseText":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","AdditionalToast":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","CheckList":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Transaction":null,"Localizations":null}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetAppointments

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/GetEventAppointments?eventId={eventId}&lang={lang}&token={token}

Live

Sample Response

{"Data":[{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetBlockedSites

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Apps/RWTHApp/GetBlockedSites?lang={lang}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetCanteenInfo

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Canteens/GetCanteenInfo?canteenId={canteenId}&lang={lang}&token={token}

Live

Sample Response

{"Data":{"canteenName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","canteenId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","imageUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealCounter":null,"address":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","phoneNumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetCanteenPhoto

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Canteens/GetCanteenPhoto?canteenId={canteenId}&token={token}

Live

Sample Response

null

GetCanteens

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Canteens/GetCanteens?token={token}

Live

Sample Response

{"Data":[{"canteenName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","canteenId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","imageUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealCounter":null,"address":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","phoneNumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"canteenName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","canteenId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","imageUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealCounter":null,"address":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","phoneNumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

getCategorizedLinks

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Portals/GetCategorizedLinks?lang={lang}&token={token}

Live

Sample Response

{"Data":{"categories":[{"links":[{"userHasLegitimation":false,"exactRequirementsUnknown":false,"displayname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","notLegitimatedInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipContent":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipUrlTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","requiredUserStatus":[],"legitimation":[]},{"userHasLegitimation":false,"exactRequirementsUnknown":false,"displayname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","notLegitimatedInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipContent":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipUrlTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","requiredUserStatus":[],"legitimation":[]}],"icon":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","displayname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"links":[{"userHasLegitimation":false,"exactRequirementsUnknown":false,"displayname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","notLegitimatedInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipContent":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipUrlTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","requiredUserStatus":[],"legitimation":[]},{"userHasLegitimation":false,"exactRequirementsUnknown":false,"displayname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","notLegitimatedInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipContent":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","tooltipUrlTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","requiredUserStatus":[],"legitimation":[]}],"icon":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","displayname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"isResultPersonalized":false},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetChannelList

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/GetChannels?token={token}

Live

Sample Response

{"Data":[{"id":"00000000-0000-0000-0000-000000000000","channelName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","channelId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdateTimestamp":42,"secret":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openTimestamp":42,"closeDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closeTimestamp":42,"active":false,"unit":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openForStudents":false,"hasPassword":false,"password":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","welcomeMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","state":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ownerGuid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closingMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"id":"00000000-0000-0000-0000-000000000000","channelName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","channelId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdateTimestamp":42,"secret":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openTimestamp":42,"closeDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closeTimestamp":42,"active":false,"unit":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openForStudents":false,"hasPassword":false,"password":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","welcomeMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","state":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ownerGuid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closingMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetChannelOptions

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/Teacher/GetChannelOptions?channelSecret={channelSecret}&token={token}

Live

Sample Response

{"Data":{"id":"00000000-0000-0000-0000-000000000000","channelName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","channelId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lastUpdateTimestamp":42,"secret":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openTimestamp":42,"closeDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closeTimestamp":42,"active":false,"unit":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","openForStudents":false,"hasPassword":false,"password":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","welcomeMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","state":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ownerGuid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","closingMessage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetCoffeeBarInfo

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Canteens/GetCoffeeBarInfo?coffeeBarId={coffeeBarId}&lang={lang}&token={token}

Live

Sample Response

{"Data":{"CoffeeBarId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","CoffeeBarName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Address":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","OpeningHours":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","PhoneNumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ContactPerson":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ImageUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Offers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."]},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetCoffeeBarPhoto

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Canteens/GetCoffeeBarPhoto?coffeebarId={coffeebarId}&token={token}

Live

Sample Response

null

GetCoffeeBars

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Canteens/GetCoffeeBars?lang={lang}&token={token}

Live

Sample Response

{"Data":[{"CoffeeBarId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","CoffeeBarName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Address":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","OpeningHours":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","PhoneNumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ContactPerson":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ImageUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Offers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."]},{"CoffeeBarId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","CoffeeBarName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Address":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","OpeningHours":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","PhoneNumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ContactPerson":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ImageUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Offers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."]}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetCourseById

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/GetEvent?eventId={eventId}&token={token}

Live

Sample Response

{"Data":{"title":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lvnr":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","term":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","sws":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ects":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","note":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","language":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","literature":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lecturers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"L2P":false,"homepage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","RedirectLink":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetEmployeeById

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Employees/GetEmployee?employeeId={employeeId}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetRoomById

Description

Parameters

Name	Range	Description
id		Room-ID in the format {building-number}\|{room-number}

Return Value

Range	Description

Sample Call

Protocol

GET Rooms/GetRoom?roomId={roomId}&token={token}

Live

Sample Response

{"Data":{"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","gguid":null,"lecturerroom":false,"id":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomgroup":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomtype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","boards":42,"seats":42,"expanse":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","plan":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","notes":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","buildingname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","buildingnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","floor":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","address":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","seatstype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","boardstype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lectern":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","shading":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","videoanalog":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","projector":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","overheadcount":42,"slideprojectcount":42,"slideprojector":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","filmprojector":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","microphone":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","link":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomcontact":[{"contactname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactemail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactphone":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"contactname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactemail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactphone":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}]},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

MoodleGetMyEnrolledCourseById

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/Moodle/GetMyEnrolledCourseById?courseid={courseid}&token={token}

Live

Sample Response

{"Data":{"id":null,"shortName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":{"name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","id":42,"idnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"courseTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","startDate":null,"endDate":null,"timeModified":null,"lvnr":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

MoodleGetMyRolesById

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/Moodle/GetMyRolesById?courseid={courseid}&token={token}

Live

Sample Response

{"Data":{"roles":[{"roleid":42,"name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","shortname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","sortorder":42},{"roleid":42,"name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","shortname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","sortorder":42}]},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetCoursesCampus

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/FindEvents?query={query}&token={token}

Live

Sample Response

{"Data":[{"title":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lvnr":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","term":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","sws":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ects":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","note":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","language":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","literature":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lecturers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"L2P":false,"homepage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","RedirectLink":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"title":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lvnr":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","term":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","sws":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ects":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","note":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","language":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","literature":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lecturers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"L2P":false,"homepage":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","RedirectLink":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetDASExport

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/Teacher/GetExport/{*filename}?channelSecret={channelSecret}&type={type}&token={token}

Live

Sample Response

null

GetDASPicture

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/GetPicture/{pictureId}.jpg?token={token}

Live

Sample Response

null

GetDASThumb

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/GetThumb/{pictureId}.jpg?token={token}

Live

Sample Response

null

GetDASUserInfo

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/Manage/GetUserInfo?token={token}

Live

Sample Response

{"Data":{"units":[{"name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}]},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetDashboardInformation

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/Teacher/GetDashboardInformation?channelId={channelId}&channelSecret={channelSecret}&token={token}

Live

Sample Response

{"Data":{"openChats":42,"inProgressChats":42,"onlineAgents":42,"closedChats":42},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetDepartures

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET PublicTransport/GetDepartures?stationId={stationId}&time={time}&maxResults={maxResults}&token={token}

Live

Sample Response

{"Data":{"stationName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","departures":[{"direction":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","transportationLine":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","track":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","departureTimePlanned":42,"departureTimeRealtime":null},{"direction":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","transportationLine":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","track":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","departureTimePlanned":42,"departureTimeRealtime":null}]},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetDisplayConfiguration

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET App/Didi/GetConfiguration?name={name}&instance={instance}&token={token}

Live

Sample Response

null

GetEduroamUserInfo

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Eduroam/GetEduroamUserInfo?token={token}

Live

Sample Response

{"Data":{"Realm":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","HasDevices":false,"HasEntitlementWLAN":false},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetSupportFormUserInfo

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Apps/SupportForm/GetUserInfo?token={token}

Live

Sample Response

{"Data":{"IsAdmin":false,"UserInfo":{"DisplayName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","FirstName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","LastName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","EMail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Affiliation":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Faculty":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Id":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Details":null}},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetUserInfo

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET User/GetInfo?token={token}

Live

Sample Response

{"Data":{"DisplayName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","FirstName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","LastName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","EMail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Affiliation":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Faculty":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Id":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Details":null},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetEmployees

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Employees/FindEmployees?query={query}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetEvaluationList

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/Evaluation/GetList?token={token}

Live

Sample Response

{"Data":[{"STP_SP_NR":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SJ_NAME":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SEMESTER_KB":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_LV_ART_KURZ":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_SP_LVNR":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_LV_NR":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_SP_TITEL":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_SP_TITEL_ENGL":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","GRP_NR":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Evals":[{"SurveyId":42,"Name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ParticipantsCount":42,"Semester":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Lecturer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isOpen":false},{"SurveyId":42,"Name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ParticipantsCount":42,"Semester":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Lecturer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isOpen":false}]},{"STP_SP_NR":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SJ_NAME":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SEMESTER_KB":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_LV_ART_KURZ":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_SP_LVNR":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_LV_NR":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_SP_TITEL":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","STP_SP_TITEL_ENGL":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","GRP_NR":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Evals":[{"SurveyId":42,"Name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ParticipantsCount":42,"Semester":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Lecturer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isOpen":false},{"SurveyId":42,"Name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ParticipantsCount":42,"Semester":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Lecturer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isOpen":false}]}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetEvaluationPdf

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/Evaluation/Get/{id}.pdf?token={token}

Live

Sample Response

null

GetEventAppointment

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/Timetable/GetAppointment?appointmentId={appointmentId}&lang={lang}&token={token}

Live

Sample Response

{"Data":{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetFeedback

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Apps/RWTHApp/Feedback/GetAllFeedback?startdate={startdate}&enddate={enddate}&state={state}&filtertext={filtertext}&token={token}

Live

Sample Response

{"Data":[{"IsError":false,"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Code":null,"Stack":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ApiStatusCode":null,"ApiStatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","AppVersion":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","TestSystem":null,"UserLoggedIn":null,"UserLoginPersonalized":null,"Language":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","MenuPinned":null,"VibrationEnabled":null,"EMail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","WavesEffectEnabled":null,"ActiveFeeds":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","LoadingAnimationEnabled":null,"LocationPermission":null,"DeviceModel":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","DevicePlatform":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","DevicePlatformVersion":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ConnectionType":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","UserAgent":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ScreenOrientationIsLandscape":null,"windowWidth":null,"windowHeight":null,"IsChecked":null,"Id":42,"History":[{"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Loglevel":42,"Error":{"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Code":null,"Stack":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ApiStatusCode":null,"ApiStatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","FormattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"FormattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Loglevel":42,"Error":{"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Code":null,"Stack":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ApiStatusCode":null,"ApiStatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","FormattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"FormattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}]},{"IsError":false,"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Code":null,"Stack":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ApiStatusCode":null,"ApiStatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","AppVersion":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","TestSystem":null,"UserLoggedIn":null,"UserLoginPersonalized":null,"Language":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","MenuPinned":null,"VibrationEnabled":null,"EMail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","WavesEffectEnabled":null,"ActiveFeeds":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","LoadingAnimationEnabled":null,"LocationPermission":null,"DeviceModel":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","DevicePlatform":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","DevicePlatformVersion":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ConnectionType":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","UserAgent":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ScreenOrientationIsLandscape":null,"windowWidth":null,"windowHeight":null,"IsChecked":null,"Id":42,"History":[{"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Loglevel":42,"Error":{"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Code":null,"Stack":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ApiStatusCode":null,"ApiStatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","FormattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"FormattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Loglevel":42,"Error":{"Message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Timestamp":null,"Code":null,"Stack":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ApiStatusCode":null,"ApiStatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","FormattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"FormattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}]}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetHSZOffers

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Apps/RWTHApp/GetHSZOffers?lang={lang}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetImagesFromFolder

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET App/Didi/GetImagesFromFolder?instance={instance}&imageFolder={imageFolder}&token={token}

Live

Sample Response

{"Data":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetMapTile

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Geo/Map/GetTile/{z}/{x}/{y}.png?token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetMessages

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/DAS/GetMessages?channelId={channelId}&userSecret={userSecret}&nextIndex={nextIndex}&password={password}&token={token}

Live

Sample Response

{"Data":[{"channel":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","stream":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","messageID":42,"nextIndex":42,"message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","user":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","formattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestamp":42,"updateId":42,"id":"00000000-0000-0000-0000-000000000000","tags":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"surveyResults":[{"answer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","count":42},{"answer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","count":42}],"heatMapAnswer":null,"possibleAnswers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"photo":null,"photoThumb":null,"scaleFactor":0,"questionTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"channel":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","stream":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","messageID":42,"nextIndex":42,"message":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","user":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","formattedDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestamp":42,"updateId":42,"id":"00000000-0000-0000-0000-000000000000","tags":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"surveyResults":[{"answer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","count":42},{"answer":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","count":42}],"heatMapAnswer":null,"possibleAnswers":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"photo":null,"photoThumb":null,"scaleFactor":0,"questionTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetPersonalizedAppointment

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/Timetable/GetEventAppointment?appointmentId={appointmentId}&lang={lang}&token={token}

Live

Sample Response

{"Data":{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetPersonalizedAppointments

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/Timetable/GetEventAppointments?eventId={eventId}&lang={lang}&token={token}

Live

Sample Response

{"Data":[{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetPicture

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET PictureManagement/GetPicture/{token}.jpg

Live

Sample Response

null

GetPicturesForUser

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET PictureManagement/GetPicturesForUser?token={token}

Live

Sample Response

{"Data":[{"IsActive":false,"System":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Hash":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"IsActive":false,"System":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Hash":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetRadiusAuthorizations

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Eduroam/Radius/GetRadiusAuthorizations?value={value}&noFence={noFence}&token={token}

Live

Sample Response

{"Data":[{"UserId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Tim":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Realm":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Organization":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","WLANMac":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Radius":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","AuthorizationDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Success":false,"Status":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","VPN":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Client":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SSID":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"UserId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Tim":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Realm":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Organization":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","WLANMac":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Radius":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","AuthorizationDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Success":false,"Status":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","VPN":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Client":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","SSID":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetRoomAppointments

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET App/Didi/GetRoomAppointments?roomnumber={roomnumber}&token={token}

Live

Sample Response

{"Data":[{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","appointment":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","keyword":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","booked":false,"start":"\/Date(-62135596800000)\/","end":"\/Date(-62135596800000)\/","timestamp":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestampstart":42,"timestampend":42,"formattedPeriod":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"isAddAppointmentEnabled":false,"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetRooms

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Rooms/FindRooms?query={query}&token={token}

Live

Sample Response

{"Data":[{"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","gguid":null,"lecturerroom":false,"id":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomgroup":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomtype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","boards":42,"seats":42,"expanse":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","plan":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","notes":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","buildingname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","buildingnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","floor":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","address":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","seatstype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","boardstype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lectern":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","shading":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","videoanalog":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","projector":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","overheadcount":42,"slideprojectcount":42,"slideprojector":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","filmprojector":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","microphone":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","link":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomcontact":[{"contactname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactemail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactphone":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"contactname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactemail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactphone":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}]},{"description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","gguid":null,"lecturerroom":false,"id":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomgroup":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomtype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","boards":42,"seats":42,"expanse":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","plan":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","notes":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","buildingname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","buildingnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","floor":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","address":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","seatstype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","boardstype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","lectern":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","shading":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","videoanalog":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","projector":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","overheadcount":42,"slideprojectcount":42,"slideprojector":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","filmprojector":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","microphone":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","link":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","roomcontact":[{"contactname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactemail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactphone":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"contactname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactemail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","contactphone":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}]}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetSemester

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Apps/RWTHApp/GetSemester?numSemesterBack={numSemesterBack}&token={token}

Live

Sample Response

{"Data":["For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","For a moment, nothing happened. Then, after a second or so, nothing continued to happen."],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetServerMenu

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Apps/RWTHApp/GetMenu?lang={lang}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetStudentReport

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Exams/GetReport?lang={lang}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetStudyRooms

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Rooms/GetStudyRooms?lat={lat}&lng={lng}&lang={lang}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetStudyRoomUserCountFromPast

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Rooms/StudyroomUsagePrediction/GetPastUsage?roomId={roomId}&buildingnumber={buildingnumber}&roomname={roomname}&daysAgo={daysAgo}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetStudyRoomUserCountPrediction

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Rooms/StudyroomUsagePrediction/GetPrediction?roomId={roomId}&buildingnumber={buildingnumber}&roomname={roomname}&daysAhead={daysAhead}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetTimetableWeeks

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/Timetable/GetWeeks?weekOffset={weekOffset}&count={count}&token={token}

Live

Sample Response

{"Data":[{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","title":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","location":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","time":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","date":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isEmpty":false,"startTimestamp":42,"endTimestamp":42,"appointmentId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","title":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","location":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","time":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","date":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isEmpty":false,"startTimestamp":42,"endTimestamp":42,"appointmentId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetUserDetails

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET User/GetDetails?token={token}&courseId={courseId}

Live

Sample Response

{"Data":{"DisplayName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","FirstName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","LastName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","EMail":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Affiliation":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Faculty":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Id":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","Details":null},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetWeekMenu

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Canteens/GetWeekMenu?canteenId={canteenId}&lang={lang}&token={token}

Live

Sample Response

{"Data":{"canteenName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","dayMenues":[{"displayDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestamp":42,"weekDay":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","supplements":[{"menu":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","price":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealTypes":null,"nutritionInfo":{"calorificValue":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fat":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","carbohydrates":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","protein":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}},{"menu":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","price":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealTypes":null,"nutritionInfo":{"calorificValue":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fat":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","carbohydrates":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","protein":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}}],"menues":[{"menu":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","price":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealTypes":null,"nutritionInfo":{"calorificValue":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fat":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","carbohydrates":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","protein":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}},{"menu":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","price":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealTypes":null,"nutritionInfo":{"calorificValue":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fat":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","carbohydrates":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","protein":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}}],"isToday":false,"ingredients":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"displayDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","timestamp":42,"weekDay":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","supplements":[{"menu":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","price":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealTypes":null,"nutritionInfo":{"calorificValue":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fat":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","carbohydrates":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","protein":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}},{"menu":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","price":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealTypes":null,"nutritionInfo":{"calorificValue":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fat":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","carbohydrates":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","protein":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}}],"menues":[{"menu":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","price":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealTypes":null,"nutritionInfo":{"calorificValue":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fat":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","carbohydrates":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","protein":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}},{"menu":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","price":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","mealTypes":null,"nutritionInfo":{"calorificValue":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fat":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","carbohydrates":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","protein":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}}],"isToday":false,"ingredients":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}]},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetWeekTimetable

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/Timetable/GetWeek?weekOffset={weekOffset}&token={token}

Live

Sample Response

{"Data":[{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","title":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","location":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","time":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","date":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isEmpty":false,"startTimestamp":42,"endTimestamp":42,"appointmentId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"gguid":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","title":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","location":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","time":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","date":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isEmpty":false,"startTimestamp":42,"endTimestamp":42,"appointmentId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","isPrivate":false,"type":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","eventId":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GetWhatsNew

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET PictureManagement/GetChanged?timespan={timespan}&token={token}

Live

Sample Response

{"Data":[{"Created":42,"BlueCardBildUploadIDHash":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"Created":42,"BlueCardBildUploadIDHash":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GoToEmployeeHomepageUrl

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Employees/GoToHomepageUrl/{gguid}?lang={lang}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GoToEventHomepageUrl

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Events/GoToHomepageUrl/{gguid}?lang={lang}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

GoToInformationUrl

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Apps/RWTHApp/GoToUrl/{linkId}?lang={lang}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

MoodleDownloadFile

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/Moodle/DownloadFile/{*filename}?downloadurl={downloadurl}&token={token}

Live

Sample Response

null

MoodleGetCategories

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/Moodle/GetCategories?token={token}

Live

Sample Response

{"Data":[{"name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","id":42,"idnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","id":42,"idnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

MoodleGetFiles

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/Moodle/GetFiles?courseid={courseid}&topicname={topicname}&token={token}

Live

Sample Response

{"Data":[{"filename":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","modulename":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","topicname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","sourceDirectory":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","created":null,"lastModified":null,"selfUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","downloadUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fileinformation":{"mimetype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","filesize":42}},{"filename":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","modulename":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","topicname":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","sourceDirectory":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","created":null,"lastModified":null,"selfUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","downloadUrl":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","fileinformation":{"mimetype":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","filesize":42}}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

MoodleGetMyEnrolledCourses

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET eLearning/Moodle/GetMyEnrolledCourses?semester={semester}&semesterOffset={semesterOffset}&token={token}

Live

Sample Response

{"Data":[{"id":null,"shortName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":{"name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","id":42,"idnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"courseTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","startDate":null,"endDate":null,"timeModified":null,"lvnr":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},{"id":null,"shortName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","category":{"name":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","id":42,"idnumber":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"courseTitle":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","description":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","url":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","startDate":null,"endDate":null,"timeModified":null,"lvnr":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."}],"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

OpenHeatMap

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST eLearning/DAS/Teacher/OpenHeatMap?channelSecret={channelSecret}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

OpenSurvey

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST eLearning/DAS/Teacher/OpenSurvey?channelSecret={channelSecret}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

Options

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

OPTIONS *

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

ProvideStudyRoomUsageFeedback

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Rooms/StudyroomUsagePrediction/ProvideFeedback?roomId={roomId}&buildingnumber={buildingnumber}&roomname={roomname}&feedback={feedback}&numOccupiedPlaces={numOccupiedPlaces}&token={token}

Live

Sample Response

{"Data":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

ResetDevicePassword

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Eduroam/ResetDevicePassword?deviceId={deviceId}&realm={realm}&token={token}

Live

Sample Response

{"Data":{"loginID":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","realm":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","password":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","deviceName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","deviceType":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

SendAdminMessage

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST eLearning/DAS/Teacher/SendMessage?channelSecret={channelSecret}&type={type}&stream={stream}&angle={angle}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

SendFeedback

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Apps/RWTHApp/SendFeedback?message={message}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

SendFeedbackAnswer

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Apps/RWTHApp/Feedback/SendFeedbackAnswer?to={to}&subject={subject}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

SendMessage

Description

Parameters

Name	Range	Description
angle	0 - 359	Only used for type 'picture', provides a rotation angle for the image that is applied before storing the image.
message	string	Message data, if type is set to 'picture', a Base64 encoded string with the image data is expected.
type	['text', 'picture', 'questionAnswer']	Indicates which kind of message is included in the request body, the default is 'text'.
userId	string	User identification.

Return Value

Range	Description
	Possible error codes: 32: UserId needs to be set. 41: Channel closed. 33: Wrong password. 35: Message must not be empty. 36: Invalid answer. - If type is 'questionAnswer' and the answer string is not valid. 39: No active survey. 40: Already voted.

Sample Call

Protocol

POST eLearning/DAS/SendMessage?channelId={channelId}&type={type}&userSecret={userSecret}&password={password}&angle={angle}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

SetChannelOptions

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST eLearning/DAS/Teacher/SetChannelOptions?channelSecret={channelSecret}&active={active}&state={state}&startTimestamp={startTimestamp}&endTimestamp={endTimestamp}&password={password}&welcomeMessage={welcomeMessage}&closingMessage={closingMessage}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

SetPermission

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST PictureManagement/SetPermission?systemCode={systemCode}&vakue={value}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

UpdateDeviceNick

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST Eduroam/UpdateDeviceNick?deviceId={deviceId}&nick={nick}&token={token}

Live

Sample Response

{"Data":{"loginID":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","realm":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","password":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","deviceName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","deviceType":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

UploadPicture

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

POST PictureManagement/UploadPicture?systemCode={systemCode}&token={token}

Live

Sample Response

{"Data":{},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

Version

Description

Parameters

Name	Range	Description

Return Value

Range	Description

Sample Call

Protocol

GET Version

Live

Sample Response

{"Data":{"AppVersion":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","AppDepricatedVersion":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","AppNotSupportedVersion":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ApiVersion":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","ApiCompatLevel":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","BuildDate":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","BuildVersion":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","BuildName":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen."},"StatusCode":42,"StatusInfo":"For a moment, nothing happened. Then, after a second or so, nothing continued to happen.","IsError":false}

Documentation generated at 2025-05-23 11:30 UTC

APIv2

AddAccountingLogEduroamLogging

Description

Parameters

Return Value

Sample Call

Sample Response

AddAuthLogEduroamLogging

Description

Parameters

Return Value

Sample Call

Sample Response

AddChannel

Description

Parameters

Return Value

Sample Call

Sample Response

AddEvent

Description

Parameters

Return Value

Sample Call

Sample Response

CancelPrebookUBAPI

Description

Parameters

Return Value

Sample Call

Sample Response

GetAccountUBAPI

Description

Parameters

Return Value

Sample Call

Sample Response

RenewLoanedMediaUBAPI

Description

Parameters

Return Value

Sample Call

Sample Response

ChangeIsChecked

Description

Parameters

Return Value

Sample Call

Sample Response

ChangeMessageTags

Description

Parameters

Return Value

Sample Call

Sample Response

ClearChannel

Description

Parameters

Return Value

Sample Call

Sample Response

CloseHeatMap

Description

Parameters

Return Value

Sample Call

Sample Response

CloseSurvey

Description

Parameters

Return Value

Sample Call

Sample Response

CreateAccount

Description

Parameters

Return Value

Sample Call

Sample Response

Default