Panduan pengembangPermintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/attendance/vacation/quota/list |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-qyapi_holiday_readonly-Izin baca cuti DingTalk |
Parameter kueri
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| access_token | String | Ya | bE74xxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini. - Aplikasi internal: Dapatkan dengan memanggil API Mendapatkan access_token Aplikasi internal. - Aplikasi perusahaan pihak ketiga: Dapatkan dengan memanggil API Mendapatkan access_token Perusahaan Pihak Ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| leave_code | String | Ya | f84a2xxxx | Pengidentifikasi unik jenis cuti. Panggil API Kueri daftar aturan cuti untuk mendapatkan nilai leave_code. |
| op_userid | String | Ya | user01 | ID pengguna admin di organisasi Anda yang memiliki izin aplikasi untuk Persetujuan OA. |
| userids | String | Ya | user02,user03 | Daftar ID karyawan yang akan dikueri. |
| offset | Number | Ya | 0 | Offset paginasi. Harus berupa integer non-negatif yang dimulai dari 0. |
| size | Number | Ya | 10 | Ukuran halaman. Nilai maksimum: 50. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/attendance/vacation/quota/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=48acxxxx0dbdbee' \
-d 'leave_code=f84a2829-d245-4312-9ff2-0653e5b3abb2' \
-d 'offset=0' \
-d 'op_userid=zhangsan' \
-d 'size=10' \
-d 'userids=zhangsan%2Clisi'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/vacation/quota/list");
OapiAttendanceVacationQuotaListRequest req = new OapiAttendanceVacationQuotaListRequest();
req.setLeaveCode("f84a2xxxx");
req.setOpUserid("user01");
req.setUserids("user02,user03");
req.setOffset(0L);
req.setSize(10L);
OapiAttendanceVacationQuotaListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceVacationQuotaListRequest("https://api.dingtalk.io/topapi/attendance/vacation/quota/list")
req.leave_code="f84a2829-d245-4312-9ff2-0653e5b3abb2"
req.op_userid="zhangsan"
req.userids="zhangsan,lisi"
req.offset=0
req.size=10
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 OapiAttendanceVacationQuotaListRequest;
$req->setLeaveCode("f84a2829-d245-4312-9ff2-0653e5b3abb2");
$req->setOpUserid("zhangsan");
$req->setUserids("zhangsan,lisi");
$req->setOffset("0");
$req->setSize("10");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/vacation/quota/list");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/vacation/quota/list");
OapiAttendanceVacationQuotaListRequest req = new OapiAttendanceVacationQuotaListRequest();
req.LeaveCode = "f84a2829-d245-4312-9ff2-0653e5b3abb2";
req.OpUserid = "zhangsan";
req.Userids = "zhangsan,lisi";
req.Offset = 0L;
req.Size = 10L;
OapiAttendanceVacationQuotaListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| result | OapiLeaveQuotaUserListVo | Hasil yang dikembalikan. | |
| has_more | Boolean | false | Menunjukkan apakah masih ada data lainnya. - true: Masih ada data lainnya. - false: Tidak ada data lainnya. |
| leave_quotas | Leavequotas[] | Daftar saldo cuti. | |
| userid | String | user01 | ID pengguna karyawan. |
| leave_code | String | f84a2xxxx | Pengidentifikasi unik jenis cuti. |
| quota_cycle | String | 2019 | Siklus yang berlaku untuk kuota. |
| quota_id | String | f8abb2xxxx | Pengidentifikasi unik kuota. |
| start_time | Number | 1653851001000 | Waktu mulai masa berlaku cuti, berupa stempel waktu dalam milidetik. |
| end_time | Number | 1753851001000 | Waktu berakhir masa berlaku kuota, berupa stempel waktu dalam milidetik. |
| quota_num_per_hour | Number | 1000 | Total kuota, dihitung dalam jam. Catatan Jika jenis cuti dihitung dalam jam, nilai ini tidak kosong dan dinyatakan dalam perseratus jam. Contoh: 1000 = 10 jam. |
| quota_num_per_day | Number | 1000 | Total kuota, dihitung dalam hari. Catatan Jika jenis cuti dihitung dalam hari, nilai ini tidak kosong dan dinyatakan dalam perseratus hari. Contoh: 1000 = 10 hari. |
| used_num_per_day | Number | 100 | Kuota yang telah digunakan, dihitung dalam hari. Catatan Jika jenis cuti dihitung dalam hari, nilai ini tidak kosong dan dinyatakan dalam perseratus hari. Contoh: 100 = 1 hari. |
| used_num_per_hour | Number | 1000 | Kuota yang telah digunakan, dihitung dalam jam. Catatan Jika jenis cuti dihitung dalam jam, nilai ini tidak kosong dan dinyatakan dalam perseratus jam. Contoh: 1000 = 10 jam. |
| errcode | Number | 0 | Kode pengembalian. |
| errmsg | String | ok | Deskripsi kode pengembalian. |
| success | Boolean | true | Menunjukkan apakah panggilan berhasil. - true: Ya - false: Tidak |
Contoh isi respons
{
"errcode": 0,
"result": {
"has_more": false,
"leave_quotas": [
{
"end_time": 1753851001000,
"leave_code": "f84a2xxxx",
"quota_cycle": "2019",
"quota_id": "f8abb2xxxx",
"quota_num_per_day": 1000,
"start_time": 1653851001000,
"used_num_per_day": 100,
"quota_num_per_hour": 1000,
"userid": "user01",
"used_num_per_hour": 1000
}
]
},
"success": true,
"request_id": "exz4w88xfo7n"
}