添加教师

功能说明

添加教师。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/teacher?extId=分配的企业id

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明
version	String	Path	是	无	v1
extId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
name	Map	Body	是	无	教师姓名,支持汉字、字母、数字和下划线（长度要求20位以内）
countryCode	Sting	Body	是	无	国家区号（默认是+86）
phone	String	Body	是	无	教师电话号码
mailbox	String	Body	否	无	教师邮箱
departmentIds	数组	Body	是	无	班级ID（数组类型）
description	String	Body	否	无	教师描述(长度要求300字以内)
schoolTypeId	long	Body	否	无	学段id
subjectId	long	Body	否	无	学科id
roleId	long	Body	否	无	角色id（默认是教师）
sendMail	boolean	Body	否	无	true：发送邮件提醒，false：不发邮件
sendMessage	boolean	Body	否	无	true：发送短信提醒，false：不发短信
profilePictureId	long	Body	否	无	头像资源id（文件上传oss后获得）

示例代码

请求消息体示例（Json）

{
    "name": "李四",//姓名
    "phone": "18380227711",//电话号码
    "countryCode": "+86",//区号
    "profilePictureId": "",//头像资源id
    "subjectId": null,//学科id
    "roleId": "教师",//角色id
    "departmentIds": [1106],//部门id
    "schoolTypeId": null,//学段id
    "sendMail":true,
    "sendMessage":true,
    "description":""
}

返回结果示例：

成功时返回结果数据，失败时返回小鱼RESTAPI错误码

{
 "teacherId":"1009825",  //教师id
}

返回参数说明

参数名称	说明
teacherId	教师id

2022-11-09 16:33:16

导出PDF文档