1. Mô tả chung

Khi phòng / sở giáo dục cần các đối tác gửi báo cáo thông kê các thông tin giáo dục (học sinh, lớp, cơ sở vật chất,...). API này lấy danh sách các thông tin trường / đối tác cần gửi báo cáo lên phòng / sở để thống kê.

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. Tài liệu api

• 3.1 Endpoint

  GET /edu/v1/external/reporting-rounds

• 3.2 Parameters

  Tên	Vị trí	Kiểu dữ liệu	Bắt buộc	Mô tả
  schoolCode	Query	string	Có	Mã định danh trường
  timestamp	Query	long	Có	Thời gian request
  signature	Query	string	Có	Chữ kí được tính từ Secret Key

  PlainText: schoolCode={SchoolCode}&timestamp={Timestamp}

  Request Example:

  X-Access-Key: 1234567890
  GET /edu/v1/external/reporting-rounds?SchoolCode=ABC123&Timestamp=1719378600&Signature=2eGh2dsJKqv96WxIm4KFVMZT4Q6OqHTmZwhBqHwjF0=

• 3.3 Responses

  • Trả về danh sách các đợt báo cáo trường / đối tác cần gửi trong tháng
  • Danh sách gồm thông tin Id để làm báo cáo học sinh, cán bộ, lớp,...

    {
        "success": true,
        "message": "Thành công",
        "data": [
            {
                "id": 8,
                "modifiedDate": "2025-06-26T12:02:23.577",
                "code": "BC062025",
                "name": "Báo cáo tháng 6-2025",
                "academicYearId": 4,
                "reportTypeId": 16,
                "fromDate": "2025-06-01T00:00:00",
                "toDate": "2025-06-30T00:00:00",
                "reportTypeItems": [
                    {
                        "dataGroupId": 913,
                        "dataGroupCode": "CLASS",
                        "dataGroupName": "Lớp học",
                        "dataGroupOrderNo": 1
                    },
                    {
                        "dataGroupId": 914,
                        "dataGroupCode": "STUDENT",
                        "dataGroupName": "Học sinh",
                        "dataGroupOrderNo": 2
                    },
                    {
                        "dataGroupId": 915,
                        "dataGroupCode": "EMPLOYEE",
                        "dataGroupName": "Cán bộ",
                        "dataGroupOrderNo": 3
                    }
                ]
            }
        ],
        "showMessage": true,
        "statusCode": 200,
        "errors": null,
        "meta": null
    }

• 3.4 Chi tiết response

  • Thông tin đợt báo cáo: ReportingRound

  Tên thuộc tính	Kiểu dữ liệu	Mô tả
  Id	int	Id đợt báo cáo
  Code	string	Mã của đợt báo cáo.
  Name	string	Tên đợt báo cáo.
  AcademicYearId	int	Học kỳ
  FromDate	DateTime?	Ngày bắt đầu hiệu lực của đợt báo cáo.
  ToDate	DateTime?	Ngày kết thúc hiệu lực của đợt báo cáo.
  ReportTypeId	int	ID nhóm cần dữ liệu báo cáo
  ReportTypeItems	ReportTypeDetail[]	Chi tiết các thông tin cần báo cáo đợt này

  • Thông tin chi tiết báo cáo: ReportTypeDetail

  Tên thuộc tính	Kiểu dữ liệu	Mô tả
  DataGroupId	int	Id chi tiết loại báo cáo
  DataGroupCode	string	Mã chi tiết loại báo cáo
  DataGroupName	string	Tên chi tiết loại báo cáo (ví dụ: Báo cáo dữ liệu lớp, ...)
  DataGroupOrderNo	int	Số thứ tự