# 账号类APIs

本组API用于获取账号相关信息。

  • 使用本组API前请先阅读概述,令牌的获取参考此处,构造请求请参考此处,返回数据请参考此处,除非特殊注明,所有数据资源API有着通用的返回结构
  • 账号类基于GraphQL协议老版本接口说明请参考此处

# 申请

申请账号类API接口,请通过数据资源申请流程 (opens new window)完成申请。

# 账号信息

# 请求参数

参数名 类型 必填 参数说明
accountNo string jAccount账号
userId string 学工号
displayName string 姓名
topOrganizeId string 二级部门代码
cardNo string 证件号
userStyle string 默认身份类型 (见下方代码表)
accountStatus string 账号状态(正常/过期/冻结)
timestamp string 更新时间(yyyy-MM-dd/yyyy-MM-dd HH:mm:ss),取大于等于该时间戳的数据
first int 分页起始位置 分页参数说明
offset int 分页偏移量

# 响应参数

所有数据资源API响应参数都有相同的通用结构

  • 账号信息 Structure
{
    "accountNo":{string}                                 //jAccount
    "guid":{string}                                      //GUID
    "displayName":{string}                               //姓名
    "accountStatus":{string}                             //账号状态(正常、过期、冻结)
    "identityExpireDate":{string}                        //默认身份有效期(yyyy-MM-dd)
    "userStyle":{string}                                 //身份类型
    "userId":{string}                                    //学工号
    "cardType":{string}                                  //证件类型
    "cardNo":{string}                                    //证件号
    "telephone":{string}                                 //联系方式
    "email":{string}                                     //邮箱
    "topOrganizeId":{string}                             //二级单位代码
    "topOrganizeName":{string}                           //二级单位名称
    "timestamp":{string}                                 //更新时间
    
    "relationList":[{
        "userStyle":{string}                             //身份类型
        "userId":{string}                                //学工号
        "expireDate":{string}                            //身份有效期(yyyy-MM-dd)
        "cardType":{string}                              //证件类型
        "cardNo":{string}                                //证件号码
        "topOrganizeId":{string}                         //二级单位代码
        "topOrganizeName":{string}                       //二级单位名称
        "scbj":{string}                                  //删除标记("Y":已删除,"N":未删除)
    }]
}
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

# 请求示例

GET /v1/account/info?access_token=token HTTP/1.1
Host: graphql.sjtu.edu.cn

accountNo=zhangsan&topOrganizeId=40100
1
2
3
4

# 响应示例


示例 成功返回的数据
HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
	"errno": 0,
	"error": null,
	"total": 1,
	"entities": [{
		"accountNo": "zhangsan",
		"guid": "28A42245-7435-499C-B2B7-xxxxxxx",
		"displayName": "张三",
		"accountStatus": "正常",
		"identityExpireDate": "2023-07-31",
		"userStyle": "faculty",
		"userId": "xxxxx",
		"cardType": "01",
		"cardNo": "31011119920311xxxx",
		"telephone": "",
		"email": "testprofile@sjtu.edu.cn",
		"topOrganizeId": "40100",
		"topOrganizeName": "网络信息中心",
		"timestamp": "2022-08-19 00:00:00",
		"relationList": [{
			"userStyle": "faculty",
			"userId": "xxxxx",
			"expireDate": "2023-07-31",
			"cardType": "01",
			"cardNo": "31011119920311xxxx",
			"topOrganizeId": "40100",
			"topOrganizeName": "网络信息中心",
			"scbj": "N"
		}]
	}]
}
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
  • userStyle身份类型列表 Data
Value Description
faculty 教职工
student 学生
yxy 医学院教职工
fsyyjzg 附属单位职工
vip vip
postphd 博士后
external_teacher 外聘教师
summer 暑期生
team 集体账号
schoolFellow 校友
green 绿色通道
outside 合作交流
fszxjs 附属中学教师
freshman 新生
  • cardType证件类型列表 Data
Value Description
01 身份证
02 户口簿
03 护照
04 军官证
05 士兵证
06 港澳居民来往内地通行证
07 台湾居民来往大陆通行证
08 临时身份证
09 外国人居留证
10 警官证
11 其他证件
12 港澳台居民居住证
13 外籍人士中国永居证
14 外国人工作许可证
15 港澳台身份证