logo（反白）-09.png)
學(xué)員管理
注： 所有接口只針對(duì)企業(yè)會(huì)員提供，非企業(yè)會(huì)員無(wú)法調(diào)用
學(xué)員管理接口提供了添加、修改、刪除考生信息的功能，具體接口信息如下
添加學(xué)員
通過(guò)該接口，可以添加一個(gè)或多個(gè)學(xué)員。
接口如下所示：
POST http://www.paigood.com.cn/api/student/add參數(shù)：
token=權(quán)限碼
students=[ //學(xué)員數(shù)組，每個(gè)元素對(duì)象代表一個(gè)學(xué)員
{ //代表一個(gè)考生信息對(duì)象
"gid": 11, //學(xué)員所屬組的id
"fields": [ //學(xué)員信息
{
"sFid": 1, // 學(xué)員字段id，int類型，該值可通過(guò)"獲取學(xué)員信息字段"API獲取，如"手機(jī)"字段id為4, 姓名字段為1
"value":"王二" //學(xué)員字段的值，如sFid的值為1，這里則填寫(xiě)姓名
},
]
},
]
參數(shù)說(shuō)明：
- token每個(gè)賬戶唯一對(duì)應(yīng)的驗(yàn)證碼，string類型，該值可聯(lián)系好智學(xué)獲取
- students 表示要添加的學(xué)員信息， 其中g(shù)id表示這個(gè)學(xué)員要加入到哪個(gè)組，如果是多個(gè)組，請(qǐng)用逗號(hào)分隔的字符串表示。 fields表示學(xué)員的信息項(xiàng)
該接口返回成功添加的學(xué)員sid
{
"status": "ok", //成功返回 ok，失敗返回 error
"success": [ //成功添加的數(shù)據(jù)，每個(gè)元素都是對(duì)象，sid表示學(xué)員id, index表示要添加學(xué)員的數(shù)據(jù)索引
{
"sid":123,
"index":1
},
{
"sid":125,
"index":2
}
],
"fail": [3,4,5] //fail表示失敗的學(xué)員索引
}
刪除學(xué)員
通過(guò)該接口，可以刪除一個(gè)或多個(gè)學(xué)員。
接口如下所示：
POST http://www.paigood.com.cn/api/student/delete
參數(shù)：
token=權(quán)限碼 sids=["139", "392", "193", "932"] //學(xué)員的ID列表
參數(shù)說(shuō)明：
- token每個(gè)賬戶唯一對(duì)應(yīng)的驗(yàn)證碼，string類型，該值可聯(lián)系好智學(xué)獲取
- sids 表示要?jiǎng)h除的學(xué)員的ID列表
該接口返回成功
{
"status": "ok" //成功返回 ok，失敗返回 error
}
移動(dòng)學(xué)員到組?
使用該接口移動(dòng)一個(gè)或多個(gè)學(xué)員到一個(gè)或多個(gè)組。 接口如下所示：
POST http://www.paigood.com.cn/api/student/move
參數(shù)：
code=權(quán)限碼
mvStuInfo={
"gids": [22,33], //如果gids里有多個(gè)值，則表示把學(xué)員添加到這些組（PS 一個(gè)學(xué)員允許同時(shí)存在多個(gè)組)
"sids": [2213,3910] //學(xué)員ID，學(xué)員id
"action": "addto|moveto" //操作， addto表示添加到組，這個(gè)時(shí)候一個(gè)學(xué)員可能存在多個(gè)組， moveto表示移動(dòng)到組，這個(gè)時(shí)候?qū)W員只存在一個(gè)組。如果action值為moveto,則gids只能為一個(gè)，如果有多個(gè)gid, 只取第一個(gè)
}
參數(shù)說(shuō)明：
- token每個(gè)賬戶唯一對(duì)應(yīng)的驗(yàn)證碼，string類型，該值可聯(lián)系好智學(xué)獲取
- mvStuInfo 表示要移動(dòng)的數(shù)據(jù)信息
該接口返回成功添加的學(xué)員sid
{
"status": "ok", //成功返回 ok，失敗返回 error
"success": [1,2], //表示成功的學(xué)員的sid或登錄值
"fail": [3,4,5] //fail表示失敗的學(xué)員sid或登錄值
}
失敗則返回：
{
"status": "error", //成功返回 ok，失敗返回 error
"error": "無(wú)效的sid" //error為失敗的錯(cuò)誤信息
}
修改學(xué)員信息
通過(guò)該接口，可以修改一個(gè)或多個(gè)學(xué)員的信息
接口如下所示
POST http://www.paigood.com.cn/api/student/update
參數(shù)：
token=權(quán)限碼
stuInfo=[ //學(xué)員數(shù)組，每個(gè)元素對(duì)象代表一個(gè)學(xué)員
{ //代表一個(gè)學(xué)員信息對(duì)象
"sid": 11, //學(xué)員id，id和登錄值不能同時(shí)為空，必須填寫(xiě)一個(gè)
"loginValue":"小明" //學(xué)員登錄值，id和登錄值不能同時(shí)為空，必須填寫(xiě)一個(gè)
"fields": [ //學(xué)員信息
{
"sFid": 1, // 學(xué)員字段id，int類型，該值可通過(guò)"獲取學(xué)員信息字段"API獲取，如"手機(jī)"字段id為4, 姓名字段為1
"value":"王二" //學(xué)員字段的值，如sFid的值為1，這里則填寫(xiě)姓名
},
]
},
]
參數(shù)說(shuō)明：
- token 每個(gè)賬戶唯一對(duì)應(yīng)的驗(yàn)證碼，string類型，該值可聯(lián)系好智學(xué)獲取
- stuInfo 表示要更新的學(xué)員信息， sid表示學(xué)員ID, loginValue表示
學(xué)員登錄值， fields表示學(xué)員的字段信息
該接口返回成功修改的學(xué)員sid
{
"status": "ok", //成功返回 ok，失敗返回 error
"success": [1,2], //表示成功的學(xué)員id或登錄值
"fail": [3,4,5] //fail表示失敗的學(xué)員id或登錄值
}
字段管理?
獲取學(xué)員字段信息， 接口如下：
GET http://www.paigood.com.cn/api/student/fields
請(qǐng)求數(shù)據(jù)
token=權(quán)限碼
- token 每個(gè)賬戶唯一對(duì)應(yīng)的驗(yàn)證碼，string類型，該值可聯(lián)系好智學(xué)獲取
返回?cái)?shù)據(jù)：
[
{
"sFid":1,// 字段id，int類型
"label": "姓名", //字段標(biāo)題， string類型
"isLoginField": false, //是否為登錄字段，只能存在一個(gè)登錄字段，不存在或等于false為普通字段，boolean類型
}
]
正常返回的數(shù)據(jù)如下：
[
{
"sFid": 1,
"label": "姓名"
},
{
"sFid": 2,
"label": "性別"
},
{
"sFid": 4,
"label": "手機(jī)"
},
{
"sFid": 5,
"label": "身份證"
},
{
"sFid": 10,
"label": "密碼"
},
//以上字段為系統(tǒng)默認(rèn)字段，實(shí)際可能存在更多字段，請(qǐng)以實(shí)際獲取的對(duì)象為準(zhǔn)
...
]
字段的添加和修改請(qǐng)到系統(tǒng)的學(xué)員管理中處理