Lấy báo cáo lớp học

1. Mô tả chung

API này giúp các phòng và trường đối tác thực hiện lấy chi tiết báo cáo lớp học từ trục dữ liệu.

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 Danh sách dữ liệu báo cáo đã gửi

Dùng để lấy danh sách lớp học đã gửi báo cáo thành công

• 4.1.1 Endpoint:

GET /edu/v1/external/reporting-rounds/classes

• 4.1.2 Request Parameters:

Tên	Vị trí	Kiểu dữ liệu	Bắt buộc	Mô tả
ReportingRoundId	Query	int	Yes	Id đợt báo cáo
SchoolCode	Query	string	Yes	Mã định danh trường
Timestamp	Query	long	Yes	Thời gian thực hiện request
Signature	Query	string	Yes	Chữ kí được tính từ Secret Key
PageSize	Query	int	No	Số lượng item trả về (mặc định là 20). Giá trị phải từ 1 - 50
PageNumber	Query	int	No	Trang hiện tại (mặc định 1). Giá trị phải lớn hơn 1

PlainText:

dataGroup=Class&reportingRoundId={ReportingRoundId}&schoolCode={SchoolCode}&pageSize={PageSize}&pageNumber={PageNumber}&timestamp={Timestamp}

Example:

Request

X-Access-Key: 1234567890
GET /edu/v1/external/reporting-rounds/classes?reportingRoundId=1&schoolCode=THCSAnPhu001&pageSize=&pageNumber=&timestamp=1719378600&signature=2eGh2dsJKqv96WxIm4KFVMZT4Q6OqHTmZwhBqHwjF0=

• 4.1.3 Response Parameters:

ClassModel

Tên	Kiểu dữ liệu	Mô tả
Id	int	Id báo cáo lớp học
Code	string	Mã lớp học
Name	string	Tên lớp học
ClassLevelName	string	Khối lớp
IsCombinedClass	bool	Có ghép lớp
IsBoardingClass	bool	Lớp bán trú
OrderNo	int	STT
ExtendInfo	Dictionary<string, string>	Danh sách thông tin mở rộng. Xem mô tả

• 4.1.4 Example response:

Response

{
    "success": true,
    "message": "Thành công",
    "data": [
        {
            "code": "L01",
            "name": "Lớp 1",
            "classLevelName": "Khối 1",
            "isCombinedClass": false,
            "isBoardingClass": true,
            "orderNo": 1,
            "extendInfo": {
                "IS_GIAI_THE": "false"
            },
            "id": 23
        },
        {
            "code": "L02",
            "name": "Lớp 2",
            "classLevelName": "Khối 1",
            "isCombinedClass": null,
            "isBoardingClass": null,
            "orderNo": 2,
            "extendInfo": {},
            "id": 24
        }
    ],
    "showMessage": false,
    "statusCode": 200,
    "errors": null,
    "currentPage": 1,
    "totalPages": 1,
    "totalCount": 2,
    "pageSize": 20,
    "hasPreviousPage": false,
    "hasNextPage": false
}