用户信息,考试云|帮助文档

用户信息

1、用户同步

2、获取用户积分

用户同步

通过此接口可实现考生信息的批量新增，更新操作，保持考试云与第三方系统的用户信息同步。

接口地址：https://api.kaoshiyun.com.cn/api/v5/useraction.ashx?token=[Token]&action=updateUser&userJSON=[userJSON]

提醒：请在服务端发起接口请求，以保护账号信息安全。

请求方式：GET或POST

参数说明:

参数名称	说明
token	接口调用凭证，2小时内有效，请注意时效性
action	updateUser
userJSON	用户信息JSON格式，可单个或批量更新注意： 1、在更新操作时，遵循：有则更新，无则新增的原则，即：通过登录账号account判断考试云系统是否存在，如果存在则更新用户信息，如果不存在则新增用户信息。 2、通过URL传userJSON时，如果有特殊字符格式须对其编码(UrlEncode或escape等)传输。

userJSON参数格式：

[
  {
    "account": "0001",
    "password": "abcde",
    "userName": "张萱",
    "fullDeptName": "考试云/研发中心/测试部",
    "sex": "女",
    "mobile": "13800000000",
    "email": "zx0001@zcth.cn",
    "cardNo": "4301281998020333212",
    "status": "Normal",
    "thirdID": "第三方系统的用户主键编号，可用于后期获取成绩时判断用户"
  },
  {
    "account": "0002",
    "password": "qwerty",
    "userName": "李健",
    "fullDeptName": "考试云/研发中心/开发部",
    "sex": "男",
    "mobile": "15800000000",
    "email": "lj0002@zcth.cn",
    "cardNo": "430128198807190202",
    "status": "Disabled",
    "thirdID": "第三方系统的用户主键编号，可用于后期获取成绩时判断用户"
  }
]

userJOSN参数说明

参数名称	说明	允许为空
account	登录账号	否
password	登录密码（明文），如果是免密单点登录，可不传密码值	是
userName	姓名	否
fullDeptName	账号所属组织，全路径，以/分隔，如：考试云/研发中心/测试部。如果为空，则所有账号归类在考试云根结点下。	是
sex	性别，值为：男、女	是
mobile	手机号码	是
email	邮箱	是
cardNo	证件号码	是
status	Normal 或 Disabled , Normal代表激活可正常登录使用，Disabled代表禁用不可登录（如离职、删除账号时可设置为Disabled）。不传值默认为Normal	是
thirdID	第三方系统的用户主键编号(若传值必须唯一)，后期通过此值判断用户信息同步的唯一性。	是

返回值说明：

1、执行成功，返回值

{"okCount":2,"failCount":0,"msg":"ok"}

参数名称	说明
okCount	执行成功的记录数
failCount	执行失败的记录数
msg	返回消息，如果全部执行成功，返回值:OK，如果部分执行成功，返回未成功原因。

2、执行失败，返回值

{"errcode":"40006","errmsg":"AccessToken has expired"}

{"errcode":"40101","errmsg":"userJSON param is empty"}

{"errcode":"40102","errmsg":"userList参数，解析Json出错，请检查格式"}

{"errcode":"40103","errmsg":"获取根组织目录失败，请登录考试云初始化组织数据"}

获取用户积分

获取用户所得积分信息，如考生基本信息、总积分，积分排名，各类积分（考试积分、练习积分、培训积分）。

接口地址：https://api.kaoshiyun.com.cn/api/v5/userintegral.ashx?token=[Token]&action=getUserIntegral&pageIndex=[pageIndex]&pageSize=[pageSize]

请求方式：GET或POST

参数说明:

参数名称	说明
token	接口调用凭证，2小时内有效，请注意时效性
action	getUserIntegral
pageIndex	分页页码，默认第1页
pageSize	每页条数，默认1000条

返回值说明：

1、执行成功

JSON返回值格式

{
  "totalCount": 530,
  "pageSize": 1000,
  "currentPageIndex": 1,
  "items": [
    {
      "account": "c089d6",
      "userName": "陈翰林",
      "deptName": "销售部",
      "fullDeptName": "考试云/销售中心/销售部",
      "totalIntegral": "100",
      "examIntegral": "70",
      "exerIntegral": "10",
      "lessonIntegral": "30",
      "integralRank": "1"
    },
    {
      "account": "c089d6",
      "userName": "李一鸣",
      "deptName": "技术部",
      "fullDeptName": "考试云/研发中心/开发部",
      "gradeID": "28e4bea1f2904c15814d0b6cca39457d",
      "totalIntegral": "90",
      "examIntegral": "60",
      "exerIntegral": "15",
      "lessonIntegral": "15",
      "integralRank": "2"
    }
  ]
}

返回值参数说明：

参数名称	说明
totalCount	总记录数
pageSize	每页条数，默认1000条
currentPageIndex	当前页码
account	考生账号
userName	考生姓名
deptName	所属部门
fullDeptName	部门全路径
totalIntegral	总积分
examIntegral	考试积分
exerIntegral	练习积分
lessonIntegral	课程积分
integralRank	积分排名

2、执行失败，返回值

{"errcode":"40006","errmsg":"AccessToken has expired"}