Báo cáo danh sách học sinh

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 học sinh 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 cán bộ để thống kê dữ liệu ngành

• 4.1.1 Endpoint:

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

• 4.1.2 Request Parameters:

StudentModel

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
studentItems	StudentItems[]	Có	Chi tiết cán bộ
timestamp	long	Có	Thời điểm request
signature	string	Có	Chữ ký xác thực. Mã hóa base64

StudentItem

Tên	Kiểu dữ liệu	Bắt buộc	Mô tả
FirstName	string	Có	Họ và tên đệm
LastName	string	Có	Tên
DoB	datetime	Có	Ngày sinh
GenderName	string	Có	Giới tính (Nam/Nữ)
Code	string	Có	Mã học sinh sở cấp
ClassName	string	Có	Tên lớp
StatusName	string	Có	Trạng thái
IdentityNo	string	Có	Số CCCD (12 chữ số, theo đúng chuẩn format cccd chính phủ)
IdentityIssuedBy	string	Không	Nơi cấp giấy tờ tùy thân
IdentityIssuedDate	datetime	Không	Ngày cấp giấy tờ tùy thân
PlaceOfBirth	string	Không	Nơi sinh
NationalName	string	Không	Quốc tịch
RegionName	string	Không	Tên vùng miền
ProvinceName	string	Không	Tỉnh/Thành phố thường trú
DistrictName	string	Không	Quận/Huyện thường trú
WardName	string	Không	Phường/Xã thường trú
Address	string	Không	Địa chỉ cụ thể
ReligionName	string	Không	Tôn giáo
EthnicName	string	Không	Dân tộc
ContactPhone	string	Không	Số điện thoại liên hệ
StudentCode	string	Không	Mã học sinh
Relationships	Relationships[]	Không	Danh sách liên hệ của học sinh
ExtendInfo	Dictionary<string, string>	Không	Danh sách thông tin mở rộng. Xem mô tả

Relationship

Tên	Kiểu dữ liệu	Bắt buộc	Mô tả
FirstName	string	Có	Họ và tên đệm
LastName	string	Có	Tên
DoB	datetime	Có	Ngày sinh
IdentityNo	string	Có	Số CCCD (12 chữ số, theo đúng chuẩn format cccd chính phủ)
Phone	string	Không	Số điện thoại
Occupation	string	Không	Nghề nghiệp
IdentityIssuedBy	string	Không	Nơi cấp giấy tờ tùy thân
IdentityIssuedDate	datetime	Không	Ngày cấp giấy tờ tùy thân
RelationshipName	string	Không	Mối quan hệ với học sinh

• 5.1.3 Request body:

Dữ liệu sẽ được gửi hình thức json: application/json

Example request:

Request body

  {
    "reportingRoundId": 8,
    "schoolCode": "TH01",
    "studentItems": [
      {
        "FirstName": "Nguyen Van",
        "LastName": "A",
        "DoB": "2010-05-20T00:00:00",
        "GenderName": "Nam",
        "IdentityNo": "123456789012",
        "IdentityIssuedBy": "Công an TP.HCM",
        "IdentityIssuedDate": "2020-01-01T00:00:00",
        "PlaceOfBirth": "Hồ Chí Minh",
        "NationalName": "Việt Nam",
        "RegionName": "Miền Nam",
        "ProvinceName": "TP.HCM",
        "DistrictName": "Quận 1",
        "WardName": "Phường Bến Nghé",
        "Address": "123 Lê Lợi, Quận 1",
        "ReligionName": "Không",
        "EthnicName": "Kinh",
        "ContactPhone": "0912345678",
        "Code": "HS0001",
        "StudentCode": "SV0001",
        "ClassName": "Lớp 5A",
        "StatusName": "Đang học",
        "Relationships": [
          {
            "FirstName": "Nguyen Van",
            "LastName": "B",
            "DoB": "1980-03-15T00:00:00",
            "Phone": "0987654321",
            "Occupation": "Giáo viên",
            "IdentityNo": "987654321098",
            "IdentityIssuedBy": "Công an TP.HCM",
            "IdentityIssuedDate": "2000-05-20T00:00:00",
            "RelationshipName": "Bố"
          }
        ],
        "ExtendInfo": {
          "IS_HO_NGHEO": "true",
        }
      }
    ],
    "timestamp": 1719475200,
    "signature": "abcXYZ123456SignatureBase64=="
  }

• 5.1.4 Response:

Response

  {
      "success": true,
      "message": "Đã tải lên 1 bản ghi",
      "data": true,
      "showMessage": true,
      "statusCode": 200,
      "errors": null,
      "meta": null
  }