Student comments
Students and customers · 3 операції
GET
List student comments
/api/student/comment/{id}Comments left by staff on a student card, newest first.
list_student_comments
Параметри шляху · 1
id—Відповідь · 200
application/json
statusCodeприклад 200message—data11 полів
commentId—studentId—teacherId—groupId—customerId—text—userComment author: a user or an automation rule; exactly one is set.5 полів
id—firstName—lastName—middleName—isArchival—automation2 поля
automationId—name—files5 полів
storageFileId—keySigned through GET /storage/presigned-url, under the comment section's rights.name—mimeType—size—updatedAtформат YYYY-MM-DDTHH:mm:sscreatedAtформат YYYY-MM-DDTHH:mm:sscurl "https://your-school.rist.pro/api/student/comment/1" \
-H "Authorization: Bearer $RIST_API_KEY"const response = await fetch("https://your-school.rist.pro/api/student/comment/1", {
headers: {
Authorization: `Bearer ${process.env.RIST_API_KEY}`,
},
});
const { data } = await response.json();import os
import requests
response = requests.get(
"https://your-school.rist.pro/api/student/comment/1",
headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
)
response.raise_for_status()
data = response.json()["data"]Приклад відповіді · 200
{
"statusCode": 200,
"message": "Operation completed successfully",
"data": [
{
"commentId": 1,
"studentId": 1,
"teacherId": 1,
"groupId": 1,
"customerId": 1,
"text": "string",
"user": {
"id": 1,
"firstName": "string",
"lastName": "string",
"middleName": "string",
"isArchival": false
},
"automation": {
"automationId": 1,
"name": "string"
},
"files": [
{
"storageFileId": 1,
"key": "string",
"name": "string",
"mimeType": "string",
"size": 0
}
],
"updatedAt": "2026-11-09T14:30:00",
"createdAt": "2026-11-09T14:30:00"
}
]
}POST
Add comment to student
/api/student/commentAdd a staff comment to a student card.
create_student_comment
Тіло запиту
application/json · object
studentIdмін. 1teacherIdмін. 1groupIdмін. 1customerIdмін. 1textMissing for a comment of files only: the global pipe turns empty text into null.довжина макс. 3000Відповідь · 201
application/json
statusCodeприклад 201message—data11 полів
commentId—studentId—teacherId—groupId—customerId—text—userComment author: a user or an automation rule; exactly one is set.5 полів
id—firstName—lastName—middleName—isArchival—automation2 поля
automationId—name—files5 полів
storageFileId—keySigned through GET /storage/presigned-url, under the comment section's rights.name—mimeType—size—updatedAtформат YYYY-MM-DDTHH:mm:sscreatedAtформат YYYY-MM-DDTHH:mm:sscurl -X POST "https://your-school.rist.pro/api/student/comment" \
-H "Authorization: Bearer $RIST_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"studentId": 1,
"teacherId": 1,
"groupId": 1,
"customerId": 1,
"text": "string"
}'const response = await fetch("https://your-school.rist.pro/api/student/comment", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.RIST_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"studentId": 1,
"teacherId": 1,
"groupId": 1,
"customerId": 1,
"text": "string"
}),
});
const { data } = await response.json();import os
import requests
response = requests.post(
"https://your-school.rist.pro/api/student/comment",
headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
json={
"studentId": 1,
"teacherId": 1,
"groupId": 1,
"customerId": 1,
"text": "string"
},
)
response.raise_for_status()
data = response.json()["data"]Приклад відповіді · 201
{
"statusCode": 201,
"message": "Operation completed successfully",
"data": {
"commentId": 1,
"studentId": 1,
"teacherId": 1,
"groupId": 1,
"customerId": 1,
"text": "string",
"user": {
"id": 1,
"firstName": "string",
"lastName": "string",
"middleName": "string",
"isArchival": false
},
"automation": {
"automationId": 1,
"name": "string"
},
"files": [
{
"storageFileId": 1,
"key": "string",
"name": "string",
"mimeType": "string",
"size": 0
}
],
"updatedAt": "2026-11-09T14:30:00",
"createdAt": "2026-11-09T14:30:00"
}
}PUT
Edit student comment
/api/student/comment/{id}Replace the text of a student comment. The path id is the comment id (from GET /api/student/comment/{id}), not the student id.
update_student_comment
Параметри шляху · 1
id—Тіло запиту
application/json · object
textдовжина макс. 3000Відповідь · 200
application/json
statusCodeприклад 200message—data11 полів
commentId—studentId—teacherId—groupId—customerId—text—userComment author: a user or an automation rule; exactly one is set.5 полів
id—firstName—lastName—middleName—isArchival—automation2 поля
automationId—name—files5 полів
storageFileId—keySigned through GET /storage/presigned-url, under the comment section's rights.name—mimeType—size—updatedAtформат YYYY-MM-DDTHH:mm:sscreatedAtформат YYYY-MM-DDTHH:mm:sscurl -X PUT "https://your-school.rist.pro/api/student/comment/1" \
-H "Authorization: Bearer $RIST_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"text": "string"
}'const response = await fetch("https://your-school.rist.pro/api/student/comment/1", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.RIST_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"text": "string"
}),
});
const { data } = await response.json();import os
import requests
response = requests.put(
"https://your-school.rist.pro/api/student/comment/1",
headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
json={
"text": "string"
},
)
response.raise_for_status()
data = response.json()["data"]Приклад відповіді · 200
{
"statusCode": 200,
"message": "Operation completed successfully",
"data": {
"commentId": 1,
"studentId": 1,
"teacherId": 1,
"groupId": 1,
"customerId": 1,
"text": "string",
"user": {
"id": 1,
"firstName": "string",
"lastName": "string",
"middleName": "string",
"isArchival": false
},
"automation": {
"automationId": 1,
"name": "string"
},
"files": [
{
"storageFileId": 1,
"key": "string",
"name": "string",
"mimeType": "string",
"size": 0
}
],
"updatedAt": "2026-11-09T14:30:00",
"createdAt": "2026-11-09T14:30:00"
}
}