Gửi báo cáo danh sách lớp
1. Mô tả chung
API này giúp các phòng và trường đối tác thực hiện gửi dữ liệu báo cáo lớp học khi có yêu cầu thực hiện báo cáo.
2. Phạm vi đối tượng sử dụng
- Các trường học, phòng giáo dục liên kết với GEdu.
- Các hệ thống đối tác tích hợp như phần mềm quản lý học sinh, cổng thông tin giáo dục,...
3. Chuẩn bị cho Api
- Thực hiện lấy danh sách đợt báo cáo hiện có để lấy reportingRoundId
- Xem cách lấy thông tin đợt báo cáo tại : 👉 Xem thêm
4. Tài liệu api
4.1 Gửi dữ liệu báo cáo
Dùng để gửi thông tin lớp học để thống kê dữ liệu
- 4.1.1 Endpoint:
POST /edu/v1/external/reporting-rounds/classes
- 4.1.2 Request Parameters:
| Tên | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|
| ReportingRoundId | int | Có | Id đợt báo cáo |
| SchoolCode | string | Có | Mã định danh trường |
| ClassItems | ClassItems[] | Có | Chi tiết lớp học |
| Timestamp | long | Có | Thời điểm request |
| Signature | string | Có | Chữ ký xác thực. Mã hóa base64 |
| Tên | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|
| Code | int | Có | Mã lớp học |
| Name | string | Có | Tên lớp học |
| ClassLevelName | string | Có | Khối Lớp |
| OrderNo | int | Có | STT |
| IsCombinedClass | bool | Không | Có ghép lớp |
| IsBoardingClass | bool | Không | Lớp bán trú |
| ExtendInfo | Dictionary<string, string> | Không | Danh sách thông tin mở rộng. Xem mô tả |
Dữ liệu sẽ được gửi hình thức json: application/json
Example request:
Request body
{
"reportingRoundId": 1,
"schoolCode": "TH01",
"timestamp":1750999002,
"signature":"qbZBeVi9h5KIHwpoNFroNS1V8JBmLIaWoDzxhLXZNK0=",
"classItems": [
{
"code": "L01",
"name": "Lớp 1",
"classLevelName": "Khối 1",
"isCombinedClass": false,
"isBoardingClass": true,
"orderNo": 1,
"extendInfo": {
"IS_GIAI_THE": "true"
}
},
{
"code": "L02",
"name": "Lớp 2",
"classLevelName": "Khối 1",
"isCombinedClass": null,
"isBoardingClass": null,
"orderNo": 2,
"extendInfo": {}
}
]
}
- 4.1.3 Response:
Response
{
"success": true,
"message": "Đã tải lên 2 bản ghi",
"data": true,
"showMessage": true,
"statusCode": 200,
"errors": null,
"meta": null
}