一、基本信息
接口名称:获取全校家长信息
接口说明:通过接口获取家长信息,包括家长与学生之间关系信息
请求地址:${BASEURL}/dataconnectorserv/integration/basic/getParents
请求方式:POST
请求类型:application/json
接口频率:接口调用上限500次/天
接口版本:3.0
修改日期:2023-12-05
二、请求参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| appKey | String | 是 | 平台提供的唯一标识 |
| schoolID | String | 是 | 学校ID,从学校列表获取 |
{
"appKey": "36s2zllw",
"schoolID": "wca5opSRt2tyyBSLqOjdoS=="
}
三、响应结果
| 响应参数名称 | 响应参数类型 | 是否有值 | 说明 |
|---|---|---|---|
| parents | Array | 是 | 家长列表 |
| loginName | String | 是 | 登录名,手机号登录 |
| parentEID | String | 是 | 家长EID,EID可切换1.平台ID,2.登录名,3.第三方厂商ID |
| parentName | String | 是 | 家长姓名 |
| parentRole | String | 是 | 家长角色:father: 爸爸,mother: 妈妈,grandfather: 爷爷,grandmother: 奶奶,grandpa: 姥爷,grandma: 姥姥,otherGuardian: 其他监护人 |
| phone | String | 是 | 家长手机号 |
| students | Array | 否 | 学生列表 |
| studentName | String | 否 | 学生姓名 |
| studentEID | String | 否 | 学生EID |
| updateTime | String | 是 | 更新时间(格式化UTC时间,比北京时间早8小时,UTC+时区差=本地时间) |
{
"code": 0,
"status": "success",
"result": {
"parents": [
{
"loginName": "13308336955",
"parentEID": "13308336955",
"parentName": "张五哥",
"parentRole": "father",
"phone": "13308336955",
"students": [
{
"studentName": "张继元",
"studentEID": "5132022039"
}
],
"updateTime": "2023-04-26T14:11:28Z"
},
{
"loginName": "15532781328",
"parentEID": "15532781328",
"parentName": "王大锤",
"parentRole": "otherGuardian",
"phone": "15532781328",
"students": [],
"updateTime": "2022-10-18T07:23:28Z"
}
]
}
}