Description of returned values in documentation

[honkmaster]

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

[tleilax]

Oh, this is really not helpful. I will update that as soon as possible.

For the time being: duration-time is the duration time of the course in seconds, so start-time + duration-time is when the course is over. Duration time = 0 means open end and the course takes place over more than one semester.

[honkmaster]

Today i got the return "-1". What is the meaning for that?

[honkmaster]

Also: documents_folder_permissions? My Idee: User can upload files, User can create folders, User can download files => unclear.

[tleilax]

Wait a second. I think I mixed it up before.

I've got to check on this one before I can answer this. Will do this first thing tomorrow morning.

[tleilax]

Well, the modules section is a bit different. They represent which content modules are activated for that particular course.

documents_folder_permissions suggests that the document folders for that course can have special permissions. Usually you can't set specific rights for certain folders - with this module activated you can. I guess this is a level of detail we don't really need at the moment, so we can neglect this setting for now.

Still, I will document the examples soon.

[honkmaster]

In general i think the modules section is useful. If eg. participants-view is disabled in Stud.IP it should also be disabled in the app. This is the way i am using it right now.

[tleilax]

I only meant the particular "documents_folder_permissions".

[honkmaster]

I see. Do whatever you want. It`s a beta;).

[tleilax]

To come back to the duration_time value:

-1 means "open end"
0 means "ending this semester"
otherwise it's the duration in seconds so that start_time + duration_time = end_time for this course.

If it helps, I could offer a new value "end_semester" and do all the according math in the api.

[honkmaster]

/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".

[tleilax]

:status is a general stud.ip status and can be either one of

user - Standard user, usually no special rights
autor - User with the right to create content, usually a member in a course
tutor - User with tutor rights
dozent - Teacher
admin
root

[honkmaster]

Please document all available action that can be returned with activities and news.

[honkmaster]

Sizes of avatars would be nice.

[tleilax]

Wrong issue...