Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/attendance/vacations/records/query |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin | permission-qyapi_holiday_readonly-Izin kueri cuti DingTalk |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Cara mendapatkannya: - Aplikasi internal: Panggil API Mendapatkan access token aplikasi internal. - Aplikasi perusahaan pihak ketiga: Panggil API untuk mendapatkan access token organisasi yang telah memberikan otorisasi kepada aplikasi pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| opUserId | String | Ya | userId admin di organisasi Anda yang memiliki izin aplikasi Persetujuan OA. Isi dengan userId Super Admin. Panggil API Mendapatkan daftar admin dan gunakan bidang userId milik Super Admin dari respons. |
| leaveCode | String | Ya | Pengidentifikasi unik jenis cuti. Panggil API Kueri daftar aturan cuti untuk mendapatkan nilai leave_code. |
| userIds | Array of String | Ya | Daftar userId karyawan yang akan dikueri. Kirim maksimal 50 userId per panggilan. |
| pageNumber | Long | Ya | Cursor paginasi: - Untuk kueri pertama, isi dengan 0. - Untuk kueri berikutnya, isi dengan offset kumulatif dari kueri sebelumnya. |
| pageSize | Integer | Ya | Offset paginasi. Maksimum: 200. |
Contoh permintaan
HTTPPOST /v1.0/attendance/vacations/records/query HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"opUserId" : "user01",
"leaveCode" : "f84a2dxxxx",
"userIds" : [ "user1" ],
"pageNumber" : 1,
"pageSize" : 100
}
// File ini dibuat secara otomatis, jangan diedit. Terima kasih.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Inisialisasi Client akun menggunakan Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkattendance_1_0.Client createClient() throws Exception {
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
config.protocol = "https";
config.regionId = "central";
return new com.aliyun.dingtalkattendance_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkattendance_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkattendance_1_0.models.GetLeaveRecordsHeaders getLeaveRecordsHeaders = new com.aliyun.dingtalkattendance_1_0.models.GetLeaveRecordsHeaders();
getLeaveRecordsHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkattendance_1_0.models.GetLeaveRecordsRequest getLeaveRecordsRequest = new com.aliyun.dingtalkattendance_1_0.models.GetLeaveRecordsRequest()
.setOpUserId("user01")
.setLeaveCode("f84a2dxxxx")
.setUserIds(java.util.Arrays.asList(
"user1"
))
.setPageNumber(1L)
.setPageSize(100);
try {
client.getLeaveRecordsWithOptions(getLeaveRecordsRequest, getLeaveRecordsHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err berisi atribut code dan message untuk membantu developer menemukan masalah
}
} catch (Exception _err) {
TeaException err = new TeaException(_err.getMessage(), _err);
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err berisi atribut code dan message untuk membantu developer menemukan masalah
}
}
}
}
# -*- coding: utf-8 -*-
# File ini dibuat secara otomatis, jangan diedit. Terima kasih.
import sys
from typing import List
from alibabacloud_dingtalk.attendance_1_0.client import Client as dingtalkattendance_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.attendance_1_0 import models as dingtalkattendance__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient
class Sample:
def __init__(self):
pass
@staticmethod
def create_client() -> dingtalkattendance_1_0Client:
"""
Inisialisasi Client akun menggunakan Token
@return: Client
@throws Exception
"""
config = open_api_models.Config()
config.protocol = 'https'
config.region_id = 'central'
return dingtalkattendance_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
get_leave_records_headers = dingtalkattendance__1__0_models.GetLeaveRecordsHeaders()
get_leave_records_headers.x_acs_dingtalk_access_token = '<your access token>'
get_leave_records_request = dingtalkattendance__1__0_models.GetLeaveRecordsRequest(
op_user_id='user01',
leave_code='f84a2dxxxx',
user_ids=[
'user1'
],
page_number=1,
page_size=100
)
try:
client.get_leave_records_with_options(get_leave_records_request, get_leave_records_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message untuk membantu developer menemukan masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
get_leave_records_headers = dingtalkattendance__1__0_models.GetLeaveRecordsHeaders()
get_leave_records_headers.x_acs_dingtalk_access_token = '<your access token>'
get_leave_records_request = dingtalkattendance__1__0_models.GetLeaveRecordsRequest(
op_user_id='user01',
leave_code='f84a2dxxxx',
user_ids=[
'user1'
],
page_number=1,
page_size=100
)
try:
await client.get_leave_records_with_options_async(get_leave_records_request, get_leave_records_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message untuk membantu developer menemukan masalah
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// File ini dibuat secara otomatis, jangan diedit. Terima kasih.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Models\GetLeaveRecordsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Models\GetLeaveRecordsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Inisialisasi Client akun menggunakan Token
* @return Dingtalk Client
*/
public static function createClient(){
$config = new Config([]);
$config->protocol = "https";
$config->regionId = "central";
return new Dingtalk($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$getLeaveRecordsHeaders = new GetLeaveRecordsHeaders([]);
$getLeaveRecordsHeaders->xAcsDingtalkAccessToken = "<your access token>";
$getLeaveRecordsRequest = new GetLeaveRecordsRequest([
"opUserId" => "user01",
"leaveCode" => "f84a2dxxxx",
"userIds" => [
"user1"
],
"pageNumber" => 1,
"pageSize" => 100
]);
try {
$client->getLeaveRecordsWithOptions($getLeaveRecordsRequest, $getLeaveRecordsHeaders, new RuntimeOptions([]));
}
catch (Exception $err) {
if (!($err instanceof TeaError)) {
$err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
}
if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
// err berisi atribut code dan message untuk membantu developer menemukan masalah
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// File ini dibuat secara otomatis, jangan diedit. Terima kasih.
package main
import (
"os"
util "github.com/alibabacloud-go/tea-utils/v2/service"
dingtalkattendance_1_0 "github.com/alibabacloud-go/dingtalk/attendance_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Inisialisasi Client akun menggunakan Token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkattendance_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkattendance_1_0.Client{}
_result, _err = dingtalkattendance_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
getLeaveRecordsHeaders := &dingtalkattendance_1_0.GetLeaveRecordsHeaders{}
getLeaveRecordsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
getLeaveRecordsRequest := &dingtalkattendance_1_0.GetLeaveRecordsRequest{
OpUserId: tea.String("user01"),
LeaveCode: tea.String("f84a2dxxxx"),
UserIds: []*string{tea.String("user1")},
PageNumber: tea.Int64(1),
PageSize: tea.Int32(100),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.GetLeaveRecordsWithOptions(getLeaveRecordsRequest, getLeaveRecordsHeaders, &util.RuntimeOptions{})
if _err != nil {
return _err
}
return nil
}()
if tryErr != nil {
var err = &tea.SDKError{}
if _t, ok := tryErr.(*tea.SDKError); ok {
err = _t
} else {
err.Message = tea.String(tryErr.Error())
}
if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
// err berisi atribut code dan message untuk membantu developer menemukan masalah
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// File ini dibuat secara otomatis, jangan diedit
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkattendance_1_0, * as $dingtalkattendance_1_0 from '@alicloud/dingtalk/attendance_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Inisialisasi Client akun menggunakan Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkattendance_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkattendance_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let getLeaveRecordsHeaders = new $dingtalkattendance_1_0.GetLeaveRecordsHeaders({ });
getLeaveRecordsHeaders.xAcsDingtalkAccessToken = "<your access token>";
let getLeaveRecordsRequest = new $dingtalkattendance_1_0.GetLeaveRecordsRequest({
opUserId: "user01",
leaveCode: "f84a2dxxxx",
userIds: [
"user1"
],
pageNumber: 1,
pageSize: 100,
});
try {
await client.getLeaveRecordsWithOptions(getLeaveRecordsRequest, getLeaveRecordsHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi atribut code dan message untuk membantu developer menemukan masalah
}
}
}
}
Client.main(process.argv.slice(2));
// File ini dibuat secara otomatis, jangan diedit. Terima kasih.
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/**
* Inisialisasi Client akun menggunakan Token
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkattendance_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkattendance_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkattendance_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetLeaveRecordsHeaders getLeaveRecordsHeaders = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetLeaveRecordsHeaders();
getLeaveRecordsHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetLeaveRecordsRequest getLeaveRecordsRequest = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetLeaveRecordsRequest
{
OpUserId = "user01",
LeaveCode = "f84a2dxxxx",
UserIds = new List<string>
{
"user1"
},
PageNumber = 1,
PageSize = 100,
};
try
{
client.GetLeaveRecordsWithOptions(getLeaveRecordsRequest, getLeaveRecordsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi atribut code dan message untuk membantu developer menemukan masalah
}
}
catch (Exception _err)
{
TeaException err = new TeaException(new Dictionary<string, object>
{
{ "message", _err.Message }
});
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi atribut code dan message untuk membantu developer menemukan masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| result | Object | Hasil yang dikembalikan. |
| hasMore | Boolean | Menunjukkan apakah masih ada hasil lainnya. - true: Masih ada hasil lainnya. - false: Tidak ada hasil lainnya. |
| leaveRecords | Array | Daftar riwayat pemakaian cuti. |
| userId | String | userId karyawan. |
| leaveCode | String | Pengidentifikasi unik jenis cuti. |
| recordId | String | Pengidentifikasi unik riwayat pemakaian cuti. |
| quotaId | String | Pengidentifikasi unik kuota cuti. |
| calType | String | Tipe perhitungan. - insert: Rekaman baru - add: Ditambahkan - delete: Dihapus - update: Diperbarui - null (atau bidang tidak dikembalikan): Dipakai oleh pengajuan cuti |
| startTime | Long | Waktu mulai masa berlaku kuota atau pengajuan cuti, dalam format stempel waktu milidetik. |
| endTime | Long | Waktu berakhir masa berlaku kuota atau pengajuan cuti, dalam format stempel waktu milidetik. |
| leaveViewUnit | String | Satuan tampilan. - day: Hari - hour: Jam |
| leaveReason | String | Alasan. |
| leaveRecordType | String | Tipe riwayat cuti. - leave: Pengajuan cuti - update: Pembaruan kuota - modify_quota: Inisialisasi saldo atau pembaruan saldo |
| leaveStatus | String | Status pengajuan cuti. - init: Pengajuan cuti sedang menunggu persetujuan. - success: Pengajuan cuti disetujui. - refuse: Pengajuan cuti ditolak. - abort: Pengajuan cuti ditarik kembali. - revoke: Pengajuan cuti telah disetujui, lalu permintaan pembatalannya diterima. |
| recordNumPerDay | Long | Kuota yang dipakai, dihitung dalam hari. - Catatan Jika jenis cuti dihitung per hari, nilai ini tidak kosong dan diukur dalam perseratus hari. Contoh: 1.000 = 10 hari. |
| recordNumPerHour | Long | Kuota yang dipakai, dihitung dalam jam. - Catatan Jika jenis cuti dihitung per jam, nilai ini tidak kosong dan diukur dalam perseratus jam. Contoh: 1.000 = 10 jam. |
| gmtCreate | Long | Waktu pembuatan rekaman, dalam format stempel waktu milidetik. |
| gmtModified | Long | Waktu modifikasi rekaman, dalam format stempel waktu milidetik. |
| opUserId | String | ID operator rekaman. |
| success | Boolean | Menunjukkan apakah permintaan berhasil. - true: Ya - false: Tidak |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : {
"hasMore" : true,
"leaveRecords" : [ {
"userId" : "user1",
"leaveCode" : "f84a2dxxxx",
"recordId" : "db1d74xxxxbaa",
"quotaId" : "db1d74xxxxbaa",
"calType" : "add",
"startTime" : 1653851001000,
"endTime" : 1753851001000,
"leaveViewUnit" : "day",
"leaveReason" : "Diimpor oleh admin",
"leaveRecordType" : "update",
"leaveStatus" : "init",
"recordNumPerDay" : 100,
"recordNumPerHour" : 100,
"gmtCreate" : 1653851001000,
"gmtModified" : 1753851001000,
"opUserId" : "manage2323"
} ]
},
"success" : true
}
Kode error
Jika panggilan API ini gagal, cari solusinya di dokumen Kode error global berdasarkan pesan error yang muncul.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | userNotExist | Pengguna tidak ditemukan | Pengguna tidak ditemukan. |
| 400 | leaveOpuserIdIsNotAdmin | Non-admin hanya dapat mengkueri informasi miliknya sendiri | Non-admin hanya dapat mengkueri informasi miliknya sendiri. |
| 400 | leaveTypeNotFound | Jenis cuti tidak ditemukan | Jenis cuti tidak ditemukan. |
| 400 | paramterInvalid | Error parameter | Parameter opUserId dan userId tidak boleh kosong. |
| 400 | leaveUserIdListMax | Maksimal 50 rekaman dapat dikueri sekaligus | Kueri maksimal 50 userId karyawan sekaligus. |
| 400 | pageIndexIllegal | Error parameter paginasi | Parameter paginasi harus berupa integer non-negatif yang dimulai dari 0. |
| 400 | pageSizeIllegal | Ukuran halaman melebihi batas | Ukuran halaman maksimum adalah 200. |
| 400 | noPermission | Tidak memiliki izin akses | Tidak memiliki izin akses. |
| 400 | leaveOrgIsUsed | Akses hanya diizinkan untuk organisasi | Hanya organisasi yang dapat mengakses API ini. |