Lấy báo cáo cán bộ

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 học sinh 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 học sinh đã gửi báo cáo thành công

• 4.1.1 Endpoint:

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

• 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
ClassName	Query	string	Yes	Tên lớp
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=Student&reportingRoundId={ReportingRoundId}&schoolCode={SchoolCode}&className={ClassName}&pageSize={PageSize}&pageNumber={PageNumber}&timestamp={Timestamp}

Example:

Request

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

• 4.1.3 Response Parameters:

StudentResponseModel

Tên Trường	Kiểu Dữ Liệu	Mô Tả
Id	int	Id báo cáo lớp học
FirstName	string	Họ
LastName	string	Tên
FullName	string	Họ và tên đầy đủ
DoB	DateTime?	Ngày sinh
GenderName	string	Giới tính
IdentityNo	string	Số CMND/CCCD
IdentityIssuedBy	string	Nơi cấp CMND/CCCD
IdentityIssuedDate	DateTime?	Ngày cấp CMND/CCCD
PlaceOfBirth	string	Nơi sinh
NationalName	string	Quốc tịch
RegionName	string	Khu vực
ProvinceName	string	Tỉnh/Thành phố
DistrictName	string	Quận/Huyện
WardName	string	Phường/Xã
Address	string	Địa chỉ thường trú
ReligionName	string	Tôn giáo
EthnicName	string	Dân tộc
ContactPhone	string	Số điện thoại liên hệ
Code	string	Mã học sinh nội bộ
StudentCode	string	Mã học sinh theo hệ thống
ClassName	string	Lớp học hiện tại
StatusName	string	Trạng thái học sinh
Relationships	Relationships[]	Danh sách liên hệ của học sinh
ExtendInfo	Dictionary<string, string>	Danh sách thông tin mở rộng. Xem mô tả

StudentRelationshipsResponseModel

Tên Trường	Kiểu Dữ Liệu	Mô Tả
FirstName	string	Họ
LastName	string	Tên
FullName	string	Họ và tên đầy đủ
DoB	DateTime?	Ngày sinh
Phone	string	Số điện thoại
Occupation	string	Nghề nghiệp
IdentityNo	string	Số CMND/CCCD
IdentityIssuedBy	string	Nơi cấp CMND/CCCD
IdentityIssuedDate	DateTime?	Ngày cấp CMND/CCCD
RelationshipName	string	Mối quan hệ với học sinh

• 4.1.4 Example response:

Response

{
    "success": true,
    "message": "Thành công",
    "data": [],
    "showMessage": false,
    "statusCode": 200,
    "errors": null,
    "currentPage": 1,
    "totalPages": 0,
    "totalCount": 0,
    "pageSize": 20,
    "hasPreviousPage": false,
    "hasNextPage": false
}