If for example a user has not entered an adress, the api returns null while it returns a string if an adress has been entered.

This should be consistent and thus the api should return an empty string.

The administration is written as a Stud.IP plugin.

Root administrators grant, edit or revoke access permissions to specific client applications. This is the only place, client keys and secret are publicly visible.

It is supposed to offer the following functions:

• Create a new client
• Update a client
• Remove a client
• Block/deactivate a client and unblock/activate it again
• List all available clients in a reasonable manner

Sometimes the server responds to an request with an 500 error. After this response the server seems to stop working. For about 1 Minute no other request is answered positive, this means 500 error.

No client, no testing...

We should check whether the file is reachable on the external server, if not don't display!

Performance???

Under certain circumstances, the server doesn't seem to issue a request token.

Investigate and fix.

The more routes the api support, the more confusing the administration page for access settings gets.

The routes should be grouped by the url and should be foldable.

Consideration: Disable /news without disabling all /news/* routes.

It should be possible to get all upcoming events. An alternative approauch is to deliver the ics-file from the server.

Maybe it's useful to provide a route to return the members of a course separately.

If we request an activity we get:
"link": "/trunk/folder.php?cid=834499e2b8a2cd71637890e5de31cba3&cmd=tree&open=011695a6ba0ad4a272d919fe4595009b#anker"

The documentation states that a full / complete url will be returned:
"link": "http://studip.example.org/about.php?username=root%40studip&nopen=7516d73adb81ca271c88986bafd14fd7#anker"

Can you modify the API that i get the full url so i do not have to compose the url by myself?

Ob the developer board and also on the stud.ip of the university oldenburg i have seen the skype field in the user profile. It would be nice to provide the username n the profile. In this way the app can allow the current user to call the skype user directly if skype is installed.

It should be possible to get the colorscheme of an installation. Currently an prototype is developed which can be configured with two base colors (standard:light and darkblue) and one backgroundcolor (standard:gray). This route can help to easily adapt the app to different installations of stud.ip. And also the known color scheme gives the user an warm feeling because he feels at home ;)....

If a consumer request a resource like news it would be nice to define the date from which he would like to get the entries. Idea: Reducing the data traffic by using a paramater.

Put a list of comments to every news object that is returned. Compare /courses where a list of teachers, is returned. This is useful to link every comment object to a news in a local database.

First i request all folders for course 834499e2b8a2cd71637890e5de31cba3 with

GET /trunk/plugins.php/restipplugin/api/documents/834499e2b8a2cd71637890e5de31cba3/folder HTTP/1.1

Return is:

{
"folders":[
...
{
"folder_id":"aa15759a75c167e38425d17539e7a7be",
...
},
...
],
"documents":[

]
}

Next step is to request all files like for folder with ID aa15759a75c167e38425d17539e7a7be with

GET /trunk/plugins.php/restipplugin/api/documents/834499e2b8a2cd71637890e5de31cba3/folder/aa15759a75c167e38425d17539e7a7be HTTP/1.1

Response is:

404: No folder aa15759a75c167e38425d17539e7a7be for range 834499e2b8a2cd71637890e5de31cba3

This is strange.

Another thing is that the request

GET /trunk/plugins.php/restipplugin/api/documents/834499e2b8a2cd71637890e5de31cba3/folder HTTP/1.1

sometimes returns an 500 error from beginning.

Feature request. The UI and business logic inside the app exists i only need an end point in the api. Idea is to upload images, videos oder other kind of documents.

Would be nice to get the count of unread / new messages, without fetching all news

While Posting a new message allow the user to send the message as an email and not as an internal message. I found the switch "Nachricht als E-Mail versenden" and want to use a same mechanism.

We need a new route to search for users.

IMHO this should be 2 plugins as that would be easier to teach to other developers. Furthermore it's easier to build a mental model of what belongs to what.

I already created a Consumer-only plugin: https://github.com/luniki/studip-plugin-oauth-consumer-example

What do you think?

Add value for API-Version (usefull for debugging) eg. If a user has problems and send an email to the app-support it would be nice to know which version of the api the selected facility of the user is using.

At the moment, there is no easy way to view an example json response without the neccessity to scroll.

This should be fixed by providing a link to either download the example json, view it in another tab, view it in a lightbox or to expand the element containing the example. Which one it will be, is yet to be decided...

The API could provide an RSS view for custom routes as well.

This comes with some implications.

• Generic rss template vs routing modifications

If i got an activity like "Foo has uploaded a file XYZ to Course Bar" it would be nice to get the important informations from the activate without parsing the text. I could image a parameter "action" with a scheme. Facebook does the same:

fb://profile – Open Facebook app to the user’s profile

fb://friends – Open Facebook app to the friends list
fb://notifications – Open Facebook app to the notifications lis
fb://feed – Open Facebook app to the News Feed
fb://events – Open Facebook app to the Events page
fb://requests – Open Facebook app to the Requests list
fb://notes – Open Facebook app to the Notes page
fb://albums – Open Facebook app to Photo Albums lis

Maybe we can find something similar.

Explore whether there is any way to integrate reading confirmations into the api.

1. The route for documents is not optimal. If i request all the folders or documents the return always contains also the other array. Example: I request folders i get the following return:

{
"folders": [
.....
],
"documents": []
}

So there is also an empty document array. This is not needed in my opinion.

1. If i request all the folders i have no list of documents, i have to make another call to the server, request the documents and than store this association between the returned documents and the folder. In a normal usecase i would expect that i some request an folder he also wants to know all the containing files. So maybe it would be useful if an "folder"-object also contains a list of document_ids like a course contains an array of participants.
2. /api/documents/:range_id/folder/<:folder_id> is complicated. I would change it like: /api/documents/folder/:range_id/
   If range_id is a course_id the server could return a folder object array, else if it is an folder_id a single folder object.
3. Does the server increment the download count of a file if i download it via API?
4. While testing i received a folder list containing folders with names like "Invisible Folder", "Only readable Folder", ... I would assume that invisible folders should also not be visible inside the app. Do i have to parse the names or is there another way to indicate something like invisible or only readable, maybe a bool value?

Sinnvollerweise sollte /api/discovery lieber /api heißen.

It would bei nice to get the upcoming events of a course. It would be also possible if the route returns an ics-calendar-file.

The current examples are sometimes rather impratical.

Idea: Reduce the number of request. When im requesting the groups i always also request the members.

Add paramaters for geolocation to every object that has an location like courses, events, address of user.

It should be possible to get localized names for route /api/messages/:box, e.g. "Message Inbox" vs. "Posteingang". This is localized in Stud.IP (other than course names) and should also be localizable in Apps.

Bei der Installation muss das Plugin für nobody zugänglich sein.

We need a new route for contacts.

• /contacts - GET - Get all contact groups (ungrouped entries?)
• /contacts/:group - GET - Get members of specified group
• /contacts/:group/:user_id - PUT - Move a contact into a group
• /contacts/:group/:user_id - DELETE - Remove a contact from a group

Um das Leben zu vereinfachen, sollten bei Plugininstallation direkt lauffähige Beispiele vorhanden sein.

This plugin or another?

http://code.google.com/p/php-apns/

With a few modifications, Rest.IP could provide default Stud.IP authorization as well, useful for ajax requests amonst other things.

Basically, it's only neccessary to provide a fallback for OAuth::verify().

Example in Route /api/courses Paramater "duration-time" is unclear.

This issue is for all problems with the documentation:

/api/courses/:course_id/members/:status <- what does ":status" mean

This is unclear, but from the example code is assume it should be "teachers", "tutors" or "students".

As much as I like Slim, it doesn't really fit the needs for this plugin.

I would like to build the route handlers in a way that you'd simply return the values you want to render (thus losing the neccessity to inject the $router function into the handler). This is not possible in Slim (afaik).

The API should limit the number of returned entries where appropriate.

For now:

• news
• comments
• messages
• participants

Maybe it's useful to provide a route to return the members of a course separately.

In Stud.IP it is possible to assign a color to a course (http://develop.studip.de/studip/gruppe.php). It would be nice to get this color, to tint the course icon and do grouping.

If a user wrote a mail to himself, the mail will be returned twice. Uncommon scenario but should be fixed anyways.

We need a new route to comment on a news.

This implies separating the comments into a whole new route (GET, POST, DELETE).