用戶信息

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"}