开发文档-东西湖区教育云开放平台

学校信息类接口

主要使用场景：学校信息类接口

1、学校学生详情

基础需要授权

根据学校ID，学生ID获取学生的个人信息，支持增加返回需要的字段

前置条件

获取接口访问令牌：accessToken

请求说明

url	https://api.wuhaneduyun.cn/user/openapi/org/get-student-info
请求方式	post
是否需要鉴权	是
请求数限制	否
接口方向	第三方应用->开放平台

参数说明

序号	字段名	约束	类型	长度	说明
1	top_org_id	必选	string	-	学校ID
2	user_id	必选	string	-	学生ID
3	need_field	可选	array	-	增加返回的字段，见返回字段说明

返回说明

序号	字段名	约束	类型	长度	说明
1	code	必选	string	-	结果编码
2	message	必选	string	-	结果描述
3	result	必选	string	-	结果
3.1	user_id	必选	String	-	学生id
3.2	name	必选	String	-	学生姓名
3.3	user_type	必选	String	-	用户类型，0学生
3.4	phone	可选	String	-	脱敏电话号码，need_field传入phone时返回
3.5	status	必选	String	-	用户的状态(0:未激活、1:正常、2:注销、3:普通锁定、4:安管锁定)
3.6	card_type	可选	String	-	证件类型(0:身份证,1:护照)，need_field传入card_code时返回
3.7	card_code	可选	String	-	脱敏证件号码，need_field传入card_code时返回
3.8	top_org_id	必选	String	-	学校id
3.9	class_id	必选	String	-	班级id
3.10	class_name	必选	String	-	班级名称
3.11	top_school_id	必选	String	-	校区id
3.12	gender	必选	String	-	性别
3.13	family_more	可选	Array	-	更多家庭联系人，need_field传入family_more时返回
3.13.1	type	可选	String	-	与联系人的关系类型值
3.13.2	family_type_name	可选	String	-	与联系人的关系名称
3.13.3	name	可选	String	-	联系人姓名
3.13.4	phone	可选	String	-	联系人手机号
3.13.5	bind_user_id	可选	String	-	联系人用户ID
3.14	attr	可选	Array	-	更多学生成员属性(考号，学生证号等)，need_field传入attr时返回
3.14.1	student_staff_id	可选	String	-	学生证号
3.14.2	student_exam_id	可选	String	-	学生校考号
3.15	mather_name	可选	String	-	母亲姓名，need_field传入family时返回
3.16	mather_id	可选	String	-	母亲用户id，need_field传入family时返回
3.17	mother_phone	可选	String	-	母亲手机号，need_field传入family时返回
3.18	father_name	可选	String	-	父亲姓名，need_field传入family时返回
3.19	father_id	可选	String	-	父亲用户id，need_field传入family时返回
3.20	father_phone	可选	String	-	父亲手机号，need_field传入family时返回
3.21	avatar_list	可选	array	-	用户头像（1:小, 2:中, 3:大），need_field传入avatar时返回
3.22	student_exam_id	可选	String	-	考号，need_field传入student_exam_id时返回

示例

**请求示例**
{
   "top_org_id":"xxx","user_id":"xxxx","need_field":["attr"]
}
**返回示例：**
{
  "code": "000000",
  "message": "成功",
  "result": {
    "user_id": "xxxxx",
    "name": "张三",
    "gender": 0,
    "user_type": "0",
    "status": 0,
    "top_org_id": "xxxxx",
    "class_id": "xxxx",
    "class_name": "二年级5班",
    "top_school_id": "xxxxxxx",
    "attr": {
      "student_staff_id": "2023009123",
      "student_exam_id": "123456789"
    }
  },
  "_timestamp": "1718960998.2205",
  "_runtime": "0.0063"
}

开发者登录

1、学校学生详情

前置条件

请求说明

参数说明

返回说明

示例