Skip to content

Latest commit

 

History

History
164 lines (147 loc) · 3.11 KB

protocol.md

File metadata and controls

164 lines (147 loc) · 3.11 KB
Raw

Loginrequest

/login [POST]

Parameter:

{
    username: (mail)
    password: (password)
}

Response: 200/401

{
    tocken: "token valid for 30 days",
    expiration: "UNIX timestamp in seconds",
    firstname: "The first name",
    surname: "The family name",
    uid: "the user id in the database used to make requests",
    type: "1 SEKI, 2 SekII, 3 teacher, 4 admin",
}

The token will be saved as a cookie (called token) and will be send with every further request

Userinfo

/user/<userid> [GET]
/profile

Parameter [login required]

None

Response 200/403/403

{
    firsname: "The first name",
    surname: "The family name",
    uid: "the user id in the database used to make requests",
    type: "1 SEKI, 2 SekII, 3 teacher, 4 admin",
}

This request returns general userinfo used by the webiterface

Teacher get courses

/teacher/<teacherid>/courses [GET]

Parameter [login required]

None

Response 200/403/404

{
    courses: [{
        subject: "the kind of the course (math, physics etc.)",
        cid: "the id",
        generation: "SEKI/SEKII"
    }{
        ...
    }]
}

This will be fetched when the teacher is logging in and the client shows all courses the teacher teaches. classes he teaches like ma-4 etc.

get Students of course

/courses/<courseid>/students [GET]

Parameter [login_required]

None

Repsonse 200/403/404

{
    subject: "...",
    cid: "...",
    generation: "",
    students: [{
        firsname: "The first name",
        surname: "The family name",
        uid: "the id of the student"
    },{
        ...
    }]
}

This is used to render the colums of the table with the grades

Get marks for teacher

/courses/<cid>/marks

Parameters [login_required] (teacher)

<cid>

Response 200/401

{
    meta: {
        "<markmetaid>": {
            name: "<row label>"
            valance: "e.g. 0.25 for relative or 2 times for fixed"
        },...
    },
    students: {
        "<uid>":[
            {
                metaid: "<id>",
                points: "0-15",
            },...
        ]...
    }
}

Get marks for student

/student/marks

Paramteters [login required] (student)

None

Response 200/401

{
    meta: {
        "<markmetaid>": {
            name: "<row label>"
            valance: "e.g. 0.25 for relative or 2 times for fixed"
        },...
    },
    courses: {
        "<courseid>":[
            {
                metaid: "<id>",
                points: "0-15",
            },...
        ]...
    }
}

get set put mark

/mark/<courseid>/<markmetaid>/<studentid> [GET/PUT/POST/DELETE]

Parameters [login_required] (Teacher)

points (PUT/POST) or none (GET/DELETE)

Response 200/401

{
  points: 0-15
}

Error message

{
    error: 401/404,
    msg: "Humanreadable Message",
}

Authentification

Using authetification headers (like oauth) Authorization get set to <userid>:<token> Example:

Accept: application/json
Authorization: 1:K3nnpiMFi8nEHnk0VK1RNR94a2PmOYC0
Origin: http://localhost:8080
Referer: http://localhost:8080/
...