# 账号类APIs(GRAPHQL版本)
本组API用于获取账号相关信息。
# 申请
申请账号类API接口,请通过数据资源申请流程 (opens new window)完成申请。
# 账号信息
- POST https://graphql.sjtu.edu.cn/graphql 客户端 exchange_data
# 请求体
POST https://graphql.sjtu.edu.cn/graphql?access_token=#{access_token} HTTP/1.1
Content-Type: application/json;charset=UTF-8
{
"query": "{ IDENTITY_AUTH_ACCOUNT{ ACCOUNT_NO GUID DISPLAY_NAME ACCOUNT_STATUS IDENTITY_EXPIRE_DATE USER_STYLE USER_ID CARD_TYPE CARD_NO TELEPHONE EMAIL UPDATE_TIMESTAMP:timestamp P_ORGANIZE_ID P_ORGANIZE_NAME RELATION_LIST{ GUID USER_STYLE USER_ID EXPIRE_DATE CARD_NO CARD_TYPE P_ORGANIZE_ID P_ORGANIZE_NAME } } }"
}
1
2
3
4
5
6
2
3
4
5
6
# 请求体参数
动态参数 | 类型 | 必填 | 参数说明 |
---|---|---|---|
ACCOUNT_NO | string | 否 | 查询的jAccount账号 |
USER_ID | string | 否 | 需要查询的学工号 |
P_ORGANIZE_ID | string | 否 | 需要查询的二级部门代码 |
timestamp | string | 否 | 根据更新时间查询(yyyy-MM-dd/yyyy-MM-dd HH:mm:ss) |
first | int | 否 | 分页起始位置 |
offset | string | 否 | 分页偏移量 |
示例 根据jAccount查询
//ACCOUNT_NO作为查询条件;对于查询参数是字符串,在GraphQL语句中需要添加双引号
{
"query": "{ IDENTITY_AUTH_ACCOUNT(filter : {ACCOUNT_NO:{eq:\"zhangsan\"}}){ ACCOUNT_NO GUID DISPLAY_NAME ACCOUNT_STATUS IDENTITY_EXPIRE_DATE USER_STYLE USER_ID CARD_TYPE CARD_NO TELEPHONE EMAIL UPDATE_TIMESTAMP:timestamp P_ORGANIZE_ID P_ORGANIZE_NAME RELATION_LIST{ USER_STYLE USER_ID EXPIRE_DATE CARD_NO CARD_TYPE P_ORGANIZE_ID P_ORGANIZE_NAME } } }"
}
1
2
3
4
5
2
3
4
5
# 响应参数
所有数据资源API响应参数都有相同的通用结构
- 账号信息 Structure
{
"ACCOUNT_NO":{string} //jAccount
"GUID":{string} //GUID
"DISPLAY_NAME":{string} //姓名
"ACCOUNT_STATUS":{string} //账号状态(正常、过期、冻结)
"IDENTITY_EXPIRE_DATE":{string} //默认身份有效期(yyyy-MM-dd)
"USER_STYLE":{string} //身份类型
"USER_ID":{string} //学工号
"CARD_TYPE":{string} //证件类型
"CARD_NO":{string} //证件号
"TELEPHONE":{string} //联系方式
"EMAIL":{string} //邮箱
"P_ORGANIZE_ID":{string} //二级单位代码
"P_ORGANIZE_NAME":{string} //二级单位名称
"UPDATE_TIMESTAMP":{string} //更新时间
"RELATION_LIST":[{
"USER_STYLE":{string} //身份类型
"USER_ID":{string} //学工号
"EXPIRE_DATE":{string} //身份有效期(yyyy-MM-dd)
"CARD_TYPE":{string} //证件类型
"CARD_NO":{string} //证件号码
"P_ORGANIZE_ID":{string} //二级单位代码
"P_ORGANIZE_NAME":{string} //二级单位名称
}]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# 响应示例
示例 成功返回的数据
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"errcode": 0,
"data": {
"IDENTITY_AUTH_ACCOUNT": [
{
"ACCOUNT_NO": "zhangsan",
"GUID": "28A42245-7435-499C-B2B7-xxxxxxx",
"DISPLAY_NAME": "张三",
"ACCOUNT_STATUS": "正常",
"IDENTITY_EXPIRE_DATE": "2023-07-31",
"USER_STYLE": "faculty",
"USER_ID": "xxxxx",
"CARD_TYPE": "01",
"CARD_NO": "31011119920311xxxx",
"TELEPHONE": "",
"EMAIL": "testprofile@sjtu.edu.cn",
"P_ORGANIZE_ID": "40100",
"P_ORGANIZE_NAME": "网络信息中心",
"UPDATE_TIMESTAMP": "2022-08-19 00:00:00",
"RELATION_LIST":[{
"USER_STYLE": "faculty",
"USER_ID": "xxxxx",
"EXPIRE_DATE": "2023-07-31",
"CARD_TYPE": "01",
"CARD_NO": "31011119920311xxxx",
"P_ORGANIZE_ID": "40100",
"P_ORGANIZE_NAME": "网络信息中心"
}]
}
]
},
"errors": null,
"total": 1
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
- USER_STYLE身份类型列表 Data
Value | Description |
---|---|
faculty | 教职工 |
student | 学生 |
yxy | 医学院教职工 |
fsyyjzg | 附属单位职工 |
vip | vip |
postphd | 博士后 |
external_teacher | 外聘教师 |
summer | 暑期生 |
team | 集体账号 |
schoolFellow | 校友 |
green | 绿色通道 |
outside | 合作交流 |
fszxjs | 附属中学教师 |
freshman | 新生 |
- CARD_TYPE证件类型列表 Data
Value | Description |
---|---|
01 | 身份证 |
02 | 户口簿 |
03 | 护照 |
04 | 军官证 |
05 | 士兵证 |
06 | 港澳居民来往内地通行证 |
07 | 台湾居民来往大陆通行证 |
08 | 临时身份证 |
09 | 外国人居留证 |
10 | 警官证 |
11 | 其他证件 |
12 | 港澳台居民居住证 |
13 | 外籍人士中国永居证 |
14 | 外国人工作许可证 |
15 | 港澳台身份证 |