注： 所有接口只針對企業(yè)會員提供，非企業(yè)會員無法調(diào)用

同步學(xué)員數(shù)據(jù)可以方便的在系統(tǒng)之間進(jìn)行學(xué)員數(shù)據(jù)交換，避免手動可能出現(xiàn)的錯誤；自動同步及時快捷，即可以同步學(xué)員信息也可以同步學(xué)員的組織結(jié)構(gòu)。

添加分組

添加考生分組的接口如下：

POST http://www.paigood.com.cn/api/group/new

參數(shù)：

token=權(quán)限碼&title=組標(biāo)題&parentGid=0

參數(shù)說明

• token 每個賬戶唯一對應(yīng)的驗證碼，string類型，該值可聯(lián)系好智學(xué)獲取
• title 組的標(biāo)題
• parentGid 父組的ID, 如果為0表示創(chuàng)建的是根分組， 如果大于0,表示創(chuàng)建該組下的一個子組

如果操作成功，則返回

{
    "status": "ok", //ok表示成功， error表示錯誤
    "gid": 1931 //gid表示新創(chuàng)建的組的ID
}

如果操作失敗，則返回

{
    "status": "error",
    "error": "標(biāo)題不能為空" //創(chuàng)建出錯時的錯誤信息
}

編輯組

該接口用于編輯現(xiàn)有組的名稱，接口如下：

POST http://www.paigood.com.cn/api/group/rename

參數(shù)：

token=權(quán)限碼&title=組標(biāo)題&gid=0

參數(shù)說明

• token 每個賬戶唯一對應(yīng)的驗證碼，string類型，該值可聯(lián)系好智學(xué)獲取
• title 組的新標(biāo)題
• gid 要修改組的ID, 要求大于0

如果操作成功，則返回

{
    "status": "ok", //ok表示成功， error表示錯誤
    "gid": 1931, //gid表示組的ID
    "oldTitle": "數(shù)學(xué)1" //表示原組的標(biāo)題
}

如果操作失敗，則返回

{
    "status": "error",
    "error": "標(biāo)題不能為空" //創(chuàng)建出錯時的錯誤信息
}

刪除組

該接口用于刪除某一個組，接口如下：

POST http://www.paigood.com.cn/api/group/delete

參數(shù)：

 token =權(quán)限碼&gid=231

參數(shù)說明

• token 每個賬戶唯一對應(yīng)的驗證碼，string類型，該值可聯(lián)系好智學(xué)獲取
• gid 要被刪除的組的ID, 要求大于0

如果操作成功，則返回

{
    "status": "ok", //ok表示成功， error表示錯誤
}

如果操作失敗，則返回

{
    "status": "error",
    "error": "不正確的組ID, 請確認(rèn)是否有權(quán)限修改該組的信息" //創(chuàng)建出錯時的錯誤信息
}

移動組

移動組用于把一個組移動成另一個組的子組， 接口如下

POST http://www.paigood.com.cn/api/group/move

參數(shù)：

token=權(quán)限碼&gid=112&mvToGid=23

參數(shù)說明

• token 每個賬戶唯一對應(yīng)的驗證碼，string類型，該值可聯(lián)系好智學(xué)獲取
• gid 要被移動的組的ID, 要求大于0
• mvToGid 要移動到的組ID

如果操作成功，則返回

{
    "status": "ok", //ok表示成功， error表示錯誤
}

表示已經(jīng)把 gid 移動到 mvToGid 下并成為其的一個子組了

如果操作失敗，則返回

{
    "status": "error",
    "error": "不正確的組ID, 請確認(rèn)是否有權(quán)限修改該組的信息" //創(chuàng)建出錯時的錯誤信息
}

獲取組列表

返回某一組（或所有組）下所有子組信息， 接口如下

GET http://www.paigood.com.cn/api/group/list

參數(shù)：

 token =權(quán)限碼&gid=112

token=權(quán)限碼&gid=112

參數(shù)說明

• token每個賬戶唯一對應(yīng)的驗證碼，string類型，該值可聯(lián)系好智學(xué)獲取
• gid 可選參數(shù)， 如果設(shè)置了該參數(shù)，則列出的是該組下的所有子組的信息。如果gid為0或者沒有設(shè)置，則表示列出所有根路徑下的組數(shù)據(jù)

如果操作成功，則返回

{
    "status": "ok", //ok表示成功， error表示錯誤，
    "data": [
        {
            "gid": 1312, //組ID
            "title": "組標(biāo)題", //組的標(biāo)題
        },
        {
            "gid": 1332, //組ID
            "title": "組標(biāo)題", //組的標(biāo)題
        }
        ...
    ]
}

如果操作失敗，則返回

{
    "status": "error",
    "error": "不正確的組ID, 請確認(rèn)是否有權(quán)限修改該組的信息" //創(chuàng)建出錯時的錯誤信息
}