Lệnh addTeacher interface được sử dụng để thêm tài khoản đã đăng ký vào danh sách giáo viên của trường.
Ghi chú:
- Lệnh gọi API yêu cầu các tham số SID, safeKey, timeStamp, tài khoản của giáo viên và tên giáo viên. Dữ liệu ảnh đại diện của giáo viên là không bắt buộc.
- Dữ liệu trả về sau khi gọi API có tin ID thể hiện mối liên hệ giữa tài khoản giáo viên với trường, vui lòng bỏ qua ID này.
Trong quá trình tích hợp API, addTeacher là một trong những lệnh bạn sẽ thường xuyên gọi. Để gọi API thành công, vui lòng lưu ý :
- addTeacher tương đương với chức năng quản lý giáo viên tại Trang quản lý ClassIn (Truy cập Trang quản lý ClassIn – mục Giảng dạy – Giáo viên – Thêm giáo viên). Người dùng đã tạo tài khoản ClassIn phải được thêm vào trường của bạn trước, sau đó mới có thể được xếp vào các khóa học/lớp học. Nếu người dùng không phải là giáo viên thuộc trường của bạn, mã lỗi sẽ được trả về khi bạn gọi API thêm người dùng này vào các khóa học/lớp học.
- Người dùng mới chưa đăng ký tài khoản ClassIn có thể được thêm trực tiếp vào tổ chức của bạn khi bạn gọi API Tạo tài khoản (Register User). Đối với người dùng đã tạo tài khoản, việc triển khai API Tạo tài khoản sẽ trả về mã lỗi 135.
The addTeacher interface is to bind a registered account to your institution in the teacher identity.
Notes:
- The API call requires SID, safeKey, timeStamp, teacher’s mobile phone number and teacher name. The teacher avatar in binary-data format is optional.
- Data in the API response is a relationship ID between the institution and the teacher. Please ignore the relationship ID and store the UID returned after implementing the register interface.
In API integration, addTeacher is an interface that you must implement. To make an API call successfully, please note that:
- The addTeacher interface is equivalent to the teacher management function in the ClassIn management console. Path: ClassIn management console-Home-Teaching-Teachers-Add Teacher. A registered user must be added to your institution first, then can be scheduled with lessons. If the user is not a teacher belonging to your institution, an error code will be returned when you call API to arrange lessons for the user.
- New users that have not registered in the ClassIn system before can be directly added to your institution when you call the register interface. Please refer to the register interface for detailed information. For registered users, the register API implementation returns error code 135. Please then call the addTeacher interface to bind the account to your institution.
URL #
https://api.eeo.cn/partner/api/course.api.php?action=addTeacher
HTTP Request Methods #
- POST
Coding Format #
- UTF-8
Request Data #
| Key | Bắt buộc | Yêu cầu thêm | Mô tả | Hướng dẫn |
|---|---|---|---|---|
| SID | Bắt buộc | — | ID của trường | Xem dữ liệu này tại Trang quản lý classin.com trong mục API |
| safeKey | Bắt buộc | Fixed 32-bit all lowercase characters | Khóa bảo mật xác thực trường học | safeKey=MD5(SECRET+timeStamp) |
| timeStamp | Bắt buộc | — | Theo Unix Epoch timestamp & có hiệu lực trong vòng 20 phút | Thời gian UNIX Epoch là số giây đã trôi qua kể từ 00:00:00 (giờ chuẩn quốc tế) vào ngày 1 tháng 1 năm 1970 |
| teacherAccount | Bắt buộc | Số điện thoại hoặc email. Định dạng: 00 Mã vùng-Số điện thoại. Có thể sử dụng teacherUid hoặc teacherAccount. Nếu teacherAccount và teacherUid được truyền cùng lúc, tham số teacherUid sẽ được ưu tiên | Tài khoản của giáo viên | Ví dụ：Số điện thoại Việt Nam, 0901234567, vui lòng gửi tham số 0084-901234567 |
| teacherName | Bắt buộc | — | Tên của giáo viên | — |
| Filedata | Không bắt buộc | Binary stream | Hình ảnh của giáo viên | — |
Response Data #
| Key | Định dạng | Phản hồi | Ý nghĩa |
|---|---|---|---|
| data | number | 14163 | Trả về ID thông báo mối liên kết giữa tài khoản giáo viên với trường |
| error_info | object | Return message object | |
| └ errno | number | 1 | Mã lỗi |
| └ error | string | “Normal execution” | Thông tin lỗi |
Sample #
- HTTP Request
POST /partner/api/course.api.php?action=addTeacher HTTP/1.1
Host: root_url
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
SID=2339736&safeKey=8d3fb00ceddd29638e2d5dd12d69841d&timeStamp=1492793638&teacherAccount=001-8006437676&teacherName=hubert&Filedata=@~/photo.jpg
- Shell cURL analog request instruction
curl -H "Content-Type: application/x-www-form-urlencoded" -X "POST" \
-d "SID=1234567" \
-d "safeKey=0f7781b3033527a8cc2b1abbf45a5fd2" \
-d "timeStamp=1484719085" \
-d "teacherAccount=001-8006437676" \
-d "teacherName=hubert" \
-d "Filedata=@~/photo.jpg" \
"https://api.eeo.cn/partner/api/course.api.php?action=addTeacher"
Response sample（The normal return json packet example） #
{
"data": 14161,
"error_info": {
"errno": 1,
"error": "程序正常执行"
}
}
Error Code Description #
| Error Code | Description |
|---|---|
| 1 | Thành công |
| 100 | Parameters sai định dạng hoặc không hoàn chỉnh |
| 102 | Không có quyền thao tác (Xác thực bảo mật thất bại) |
| 103 | Tải lên hình ảnh thất bại |
| 104 | Thao tác thất bại |
| 113 | Số điện thoại chưa được đăng ký |
| 114 | Lỗi server |
| 122 | Tài khoản giáo viên không hợp lệ |
| 131 | Đăng ký thất bại |
| 133 | Tài khoản này đã được thêm vào danh sách giáo viên của trường |
| 288 | Mã vùng không hợp lệ |
| 400 | Dữ liệu yêu cầu không hợp lệ |
| 884 | Tài khoản đã bị người dùng xóa |
| 845 | Vượt quá số lượng tài khoản giáo viên của trường |
