開発ガイドリクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/positions/remove |
| HTTP メソッド | POST |
| 対応アプリタイプ | appType-社内アプリ |
| 必須権限 | permission-qyapi_attendance_group_manage-Attendance group management permission |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 4c9ebd2b1534xxxx | この API の呼び出しに使用するアプリ認証情報です。社内アプリの access_token を取得する API を呼び出して取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| op_userid | String | いいえ | user01 | 操作者のユーザー ID です。 |
| group_key | String | はい | CEDDFxxxx | 勤怠グループ ID です。注意：勤怠グループの識別子が group_id の場合は、groupId から groupKey への変換 API を呼び出して、group_id を group_key に変換してください。 |
| position_key_list | String | はい | C384Fxxxx | 削除する勤怠場所のキーのリストです。キーは 勤怠場所の一括クエリ API を呼び出して取得します。1 回の呼び出しで最大 100 件の勤怠場所を削除できます。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/attendance/group/positions/remove" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=25961xxxx7912f13' \
-d 'group_key=0151E022xxxx72A1A917E876' \
-d 'op_userid=123456' \
-d 'position_key_list=%22123%22%2C%22123%22'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/positions/remove");
OapiAttendanceGroupPositionsRemoveRequest req = new OapiAttendanceGroupPositionsRemoveRequest();
req.setOpUserid("user01");
req.setGroupKey("CEDDFxxxx");
req.setPositionKeyList("C384Fxxxx");
OapiAttendanceGroupPositionsRemoveResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGroupPositionsRemoveRequest("https://api.dingtalk.io/topapi/attendance/group/positions/remove")
req.op_userid="123456"
req.group_key="0151E02xxxx17E876"
req.position_key_list="["123","123"]"
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 OapiAttendanceGroupPositionsRemoveRequest;
$req->setOpUserid("123456");
$req->setGroupKey("0151E02xxxx17E876");
$req->setPositionKeyList("[\"123\",\"123\"]");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/group/positions/remove");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/positions/remove");
OapiAttendanceGroupPositionsRemoveRequest req = new OapiAttendanceGroupPositionsRemoveRequest();
req.OpUserid = "123456";
req.GroupKey = "0151E0xxxx17E876";
req.PositionKeyList = ""123","123"";
OapiAttendanceGroupPositionsRemoveResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| result | Result | 返却結果です。 | |
| success_list | String[] | [“C384Fxxxx”] | 削除に成功した項目のリストです。 |
| error_info_list | ErrorInfo[] | エラーのリストです。 | |
| failure_list | String[] | [“C384Fxxxx”] | 削除に失敗した項目のリストです。 |
| msg | String | 業務エラー | エラーの説明です。 |
| code | String | 1000 | エラーコードです。 |
| errcode | Number | 0 | リターンコードです。 |
| errmsg | String | ok | リターンコードの説明です。 |
| success | Boolean | true | 呼び出しに成功したかどうかを示します。 - true：成功 - false：失敗 |
| request_id | String | 1493be6v5yefm | リクエスト ID です。 |
レスポンスボディ例
{
"errcode": 0,
"errmsg":"ok",
"result": {
"error_info_list": [
{
"code": "1000",
"failure_list": [
"C384Fxxxx"
],
"msg": "業務エラー"
}
],
"success_list": [
"C384Fxxxx"
]
},
"success": true,
"request_id": "1493be6v5yefm"
}