開発ガイドリクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/getusergroup |
| HTTP メソッド | POST |
| 対応アプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi_base-組織 API の呼び出しに必要なベーシック権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | この API の呼び出しに使用するアプリ認証情報です。 - 社内アプリの場合は、社内アプリの access_token を取得 API を呼び出して取得します。 - サードパーティ社内アプリの場合は、「サードパーティ社内アプリの access_token を取得」API を呼び出して取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| userid | String | はい | user123 | 社内における社員のユーザー ID です。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/attendance/getusergroup" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=04cd6xxxx91f77' \
-d 'userid=zhangsan'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/getusergroup");
OapiAttendanceGetusergroupRequest req = new OapiAttendanceGetusergroupRequest();
req.setUserid("user123");
OapiAttendanceGetusergroupResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGetusergroupRequest("https://api.dingtalk.io/topapi/attendance/getusergroup")
req.userid="zhangsan"
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 OapiAttendanceGetusergroupRequest;
$req->setUserid("zhangsan");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/getusergroup");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/getusergroup");
OapiAttendanceGetusergroupRequest req = new OapiAttendanceGetusergroupRequest();
req.Userid = "zhangsan";
OapiAttendanceGetusergroupResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| result | AtGroupFullForTopVo | クエリ結果です。 | |
| name | String | 勤怠グループ | 勤怠グループの名前です。 |
| group_id | Number | 685935028 | 勤怠グループの ID です。 注意 旧勤怠グループ識別子 group_key を使用している場合は、groupKey から groupId への変換 API を呼び出して、group_key を group_id に変換してください。 |
| type | String | TURN | 勤怠タイプです。 - FIXED：固定シフト設定 - TURN：交代制シフト設定 - NONE：シフトなし |
| classes | AtClassVo[] | 勤怠グループ内のシフト一覧です。 | |
| class_id | Number | 678215070 | シフト ID です。 |
| name | String | シフト A | シフト名です。 |
| sections | AtSectionVo[] | シフト内の出勤・退勤区間の一覧です。 | |
| times | AtTimeVo[] | シフト内の出勤・退勤の詳細一覧です。 | |
| check_time | Date | 1970-01-01 19:00:00 | 打刻時刻です。 |
| check_type | String | OnDuty | 打刻タイプです。 - OnDuty：出勤 - OffDuty：退勤 |
| across | Number | 0 | 打刻時刻がまたぐ日数です。 |
| begin_min | Number | 30 | 予定時刻より前に打刻できる最も早い時間（分）です。 |
| end_min | Number | 0 | 予定時刻より後に打刻できる最も遅い時間（分）です。 |
| setting | ClassSettingVo | シフトの設定です。 | |
| rest_begin_time | AtTimeVo | 休憩開始の設定です。 | |
| across | Number | 0 | 日またぎの有無です。 - 0：日をまたがない - 1：日をまたぐ |
| begin_min | Number | 0 | 開始時刻です。 |
| end_min | Number | 0 | 終了時刻です。 |
| check_time | Date | 1970-01-01 19:00:00 | 休憩開始時刻です。 |
| check_type | String | OnDuty | 設定タイプです。 - OnDuty：休憩開始 - OffDuty：休憩終了 |
| rest_end_time | AtTimeVo | 休憩終了時刻の設定です。 | |
| across | Number | 0 | 日またぎの有無です。 |
| begin_min | Number | 0 | 開始時刻です。 |
| end_min | Number | 0 | 終了時刻です。 |
| check_time | Date | 1970-01-01 20:00:00 | 休憩終了時刻です。 |
| check_type | String | OffDuty | 打刻タイプです。 - OnDuty：休憩開始 - OffDuty：休憩終了 |
| errcode | Number | 0 | 戻りコードです。 |
| errmsg | String | ok | 戻りコードの説明です。 |
| request_id | String | f8zybbfze3e8 | リクエスト ID です。 |
レスポンスボディの例
{
"errcode": 0,
"result": {
"classes": [
{
"class_id": 677995086,
"name": "シフト A",
"sections": [
{
"times": [
{
"across": 0,
"check_time": "1970-01-01 09:30:00",
"check_type": "OnDuty"
},
{
"across": 0,
"check_time": "1970-01-01 18:30:00",
"check_type": "OffDuty"
}
]
}
],
"setting": {}
},
{
"class_id": 678215070,
"name": "シフト B",
"sections": [
{
"times": [
{
"across": 0,
"check_time": "1970-01-01 19:00:00",
"check_type": "OnDuty"
},
{
"across": 1,
"check_time": "1970-01-01 05:00:00",
"check_type": "OffDuty"
}
]
}
],
"setting": {}
}
],
"group_id": 685935028,
"name": "勤怠グループ",
"type": "FIXED"
},
"request_id": "f8zybbfze3e8"
}