> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ユーザーのシフト設定情報の照会

> ユーザーの userId と対象日を指定し、シフト・打刻時間・承認情報などのシフト設定情報を取得する勤怠 API です。

この API を呼び出して、特定日のユーザーのシフト設定情報を照会します。

## リクエスト

| **ベーシック情報** | |
| - | - |
| HTTP URL | [https://api.dingtalk.io/topapi/attendance/schedule/listbyday](https://api.dingtalk.io/topapi/attendance/schedule/listbyday) |
| HTTP メソッド | POST |
| 対応アプリタイプ | appType-社内アプリ　appType-サードパーティ社内アプリ |
| 権限 | qyapi\_attendance\_group\_read（勤怠グループの読み取り権限） |

### クエリパラメータ

| 名前 | タイプ | 必須 | 例 | 説明 |
| - | - | - | - | - |
| access\_token | String | はい | bE74xxxx | この API を呼び出すためのアプリ認証情報です。   - 社内アプリ：[社内アプリの access\_token を取得する](https://help.dingtalk.io/ja/open/development/obtain-orgapp-token)を呼び出して取得します。 - サードパーティ社内アプリ：サードパーティ社内アプリの access\_token を取得する API を呼び出して取得します。 |

### リクエストボディ

| 名前 | タイプ | 必須 | 例 | 説明 |
| - | - | - | - | - |
| op\_user\_id | String | はい | manager123 | 操作者の userId です。 |
| user\_id | String | はい | dd\_dd | 照会対象ユーザーの userId です。 |
| date\_time | Number | はい | 1564145519000 | 照会する日付です。ミリ秒単位の Unix タイムスタンプで指定します。 |

### リクエスト例

```curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST "https://api.dingtalk.io/topapi/attendance/schedule/listbyday" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=5d7f91f3-e22c-41ca-aee3-aa008603e00b' \
-d 'date_time=1564145519000' \
-d 'op_user_id=dd_dd' \
-d 'user_id=dd_dd'
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/schedule/listbyday");
OapiAttendanceScheduleListbydayRequest req = new OapiAttendanceScheduleListbydayRequest();
req.setOpUserId("user123");
req.setUserId("user456");
req.setDateTime(1564145519000L);
OapiAttendanceScheduleListbydayResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
import dingtalk.api

req=dingtalk.api.OapiAttendanceScheduleListbydayRequest("https://api.dingtalk.io/topapi/attendance/schedule/listbyday")

req.op_user_id="dd_dd"
req.user_id="dd_dd"
req.date_time=1564145519000
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
```

PHP

```php theme={"theme":{"light":"github-light","dark":"github-dark"}}
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiAttendanceScheduleListbydayRequest;
$req->setOpUserId("dd_dd");
$req->setUserId("dd_dd");
$req->setDateTime("1564145519000");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/schedule/listbyday");
```

C#

```csharp theme={"theme":{"light":"github-light","dark":"github-dark"}}
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/schedule/listbyday");
OapiAttendanceScheduleListbydayRequest req = new OapiAttendanceScheduleListbydayRequest();
req.OpUserId = "dd_dd";
req.UserId = "dd_dd";
req.DateTime = 1564145519000L;
OapiAttendanceScheduleListbydayResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
```

## レスポンス

### レスポンスボディ

| 名前 | タイプ | 例 | 説明 |
| - | - | - | - |
| result | TopScheduleVo\[] | | 照会結果です。 |
| check\_type | String | OnDuty | 勤怠タイプです。   - **Onduty**：出勤打刻 - **OffDuty**：退勤打刻 |
| approve\_type | String | demo | 承認タイプです。  **注意**  当日に承認フォームがない場合、このフィールドは返されません。 |
| gmt\_modified | Date | 2020-11-10 14:33:13 | 最後更新時間です。 |
| gmt\_create | Date | 2020-10-26 03:26:59 | 作成時間です。 |
| corp\_id | String | dinge8xxxx | 組織 ID（corpId）です。[開発者コンソール](https://open-dev.dingtalk.io/)のホームページで確認できます。 |
| check\_date\_time | Date | 2020-11-10 14:33:13 | 社員の打刻時間です。 |
| group\_id | Number | 394775001 | 勤怠グループ ID です。 |
| class\_name | String | dsdsd | シフト名です。 |
| user\_id | String | dd\_test | ユーザーの userId です。 |
| approve\_biz\_type | Number | demo | シフト設定に紐づく休暇・勤怠承認のタイプです。   - **1**：残業 - **2**：出張 - **3**：休暇   **注意**  当日に承認フォームがない場合、このフィールドは返されません。 |
| approve\_id | Number | 123 | シフト設定に紐づく承認フォームの ID です。  **注意**  当日に承認フォームがない場合、このフィールドは返されません。 |
| class\_setting\_id | Number | 297490031 | シフト設定に関連付けられたシフトの設定 ID です。  **注意**  グローバル設定を使用している場合、このフィールドは返されません。 |
| approve\_tag\_name | String | 休暇 | シフト設定に紐づく休暇・勤怠承認フォームの名前です。  **注意**  当日に承認フォームがない場合、このフィールドは返されません。 |
| features | String | `{\"dataSource\":\"adminSetting\",\"flexMinutes\":[60,60],\"overtimeSettingId\":221375127,\"punchId\":524588947}` | 拡張フィールドです。   - **dataSource**：このフィールドは現在、実質的な意味を持ちません。 - **flexMinutes**：シフトの設定で許容される、遅く出勤して遅く退勤する場合、または早く出勤して早く退勤する場合の柔軟時間です（単位：分）。 - **punchId**：対応する打刻ポイントの ID です。 - **overtimeSettingId**：残業ルールの ID です。 |
| class\_id | Number | 370370019 | シフト ID です。 |
| check\_status | String | Timeout | 打刻ステータスです。   - **Init**：未打刻 - **Checked**：打刻済み - **Timeout**：打刻漏れ |
| work\_date | Date | 2020-11-10 00:00:00 | 勤務日です。シフト設定の対象日を示します。 |
| check\_end\_time | Date | 2020-09-08 09:30:00 | 打刻可能時間帯の終了時刻です。 |
| is\_rest | String | N | 休日かどうかを示します。   - **Y**：休日としてシフト設定済み - **N**：休日ではない |
| check\_begin\_time | Date | 2020-09-08 09:00:00 | 打刻可能時間帯の開始時刻です。 |
| real\_plan\_time | Date | 2020-09-08 10:00:00 | 打刻ポイントでフレックスタイムによる調整をオンにした後、ユーザーが打刻すべき時刻です。 |
| id | Number | 56676915454 | シフト設定 ID です。 |
| success | Boolean | true | リクエストが成功したかどうかを示します。   - **true**：成功 - **false**：失敗 |
| errcode | Number | 0 | リターンコードです。 |
| errmsg | String | demo | リターンコードの説明です。 |
| request\_id | String | 6bzhf2vn89pv | リクエスト ID です。 |

### レスポンスボディの例

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "errcode": 0,
  "result": [
    {
      "check_date_time": "2020-11-10 09:30:00",
      "check_status": "Timeout",
      "check_type": "OnDuty",
      "class_id": 677995086,
      "class_name": "A",
      "class_setting_id": 599315627,
      "corp_id": "dinge8xxxx",
      "features": "{\"flexMinutes\":[30,30],\"overtimeSettingId\":581490201,\"punchId\":346266563}",
      "gmt_create": "2020-10-26 03:26:59",
      "gmt_modified": "2020-11-10 14:33:13",
      "group_id": 685935028,
      "id": 156270023005,
      "is_rest": "N",
      "real_plan_time": "2020-11-10 09:30:00",
      "user_id": "user123",
      "work_date": "2020-11-10 00:00:00"
    },
    {
      "check_date_time": "2020-11-10 18:30:00",
      "check_status": "Timeout",
      "check_type": "OffDuty",
      "class_id": 677995086,
      "class_name": "A",
      "class_setting_id": 599315627,
      "corp_id": "dinge8xxxx",
      "features": "{\"flexMinutes\":[30,30],\"overtimeSettingId\":581490201,\"punchId\":346266564}",
      "gmt_create": "2020-10-26 03:26:59",
      "gmt_modified": "2020-11-11 02:30:45",
      "group_id": 685935028,
      "id": 156270023006,
      "is_rest": "N",
      "real_plan_time": "2020-11-10 18:30:00",
      "user_id": "user123",
      "work_date": "2020-11-10 00:00:00"
    }
  ],
  "success": true,
  "request_id": "6bzhf2vn89pv"
}
```

### エラーコード

この API の呼び出しでエラーが返された場合は、エラーメッセージをもとに[グローバルエラーコード](https://help.dingtalk.io/ja/open/development/server-api-error-codes-1.md)ドキュメントで解決方法を確認してください。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.