查询员工信息。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/teacher/info/{teacherId}?
enterpriseId=分配的企业id
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
teacherId | long | Query | 是 | 无 | 员工列表中的teacherId |
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"teacher": {
"teacherId": "123456",
"name": "用户名称1",
"phone": "13100000000",
"countryCode": "+86",
"mailbox": null,
"profilePicture": null,
"deptIds": [
"1610"
],
"roleId": "96800ca682f2d37a018335c39ee102fb",
"roleName": "员工",
"schoolTypeId": "381098618670546946",
"schoolTypeName": "研发",
"subjectId": "381098619383578659",
"subjectName": "培训",
"departmentNames": "小鱼易连",
"description": "",
"customFields": [
{
"dataFieldId": "820312803842719745",
"fieldId": "807290927579136000",
"fieldName": "字段名称",
"fieldValue": "字段值"
}
]
},
"conferenceNumber": "90000000"
}
返回参数说明
参数名称 | 说明 |
teacher | 员工基本数据 |
teacherId | 员工id |
name | 员工姓名 |
phone | 电话号码 |
mailbox | 邮箱 |
countryCode | 区号 |
profilePicture | 头像地址 |
deptIds | 所属部门id列表 |
roleId | 角色id |
roleName | 角色名称 |
schoolTypeId | 课程分类id |
schoolTypeName | 课程分类名称 |
subjectId | 子类id |
subjectName | 子类名称 |
departmentNames | 所属部门名称(英文逗号分隔) |
description | 员工简介 |
customFields | 自定义字段列表 |
dataFieldId | 自定义字段id |
fieldId | 自定义字段值id |
fieldName | 自定义字段名称 |
fieldValue | 自定义字段值 |
conferenceNumber | 个人云会议室号码 |