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

Name	Type	Description
lessonId	string	A lessonId to which the desired notes are related.
userId	string	A user account ID to whom the notes are related.
classId	string	A class ID to which the notes are related.
studentId	string	A student ID to whom the notes are related.
courseId	string	A course ID to which the desired notes are related.

Headers

Name	Type	Description
Authorization	string	Authentication token generated by login.

200 List of notes retrieved.

[{
    "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

Name	Type	Description
noteId	string	A note ID.

Headers

Name	Type	Description
Authorization	string	Authentication token generated by login.

200

{
    "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

Name	Type	Description
Authorization	string	Authentication token generated by login.

Request Body

Name	Type	Description
text	string	Text of note.
lessonId	string	ID of lesson to which this note refers.
userId	string	ID of user profile to whom this note refers.
classId	string	ID of class to which this note refers.
studentId	string	ID of student to whom this note refers.
courseId	string	ID of course to which this note refers.

200

Delete a Note

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

Deletes a note by ID.

Headers

Name	Type	Description
Authorization	string	Authentication token generated by login.

Request Body

Name	Type	Description
noteId	string	A note ID.

200 Delete was successful.

{
    "success": true
}