Scope: todos
/api/v2/todos
Erstellt eine neue Hausaufgabe. Der Benutzer welche die Hausaufgabe erstellt hat wird automatisch als Admin/Eigentümr für die Hausaufgabe hinzugefügt. Siehe Permissions.
Attribut | Typ | Erforderlich | Beschreibung |
---|---|---|---|
lesson_id |
Integer | Ja | ID des Faches des Hausaufgabe |
text |
String | Ja | Text der Hausaufgabe |
note |
String | Nein | Beschreibung / Anweisung der Hausaufgabe |
posted_on |
String | Nein | Wann die Hausaufgabe aufgegeben und veröffentlicht wurde. Wenn kein Zeitpunkt angegeben wird, wird der aktuelle Zeitpunkt verwendet. Datetime String im ISO 8601 format |
until_datetime |
String | Ja | Zeitpunkt, bis wann die Hausaufgabe zu erledigen ist. Datetime String im ISO 8601 Format |
is_submissionable |
Boolean | Nein | Sollen die Benutzer für diese Hausaufgabe Lösungen abgeben können. |
points |
Float | Nein | Maximal zu erreichende Punkte für die Hausaufgabe. |
Anfrage:
{
"lesson_id": 1,
"text": "S. 62 Aufgabe 3",
"note": "**Wichtig:** Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"until_datetime": "2021-02-07T14:00:00+01:00",
"is_submissionable": true,
"points": 10
}
Antwort:
{
"id": 1,
"course_id": null,
"lesson_id": 1,
"text": "S. 62 Aufgabe 3",
"note": "**Wichtig:** Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"points": 10,
"time": 1612548256,
"until_datetime": "2021-02-07T14:00:00+01:00",
"import_source": null,
"import_key": null,
"created_at": "2021-02-05T19:04:16+01:00",
"posted_on": "2021-02-05T19:04:16+01:00",
"to_be_done_until": "2021-02-07T14:00:00+01:00",
"lesson": {
"id": 1,
"name": "Religion",
"short": "Re",
"room": "",
"teacher": "",
"note": "",
"color": "#333333",
"import_source": null,
"is_gradable": true,
"is_timetable_only": false,
"rooms": []
},
"note_formatted": "<b>Wichtig:</b> Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"note_basic": "Wichtig: Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"is_checked": false,
"can_check": true,
"is_submissionable": true,
"document_relation": "todo-1",
"can_correct": true,
"can_edit": true,
"is_admin": true,
"can_delete": true,
"documents": []
}
/api/v2/todos
Gibt alle Hausaufgaben zurück, welche für den Benutzer verfügbar sind. Da einem Benutzer sehr viele Hausaufgaben zugeordnet sein können, empfiehlt es sich die Ergebnisse zu Filtern.
Attribut | Typ | Erforderlich | Beschreibung |
---|---|---|---|
lesson_id |
Integer | Nein | ID des Faches des Hausaufgabe |
posted_on |
String | Nein | Wann die Hausaufgabe aufgegeben und veröffentlicht wurde. Wenn kein Zeitpunkt angegeben wird, wird der aktuelle Zeitpunkt verwendet. Datetime String im ISO 8601 format |
until_datetime |
String | Nein | Zeitpunkt, bis wann die Hausaufgabe zu erledigen ist. Datetime String im ISO 8601 Format |
import_source |
String | Nein | Name der Quelle aus welcher die Hausaufgabe importer wurde |
import_key |
String | Nein | Eindeutige Referenz zu dem Inhalt aus dem Quellsystem |
Antwort:
[
{
"id": 1,
"course_id": null,
"lesson_id": 1,
"text": "S. 62 Aufgabe 3",
"note": "**Wichtig:** Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"points": 10,
"time": 1612548256,
"until_datetime": "2021-02-07T14:00:00+01:00",
"import_source": null,
"import_key": null,
"created_at": "2021-02-05T19:04:16+01:00",
"posted_on": "2021-02-05T19:04:16+01:00",
"to_be_done_until": "2021-02-07T14:00:00+01:00",
"lesson": {
"id": 1,
"name": "Religion",
"short": "Re",
"room": "",
"teacher": "",
"note": "",
"color": "#333333",
"import_source": null,
"is_gradable": true,
"is_timetable_only": false,
"rooms": []
},
"note_formatted": "<b>Wichtig:</b> Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"note_basic": "Wichtig: Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"is_checked": false,
"can_check": true,
"is_submissionable": true,
"document_relation": "todo-1",
"can_correct": true,
"can_edit": true,
"is_admin": true,
"can_delete": true,
"documents": []
},
...truncated
]
/api/v2/todos/:todo_id
Gibt eine bestimmte Hausaufgabe zurück.
Antwort:
{
"id": 1,
"course_id": null,
"lesson_id": 1,
"text": "S. 62 Aufgabe 3",
"note": "**Wichtig:** Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"points": 10,
"time": 1612548256,
"until_datetime": "2021-02-07T14:00:00+01:00",
"import_source": null,
"import_key": null,
"created_at": "2021-02-05T19:04:16+01:00",
"posted_on": "2021-02-05T19:04:16+01:00",
"to_be_done_until": "2021-02-07T14:00:00+01:00",
"lesson": {
"id": 1,
"name": "Religion",
"short": "Re",
"room": "",
"teacher": "",
"note": "",
"color": "#333333",
"import_source": null,
"is_gradable": true,
"is_timetable_only": false,
"rooms": []
},
"note_formatted": "<b>Wichtig:</b> Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"note_basic": "Wichtig: Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"is_checked": false,
"can_check": true,
"is_submissionable": true,
"document_relation": "todo-1",
"can_correct": true,
"can_edit": true,
"is_admin": true,
"can_delete": true,
"documents": []
}
/api/v2/todos/:todo_id
Bearbeitet eine Hausaufgabe. Um eine Hausaufgabe bearbeiten zu können benötigt der Benutzer Rechte zum Bearbeiten. Siehe Permissions.
Attribut | Typ | Erforderlich | Beschreibung |
---|---|---|---|
todo_id |
Integer | Ja | ID der Hausaufgabe (wird in der URL verwendet) |
lesson_id |
Integer | Ja | ID des Faches des Hausaufgabe |
text |
String | Ja | Text der Hausaufgabe |
note |
String | Nein | Beschreibung / Anweisung der Hausaufgabe |
posted_on |
String | Nein | Wann die Hausaufgabe aufgegeben und veröffentlicht wurde. Wenn kein Zeitpunkt angegeben wird, wird der aktuelle Zeitpunkt verwendet. Datetime String im ISO 8601 Format |
until_datetime |
String | Ja | Zeitpunkt, bis wann die Hausaufgabe zu erledigen ist. Datetime String im ISO 8601 Format |
is_submissionable |
Boolean | Nein | Sollen die Benutzer für diese Hausaufgabe Lösungen abgeben können. |
points |
Float | Nein | Maximal zu erreichende Punkte für die Hausaufgabe. |
Antwort:
{
"id": 1,
"course_id": null,
"lesson_id": 1,
"text": "S. 62 Aufgabe 3",
"note": "**Wichtig:** Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"points": 10,
"time": 1612548256,
"until_datetime": "2021-02-07T14:00:00+01:00",
"import_source": null,
"import_key": null,
"created_at": "2021-02-05T19:04:16+01:00",
"posted_on": "2021-02-05T19:04:16+01:00",
"to_be_done_until": "2021-02-07T14:00:00+01:00",
"lesson": {
"id": 1,
"name": "Religion",
"short": "Re",
"room": "",
"teacher": "",
"note": "",
"color": "#333333",
"import_source": null,
"is_gradable": true,
"is_timetable_only": false,
"rooms": []
},
"note_formatted": "<b>Wichtig:</b> Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"note_basic": "Wichtig: Bitte bis morgen abgeben\n\nAnsonsnte viel Spaß",
"is_checked": false,
"can_check": true,
"is_submissionable": true,
"document_relation": "todo-1",
"can_correct": true,
"can_edit": true,
"is_admin": true,
"can_delete": true,
"documents": []
}
/api/v2/todos/:todo_id
Löscht eine Hausaufgabe. Um eine Hausaufgabe zu löschen, muss der Benutzer Eigentümer/Admin der Hausaufgabe sein. Mehr unter Permissions.