考生數據管理¶
優考試已發布新的api接口，請用戶們點擊查看新的考生數據管理（點擊跳轉新考生數據管理）
注： 所有接口只針對旗艦會員提供，非旗艦會員無法調用，所有開放平臺接口默認共享10QPS
字段管理¶
獲取考生字段信息， 接口如下：
GET https://admin.kyexam.com/index.php?option=com_exams&task=api.getStudentFields&format=raw
code=權限碼
- code 每個賬戶唯一對應的驗證碼，string類型，該值可聯系優考試獲取
返回數據：
[
{
"sFid":1,// 字段id，int類型
"label": "姓名", //字段標題， string類型
"isLoginField": false, //是否為登錄字段，只能存在一個登錄字段，不存在或等于false為普通字段，boolean類型
}
]
正常返回的數據如下：
[
{
"sFid": 1,
"sLabel": "姓名"
},
{
"sFid": 2,
"sLabel": "性別"
},
{
"sFid": 4,
"sLabel": "手機"
},
{
"sFid": 5,
"sLabel": "身份證"
},
{
"sFid": 10,
"sLabel": "密碼"
},
//以上字段為系統默認字段，實際可能存在更多字段，請以實際獲取的對象為準
...
]
字段的添加和修改請到系統的考生管理中處理
考生管理¶
考生管理接口提供了添加、修改、刪除考生信息的功能，具體接口信息如下
添加考生¶
通過該接口，可以添加一個或多個考生。
接口如下所示：
POST https://admin.kyexam.com/index.php?option=com_exams&task=api.addStudentsV2&format=raw
參數：
code=權限碼
students=[ //考生數組，每個元素對象代表一個考生
{ //代表一個考生信息對象
"gid": 11, //考生所屬組的id
"fields": [ //考生信息
{
"sFid": 1, // 考生字段id，int類型，該值可通過"獲取考生信息字段"API獲取，如"手機"字段id為4, 姓名字段為1
"value":"王二" //考生字段的值，如sFid的值為1，這里則填寫姓名
},
...
{
"sFid": 4, // 考生字段id，int類型，該值可通過"獲取考生信息字段"API獲取，如"手機"字段id為4, 姓名字段為1
"value":"13800000000" //考生字段的值，如sFid的值為4，這里則填寫手機號碼
}
]
},
...
{ //代表一個考生信息對象
"gid": 11, //考生所屬組的id
"fields": [ //考生信息
{
"sFid": 1, // 考生字段id，int類型，該值可通過"獲取考生信息字段"API獲取，如"手機"字段id為4, 姓名字段為1
"value":"張三" //考生字段的值，如sFid的值為1，這里則填寫姓名
},
...
{
"sFid": 4, // 考生字段id，int類型，該值可通過"獲取考生信息字段"API獲取，如"手機"字段id為4, 姓名字段為1
"value":"13800000001" //考生字段的值，如sFid的值為4，這里則填寫手機號碼
}
]
}
]
參數說明：
- code 每個賬戶唯一對應的驗證碼，string類型，該值可聯系優考試獲取
- students 表示要添加的考生信息， 其中gid表示這個考生要加入到哪個組，如果是多個組，請用逗號分隔的字符串表示。 fields表示考生的信息項。
該接口返回成功添加的考生sid
{
"status": "ok", //成功返回 ok，失敗返回 error
"success": [ //成功添加的數據，每個元素都是對象，sid表示考生id, index表示要添加考生的數據索引
{
"sid":123,
"index":1
},
{
"sid":125,
"index":2
}
],
"fail": [3,4,5] //fail表示失敗的考生索引
}
修改考生信息¶
通過該接口，可以修改一個或多個考生的信息
接口如下所示：
POST https://admin.kyexam.com/index.php?option=com_exams&task=api.updateStudents&format=raw
參數：
code=權限碼
stuInfo=[ //考生數組，每個元素對象代表一個考生
{ //代表一個考生信息對象
"sid": 11, //考生id，id和登錄值不能同時為空，必須填寫一個
"loginValue":"小明" //考生登錄值，id和登錄值不能同時為空，必須填寫一個
"fields": [ //考生信息
{
"sFid": 1, // 考生字段id，int類型，該值可通過"獲取考生信息字段"API獲取，如"手機"字段id為4, 姓名字段為1
"value":"王二" //考生字段的值，如sFid的值為1，這里則填寫姓名
},
]
},
]
參數說明：
- code 每個賬戶唯一對應的驗證碼，string類型，該值可聯系優考試獲取
- stuInfo 表示要更新的考生信息， sid表示考生ID, loginValue表示考生登錄值， fields表示考生的字段信息
該接口返回成功修改的考生sid或登錄值
{
"status": "ok", //成功返回 ok，失敗返回 error
"success": [1,2], //表示成功的考生id或登錄值
"fail": [3,4,5] //fail表示失敗的考生id或登錄值
}
刪除考生¶
使用該接口刪除一個或多個考生。 接口如下所示：
POST https://admin.kyexam.com/index.php?option=com_exams&task=api.delStudents&format=raw
參數：
code=權限碼
loginValues=["1000","10001"] //考生登錄值列表，字符串數組，id和登錄值二選一，優先讀取登錄值
參數說明：
- code 每個賬戶唯一對應的驗證碼，string類型，該值可聯系優考試獲取
- loginValues 表示要刪除的考生登錄值列表
該接口返回成功刪除的考生sid或登錄值
{
"status": "ok", //成功返回 ok，失敗返回 error
"success": [1,2], //表示成功的考生sid或登錄值
"fail": [3,4,5] //fail表示失敗的考生的sid或登錄值
}
失敗則返回：
{
"status": "error", //成功返回 ok，失敗返回 error
"error": "無效的sid" //error為失敗的錯誤信息
}
移動考生到組¶
使用該接口移動一個或多個考生到一個或多個組。 接口如下所示：
POST https://admin.kyexam.com/index.php?option=com_exams&task=api.mvStudents&format=raw
參數：
code=權限碼
mvStuInfo={
"gids": [22,33], //如果gids里有多個值，則表示把考生添加到這些組（PS 一個考生允許同時存在多個組)
"loginValues":["小明","小紅"] //考生登錄字段值，字符串數組
"action": "addto|moveto" //操作， addto表示添加到組，這個時候一個考生可能存在多個組， moveto表示移動到組，這個時候考生只存在一個組。如果action值為moveto,則gids只能為一個，如果有多個gid, 只取第一個
}
參數說明：
- code 每個賬戶唯一對應的驗證碼，string類型，該值可聯系優考試獲取
- mvStuInfo 表示要移動的數據信息
該接口返回成功添加的考生loginValue
{
"status": "ok", //成功返回 ok，失敗返回 error
"success": [1,2], //表示成功的考生登錄字段值
"fail": [3,4,5] //fail表示失敗的考生登錄字段值
}
失敗則返回：
{
"status": "error", //成功返回 ok，失敗返回 error
"error": "無效的sid" //error為失敗的錯誤信息
}
獲取考生信息¶
使用該接口獲取一個或多個考生的信息 接口如下所示：
POST https://admin.kyexam.com/index.php?option=com_exams&task=api.getStudentsInfo&format=raw
參數：
code=權限碼
loginValues=[13212,2382,392]
參數說明：
- code 每個賬戶唯一對應的驗證碼，string類型，該值可聯系優考試獲取
- loginValues 表示考生登錄字段值列表
一次最多只能查10個考生的信息
該接口成功則返回
{
"status": "ok", //成功返回 ok，失敗返回 error
"data": [
{
"loginValue":"王二",//考生登錄值，若請求的是loginValues,則返回loginValue
"fields":[
{
"sFid":1,
"label":"姓名",
"value": "王二"
},
{
"sFid":13,
"label":"單位",
"value": "全部門"
}
],
"group": [
"gid": 123, //組的ID
"title": "英文學習小組" //組名稱
]
},
{
"loginValue": 3925, //考生的ID
"loginValue":"張三",//考生登錄值，若請求的是loginValues,則返回loginValue
"fields":[
{
"sFid":1,
"label":"姓名",
"value": "張三"
},
{
"sFid":13,
"label":"單位",
"value": "全部門"
}
],
"group": [
"gid": 123, //組的ID
"title": "英文學習小組" //組名稱
]
}
]
}
失敗則返回：
{
"status": "error", //成功返回 ok，失敗返回 error
"error": "無效的sid" //error為失敗的錯誤信息
}
如有問題，請隨時聯系我們客服
獲取考生列表¶
使用該接口獲取考生列表 接口如下所示：
POST https://admin.kyexam.com/index.php?option=com_exams&task=api.getStudents&format=raw
參數：
code=權限碼
start=0
limit=30
參數說明：
- code 每個賬戶唯一對應的驗證碼，string類型，該值可聯系優考試獲取
- start 用于數據量很大時的分頁顯示，表示分頁的數據偏移， 默認為0， 可選參數
- limit 用于數據量很大時的分布顯示，設置每頁的數據顯示數量，默認為30， 可選參數
該接口成功則返回
{
{
"loginValue": "90068", //考生登錄字段值
"fields": [ //考生的信息項
{
"label": "姓名",
"sFid": "1",
"value": "我是從api添加的考生8888"
},
{
"label": "郵箱",
"sFid": "3",
"value": "54457@qq.com"
},
{
"label": "密碼",
"sFid": "10",
"value": "123456"
}
]
},
{
"loginValue": "90067",
"fields": [
{
"label": "姓名",
"sFid": "1",
"value": "我是從api添加的考生55555"
},
{
"label": "郵箱",
"sFid": "3",
"value": "4544@qq.com"
},
{
"label": "密碼",
"sFid": "10",
"value": "123456"
}
]
}
}
沒有考生記錄則返回：
{
"status": "ok",
"message": "empty"
}
如有問題，請隨時聯系我們客服
