简要描述:
接口版本:
版本号 |
制定人 |
制定日期 |
修订日期 |
v0.1 |
dev |
2019-09-02 |
init |
请求URL:
请求方式:
认证方式:
详细可参见 开放平台API的认证说明
请求头:
参数名 |
是否必须 |
类型 |
说明 |
Content-Type |
是 |
string |
请求类型: application/json |
Date |
是 |
string |
http协议标准头 |
Authorization |
是 |
string |
hmac 签名 |
idp-open-id |
是 |
string |
用户openid |
idp-access-token |
是 |
string |
用户access_token |
sdp-app-id |
是 |
string |
应用租户ID,具体信息获取方式参见应用的sdp-app-id参数获取方式 |
请求参数:
参数名 |
是否必须 |
类型 |
默认值 |
说明 |
school_id |
是 |
long |
|
学校id |
class_id |
是 |
long |
|
年级id |
with_detail |
否 |
bool |
false |
附带详细信息 |
返回示例:
正确时返回:
[
{
"id": 0,
"account": "string",
"real_name": "string",
"nick_name": "string",
"relations": [
{
"id": "string",
"display_name": "string",
"relation": "string",
"relation_name": "string"
}
]
}
]
错误时返回:
返回参数说明:
参数名 |
类型 |
说明 |
id |
long |
家长ID |
account |
string |
帐号 |
real_name |
string |
真实姓名 |
nick_name |
string |
昵称 无昵称的情况下会自动将真实姓名写入昵称 |
relations |
array[GuardianChildrenVO] |
关系列表 |
GuardianChildrenVO
参数名 |
类型 |
说明 |
id |
long |
孩子ID |
display_name |
string |
孩子名字 |
relation |
string |
关系 mother father other grandfather grandmother grandpa_m grandma_m |
relation_name |
string |
关系名称 母亲 父亲 其他 爷爷 奶奶 姥爷 姥姥 |