Skip to content

Course Service API

Haeri edited this page Nov 13, 2019 · 9 revisions

All Requests

/api/courses/
/api/courses/{courseId}
/api/courses/{courseId}/assignments/{assignmentId}
/api/exercises/{exerciseId}
/api/exercises/{exerciseId}/files/{fileId}


Course

REQUEST

/api/courses/
/api/courses/{courseId}

RESPONSE

{
    "id": "31ee2054-cbbe-41bc-b5bf-98140cb46cb9",
    "title": "Informatics 2",
    "description": "Algodat + Modelling",
    "owner": "[email protected]",
    "startDate": "2019-09-22T00:00:00.000+0000",
    "endDate": "2020-01-01T00:00:00.000+0000",
    "assignments": [
        {
            "id": "c33cd07e-fe7d-4a5b-bc54-981bcb2a7055",
            "title": "assignment1",
            "description": "string manipulation lab",
            "publishDate": "2001-12-15T00:00:00.000+0000",
            "dueDate": "2001-05-11T00:00:00.000+0000",
            "exercises": [
                {
                    "id": "a4097b1f-b476-4c63-9911-8efacc61f4ea",
                    "type": "code",
                    "language": "python"
                }
            ]
        }
    ]
}

Assignment

REQUEST

/api/courses/{courseId}/assignments/
/api/courses/{courseId}/assignments/{assignmentId}

VORSCHLAG: Wie wäre es wenn wir nur /api/assignments/_{assignmentId}_ machen würden?

RESPONSE

{
    "id": "c33cd07e-fe7d-4a5b-bc54-981bcb2a7055",
    "title": "assignment1",
    "description": "string manipulation lab",
    "publishDate": "2001-12-15T00:00:00.000+0000",
    "dueDate": "2001-05-11T00:00:00.000+0000",
    "exercises": [
        {
            "id": "a4097b1f-b476-4c63-9911-8efacc61f4ea",
            "type": "code",
            "language": "python"
        }
    ]
}

Exercise

REQUEST

/api/courses/{courseId}/assignments/{assignmentId}/exercises/{exerciseId}

RESPONSE

{
    "id": "31ee2054-cbbe-41bc-b5bf-98140cb46cb9",
    "type": "code",
    "language": "python",
    "question": "What is 1+1",
    "public_files": [
       {
            "id": "1a5b3035-cb31-493a-969f-6123e9d03344",
            "path": "\\testSuite.py",
            "name": "testSuite",
            "extension": "py",
            "content": "This is definitely a pythoon file",
            "mediaType": false
        }
    ],
   "resource_files": []
}

File

REQUEST

/api/courses/{courseId}/assignments/{assignmentId}/exercises/{exerciseId}/files/{fileId}

RESPONSE

{
    "id": "1a5b3035-cb31-493a-969f-6123e9d03344",
    "path": "\\image.png",
    "name": "testSuite",
    "extension": "py",
    "content": "",
    "mediaType": true
}