Required Authentication
An API key is required for authentication. Here's how to find yours:
Go to the School Settings Page.
Click on the Developers tab.
Create an API Key.
You can use the API key either in the header (X-API-KEY: key value) or as a query parameter (apikey=keyvalue).
API Request
1. Request URL: https://app.teachngo.com/api/v1/note/add
2. Method: POST
3. Body: JSON
Example:
{
"student_id": 141711,
"visibility": "public", /* public / private */
"note": "Test API Note"
}
API Responses
Success
{
"status": "success",
"message": "student note has been added successfully!"
}
Validation Error
{
"status": "fail",
"message": "validation Error.",
"errors": {
"student_id": "student_id field is missing",
"visibility": "visibility field is missing"
}
}
Method Not Allowed
{
"status": "fail",
"message": "method not allowed"
}
401 Unauthorized
{
"status": "fail",
"message": "unauthorized user"