用戶信息
1、用戶同步
2、獲取用戶積分
用戶同步
通過(guò)此接口可實(shí)現(xiàn)考生信息的批量新增,更新操作,保持考試云與第三方系統(tǒng)的用戶信息同步。
接口地址:https://api.kaoshiyun.com.cn/api/v5/useraction.ashx?token=[Token]&action=updateUser&userJSON=[userJSON]
提醒:請(qǐng)?jiān)诜?wù)端發(fā)起接口請(qǐng)求,以保護(hù)賬號(hào)信息安全。
請(qǐng)求方式:GET或POST
參數(shù)說(shuō)明:
參數(shù)名稱 | 說(shuō)明 |
token | 接口調(diào)用憑證,2小時(shí)內(nèi)有效,請(qǐng)注意時(shí)效性 |
action | updateUser |
userJSON | 用戶信息JSON格式,可單個(gè)或批量更新 注意: 1、在更新操作時(shí),遵循:有則更新,無(wú)則新增 的原則,即:通過(guò)登錄賬號(hào)account判斷考試云系統(tǒng)是否存在,如果存在則更新用戶信息,如果不存在則新增用戶信息。 2、通過(guò)URL傳userJSON時(shí),如果有特殊字符格式須對(duì)其編碼(UrlEncode或escape等)傳輸。 |
userJSON參數(shù)格式:
[
{
"account": "0001",
"password": "abcde",
"userName": "張萱",
"fullDeptName": "考試云/研發(fā)中心/測(cè)試部",
"sex": "女",
"mobile": "13800000000",
"email": "zx0001@zcth.cn",
"cardNo": "4301281998020333212",
"status": "Normal",
"thirdID": "第三方系統(tǒng)的用戶主鍵編號(hào),可用于后期獲取成績(jī)時(shí)判斷用戶"
},
{
"account": "0002",
"password": "qwerty",
"userName": "李健",
"fullDeptName": "考試云/研發(fā)中心/開發(fā)部",
"sex": "男",
"mobile": "15800000000",
"email": "lj0002@zcth.cn",
"cardNo": "430128198807190202",
"status": "Disabled",
"thirdID": "第三方系統(tǒng)的用戶主鍵編號(hào),可用于后期獲取成績(jī)時(shí)判斷用戶"
}
]userJOSN參數(shù)說(shuō)明
參數(shù)名稱 | 說(shuō)明 | 允許為空 |
account | 登錄賬號(hào) | 否 |
password | 登錄密碼(明文),如果是免密單點(diǎn)登錄,可不傳密碼值 | 是 |
userName | 姓名 | 否 |
fullDeptName | 賬號(hào)所屬組織,全路徑,以/分隔,如:考試云/研發(fā)中心/測(cè)試部。如果為空,則所有賬號(hào)歸類在考試云根結(jié)點(diǎn)下。 | 是 |
sex | 性別,值為:男、女 | 是 |
mobile | 手機(jī)號(hào)碼 | 是 |
郵箱 | 是 | |
cardNo | 證件號(hào)碼 | 是 |
status | Normal 或 Disabled , Normal代表激活可正常登錄使用,Disabled代表禁用不可登錄(如離職、刪除賬號(hào)時(shí)可設(shè)置為Disabled)。 不傳值默認(rèn)為Normal | 是 |
thirdID | 第三方系統(tǒng)的用戶主鍵編號(hào)(若傳值必須唯一),后期通過(guò)此值判斷用戶信息同步的唯一性。 | 是 |
返回值說(shuō)明:
1、執(zhí)行成功,返回值
{"okCount":2,"failCount":0,"msg":"ok"}參數(shù)名稱 | 說(shuō)明 |
okCount | 執(zhí)行成功的記錄數(shù) |
failCount | 執(zhí)行失敗的記錄數(shù) |
msg | 返回消息,如果全部執(zhí)行成功,返回值:OK,如果部分執(zhí)行成功,返回未成功原因。
|
2、執(zhí)行失敗,返回值
{"errcode":"40006","errmsg":"AccessToken has expired"}{"errcode":"40101","errmsg":"userJSON param is empty"}{"errcode":"40102","errmsg":"userList參數(shù),解析Json出錯(cuò),請(qǐng)檢查格式"}{"errcode":"40103","errmsg":"獲取根組織目錄失敗,請(qǐng)登錄考試云初始化組織數(shù)據(jù)"}獲取用戶積分
獲取用戶所得積分信息,如考生基本信息、總積分,積分排名,各類積分(考試積分、練習(xí)積分、培訓(xùn)積分)。
接口地址:https://api.kaoshiyun.com.cn/api/v5/userintegral.ashx?token=[Token]&action=getUserIntegral&pageIndex=[pageIndex]&pageSize=[pageSize]
請(qǐng)求方式:GET或POST
參數(shù)說(shuō)明:
參數(shù)名稱 | 說(shuō)明 |
token | 接口調(diào)用憑證,2小時(shí)內(nèi)有效,請(qǐng)注意時(shí)效性 |
action | getUserIntegral |
pageIndex | 分頁(yè)頁(yè)碼,默認(rèn)第1頁(yè) |
pageSize | 每頁(yè)條數(shù),默認(rèn)1000條 |
返回值說(shuō)明:
1、執(zhí)行成功
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": "技術(shù)部",
"fullDeptName": "考試云/研發(fā)中心/開發(fā)部",
"gradeID": "28e4bea1f2904c15814d0b6cca39457d",
"totalIntegral": "90",
"examIntegral": "60",
"exerIntegral": "15",
"lessonIntegral": "15",
"integralRank": "2"
}
]
}返回值參數(shù)說(shuō)明:
參數(shù)名稱 | 說(shuō)明 |
totalCount | 總記錄數(shù) |
pageSize | 每頁(yè)條數(shù),默認(rèn)1000條 |
currentPageIndex | 當(dāng)前頁(yè)碼 |
account | 考生賬號(hào) |
userName | 考生姓名 |
deptName | 所屬部門 |
fullDeptName | 部門全路徑 |
totalIntegral | 總積分 |
examIntegral | 考試積分 |
exerIntegral | 練習(xí)積分 |
lessonIntegral | 課程積分 |
integralRank | 積分排名 |
2、執(zhí)行失敗,返回值
{"errcode":"40006","errmsg":"AccessToken has expired"}