Panduan pengembangPermintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/role/simplelist |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internalappType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-qyapi_get_department_member-Izin baca untuk pengguna departemen di Kontak |
Parameter kueri
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| access_token | String | Ya | bE74xxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini. - Untuk aplikasi internal, dapatkan melalui API untuk mendapatkan access_token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, dapatkan melalui API untuk mendapatkan access_token perusahaan pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| role_id | Number | Ya | 1203141 | ID peran. Untuk mendapatkan nilai ini, panggil API Mendapatkan daftar peran dan gunakan nilai parameter id. |
| size | Number | Tidak | 20 | Ukuran halaman. Catatan Parameter ini hanya berfungsi jika diatur bersama parameter offset. Nilai default adalah 20 dan nilai maksimum adalah 100. |
| offset | Number | Tidak | 0 | Offset paginasi. Catatan Parameter ini hanya berfungsi jika diatur bersama parameter size. Offset dimulai dari 0. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/role/simplelist" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d1812xxxxc53245' \
-d 'offset=0' \
-d 'role_id=1203141' \
-d 'size=20'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/simplelist");
OapiRoleSimplelistRequest req = new OapiRoleSimplelistRequest();
req.setRoleId(1203141L);
req.setSize(20L);
req.setOffset(0L);
OapiRoleSimplelistResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiRoleSimplelistRequest("https://api.dingtalk.io/topapi/role/simplelist")
req.role_id=1203141
req.offset=0
req.size=20
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiRoleSimplelistRequest;
$req->setRoleId("1203141");
$req->setOffset("0");
$req->setSize("20");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/role/simplelist");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/simplelist");
OapiRoleSimplelistRequest req = new OapiRoleSimplelistRequest();
req.RoleId = 1203141L;
req.Offset = 0L;
req.Size = 20L;
OapiRoleSimplelistResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| request_id | String | f6249uw1kuus | ID permintaan. |
| errcode | Number | 0 | Kode pengembalian. |
| errmsg | String | ok | Deskripsi kode pengembalian. |
| result | PageVo | Hasil kueri. | |
| hasMore | Boolean | true | Menunjukkan apakah tersedia data lainnya. |
| list | OpenEmpSimple[] | Daftar pengguna yang ditetapkan ke peran. | |
| userid | String | manager4220 | ID pengguna dari pengguna tersebut. |
| name | String | Budi | Nama pengguna. |
| manageScopes | OrgDeptVo[] | Cakupan pengelolaan. | |
| dept_id | Number | 11 | ID departemen. |
| name | String | Departemen Inspeksi Disiplin | Nama departemen. |
Contoh isi respons
{
"errcode": 0,
"result": {
"hasMore": false,
"list": [
{
"name": "Budi",
"userid": "manager4220",
"manageScopes":[
{
"dept_id":11,
"name":"Departemen Inspeksi Disiplin"
}
]
}
]
},
"request_id": "f6249uw1kuus"
}
Kode error
Jika terjadi error saat Anda memanggil API ini, cari solusinya di dokumen Kode error global berdasarkan pesan error.| Kode error (errorcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 33011 | Invalid roleId | Periksa apakah roleId sudah benar. |
| 40069 | Invalid size | Sesuaikan ukuran halaman. |
| 40068 | Invalid offset | Sesuaikan offset. |
| 400001 | System error | Coba lagi nanti. |