API Call Description
For example, an organization has two makeup clock-in rules in its attendance rules management: Test makeup clock-in rule and Default makeup clock-in rule. Call this API to get the rule names and rule IDs of both makeup clock-in rules. In the Attendance admin console, open attendance rules > Makeup clock-in rules to view the configured makeup clock-in rules. Each rule lists its Rule name, Rule details (allowed submissions per month, how far back makeup clock-in can be requested, and applicable types such as missed, late, or early-leave punches), and Scope, with Edit and Delete actions. Use Add makeup clock-in rule to create a new one.Request
Basic Information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/attendance/adjustments |
| HTTP Method | GET |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-qyapi_attendance_group_read-Attendance group read permission |
Request Header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an Internal app, call the Get the access token of an internal app API. - For a Third-party enterprise app, call the API for getting the access token of an organization that has authorized a Third-party app. |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| pageNumber | Long | Yes | The starting page number. The value starts from 1. |
| pageSize | Long | Yes | The page size. The maximum value is 50. |
Request Example
HTTPGET /v1.0/attendance/adjustments?pageNumber=1&pageSize=10 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkattendance_1_0.*;
import com.aliyun.dingtalkattendance_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;
public class Sample {
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkattendance_1_0.Client createClient() throws Exception {
Config config = new 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();
GetAdjustmentsHeaders getAdjustmentsHeaders = new GetAdjustmentsHeaders();
getAdjustmentsHeaders.xAcsDingtalkAccessToken = "<your access token>";
GetAdjustmentsRequest getAdjustmentsRequest = new GetAdjustmentsRequest()
.setPageNumber(1L)
.setPageSize(10L);
try {
client.getAdjustmentsWithOptions(getAdjustmentsRequest, getAdjustmentsHeaders, new RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err contains the code and message attributes to help locate the issue
}
} 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 contains the code and message attributes to help locate the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
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:
"""
Initialize the account Client with a 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_adjustments_headers = dingtalkattendance__1__0_models.GetAdjustmentsHeaders()
get_adjustments_headers.x_acs_dingtalk_access_token = '<your access token>'
get_adjustments_request = dingtalkattendance__1__0_models.GetAdjustmentsRequest(
page_number=1,
page_size=10
)
try:
client.get_adjustments_with_options(get_adjustments_request, get_adjustments_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains the code and message attributes to help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
get_adjustments_headers = dingtalkattendance__1__0_models.GetAdjustmentsHeaders()
get_adjustments_headers.x_acs_dingtalk_access_token = '<your access token>'
get_adjustments_request = dingtalkattendance__1__0_models.GetAdjustmentsRequest(
page_number=1,
page_size=10
)
try:
await client.get_adjustments_with_options_async(get_adjustments_request, get_adjustments_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains the code and message attributes to help locate the issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// This file is auto-generated, don't edit it. Thanks.
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\GetAdjustmentsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Models\GetAdjustmentsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with a 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();
$getAdjustmentsHeaders = new GetAdjustmentsHeaders([]);
$getAdjustmentsHeaders->xAcsDingtalkAccessToken = "<your access token>";
$getAdjustmentsRequest = new GetAdjustmentsRequest([
"pageNumber" => 1,
"pageSize" => 10
]);
try {
$client->getAdjustmentsWithOptions($getAdjustmentsRequest, $getAdjustmentsHeaders, 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 contains the code and message attributes to help locate the issue
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"os"
util "github.com/alibabacloud-go/tea-utils/service"
dingtalkattendance_1_0 "github.com/alibabacloud-go/dingtalk/attendance_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client with a 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
}
getAdjustmentsHeaders := &dingtalkattendance_1_0.GetAdjustmentsHeaders{}
getAdjustmentsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
getAdjustmentsRequest := &dingtalkattendance_1_0.GetAdjustmentsRequest{
PageNumber: tea.Int64(1),
PageSize: tea.Int64(10),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.GetAdjustmentsWithOptions(getAdjustmentsRequest, getAdjustmentsHeaders, &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 contains the code and message attributes to help locate the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
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 {
/**
* Initialize the account Client with a 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 getAdjustmentsHeaders = new $dingtalkattendance_1_0.GetAdjustmentsHeaders({ });
getAdjustmentsHeaders.xAcsDingtalkAccessToken = "<your access token>";
let getAdjustmentsRequest = new $dingtalkattendance_1_0.GetAdjustmentsRequest({
pageNumber: 1,
pageSize: 10,
});
try {
await client.getAdjustmentsWithOptions(getAdjustmentsRequest, getAdjustmentsHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains the code and message attributes to help locate the issue
}
}
}
}
Client.main(process.argv.slice(2));
// This file is auto-generated, don't edit it. Thanks.
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
{
/**
* Initialize the account Client with a 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.GetAdjustmentsHeaders getAdjustmentsHeaders = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetAdjustmentsHeaders();
getAdjustmentsHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetAdjustmentsRequest getAdjustmentsRequest = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetAdjustmentsRequest
{
PageNumber = 1,
PageSize = 10,
};
try
{
client.GetAdjustmentsWithOptions(getAdjustmentsRequest, getAdjustmentsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains the code and message attributes to help locate the issue
}
}
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 contains the code and message attributes to help locate the issue
}
}
}
}
}
Response
Response Body
| Name | Type | Description |
|---|---|---|
| result | Object | The returned result. |
| pageNumber | Long | The current page number. |
| totalPage | Long | The total number of pages. |
| items | Array | The list of makeup clock-in rules. |
| id | Long | The makeup clock-in rule ID. |
| name | String | The makeup clock-in rule name. |
| settingId | Long | The settingId of the makeup clock-in rule. |
Response Body Example
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : {
"pageNumber" : 1,
"totalPage" : 3,
"items" : [ {
"id" : 447010124,
"name" : "Default makeup clock-in rule",
"settingId" : 447010124
} ]
}
}
Error Codes
If a call to this API returns an error, find a solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | system.error | System error | System error |
| 400 | paging.parameter.error | Pagination parameter error | Pagination parameter error |