Notes

This API exposes endpoints for managing student notes.

Get List of Notes

GET https://api.afcreate.com/edu/v1/note/list

Retrieves all notes from the specified category or categories.

Query Parameters

Headers

[{
    "noteId": "ID",
    "text": "This is a note about a student in a particular lesson.",
    "classId": "ID", 
    "userId": "ID",
    "studentId": "ID",
    "courseId": "ID",
    "lessonId": "ID",
}, {
    "noteId": "ID",
    "text": "This is class note about a student across a whole course.",
    "classId": "ID", 
    "userId": "ID",
    "studentId": "ID",
    "courseId": "ID",
    "lessonId": null,
}, {
    "noteId": "ID",
    "text": "This is note about a specific user.",
    "classId": nul;, 
    "userId": "ID",
    "studentId": null,
    "courseId": null,
    "lessonId": null,
}]

Get a Note

GET https://api.afcreate.com/edu/v1/note

Retrieves a specific note by ID.

Query Parameters

Headers

{
    "noteId": "ID",
    "text": "This is a note about a student in a particular lesson.",
    "classId": "ID", 
    "userId": "ID",
    "studentId": "ID",
    "courseId": "ID",
    "lessonId": "ID",
}

Create a Note

PUT https://api.afcreate.com/edu/v1/note

Creates a note. The following parameters allow the API to automatically add additional metadata to a note: - if a lessonId is specified, the lesson's course ID is added. - if a classId is specified, the class's course ID is added. - if a studentId is specified, the student's user profile ID, class ID, and course IDs are added. When adding notes for the MOTAR Training Dashboard, you must include a student ID and a lesson ID.

Headers

Request Body

Delete a Note

POST https://api.afcreate.com/edu/v1/note/remove

Deletes a note by ID.

Headers

Request Body

{
    "success": true
}

Last updated