リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/positions/add |
| HTTP メソッド | POST |
| 対応アプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-qyapi_attendance_group_manage-勤怠グループ管理権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 4c9ebd2b1534xxxx | この API を呼び出すためのアプリ認証情報です。社内アプリの access_token を取得する API を呼び出して取得してください。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| op_userid | String | いいえ | user01 | 操作者のユーザー ID です。 |
| group_key | String | はい | 03B1Exxxx | 勤怠グループ ID です。 注意 勤怠グループの識別子が group_id の場合は、groupId から groupKey への変換 API を呼び出して、group_id を group_key に変換してください。 |
| position_list | Object[] | はい | 位置情報のリストです。1 回のリクエストで最大 100 件の場所を追加できます。 | |
| address | String | はい | Alibaba Group 西渓北苑 | 住所の説明です。 |
| foreign_id | String | はい | 0151E23B1 | 業務側で定義した positionId です。 |
| longitude | String | はい | 120.123 | 経度です(小数点以下 6 桁まで)。 |
| latitude | String | はい | 30.123 | 緯度です(小数点以下 6 桁まで)。 |
| offset | Number | いいえ | 100 | 打刻場所の許容範囲です(単位:メートル)。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/attendance/group/positions/add" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=23adcxxxx46c5226' \
-d 'group_key=0151E02xxxx917E876' \
-d 'op_userid=123456' \
-d 'position_list=null'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/positions/add");
OapiAttendanceGroupPositionsAddRequest req = new OapiAttendanceGroupPositionsAddRequest();
req.setOpUserid("user01");
req.setGroupKey("03B1Exxxx");
List<Position> list = new ArrayList<Position>();
Position position = new Position();
list.add(position);
position.setAddress("Alibaba Group 西渓北苑");
position.setForeignId("0151E23B1");
position.setLongitude("120.123");
position.setLatitude("30.123");
position.setOffset(100);
req.setPositionList(list);
OapiAttendanceGroupPositionsAddResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGroupPositionsAddRequest("https://api.dingtalk.io/topapi/attendance/group/positions/add")
req.op_userid="123456"
req.group_key="0151E02xxxx1A917E876"
req.position_list=""
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 OapiAttendanceGroupPositionsAddRequest;
$req->setOpUserid("123456");
$req->setGroupKey("0151E02xxxx7E876");
$position_list = new Position;
$position_list->address="Alibaba Group 西渓北苑";
$position_list->foreign_id="0151E022xxxx917E876";
$position_list->longitude="120.123";
$position_list->latitude="30.123";
$position_list->offset="100";
$req->setPositionList(array($position_list));
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/group/positions/add");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/positions/add");
OapiAttendanceGroupPositionsAddRequest req = new OapiAttendanceGroupPositionsAddRequest();
req.OpUserid = "123456";
req.GroupKey = "0151E02xxxx17E876";
List<OapiAttendanceGroupPositionsAddRequest.PositionDomain> list2 = new List<OapiAttendanceGroupPositionsAddRequest.PositionDomain>();
OapiAttendanceGroupPositionsAddRequest.PositionDomain obj3 = new OapiAttendanceGroupPositionsAddRequest.PositionDomain();
list2.Add(obj3);
obj3.Address = "Alibaba Group 西渓北苑";
obj3.ForeignId = "0151E0xxxx917E876";
obj3.Longitude = "120.123";
obj3.Latitude = "30.123";
obj3.Offset = 100L;
req.PositionList_ = list2;
OapiAttendanceGroupPositionsAddResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| result | DingOpenResult | 返却結果です。 | |
| result | Result | クエリ結果です。 | |
| error_info_list | ErrorInfo[] | エラーのリストです。 | |
| failure_list | Position[] | 失敗した項目のリストです。 | |
| foreign_id | String | 0151E23B1xxxx | 業務側で定義した positionId です。 |
| address | String | Alibaba Group 西渓北苑 | 住所の説明です。 |
| latitude | String | 120.123 | 経度です(小数点以下 6 桁まで)。 |
| longitude | String | 30.123 | 緯度です(小数点以下 6 桁まで)。 |
| position_key | String | 場所のキーです。操作に失敗した場合は空になります。 | |
| msg | String | 業務エラー | エラーメッセージです。 |
| code | String | 1000 | エラーコードです。 |
| success_list | Position[] | 成功した項目のリストです。 | |
| foreign_id | String | 0151E23B1 | 業務側で定義した positionId です。 |
| address | String | Alibaba Group 西渓北苑 | 住所の説明です。 |
| latitude | String | 120.123 | 経度です(小数点以下 6 桁まで)。 |
| longitude | String | 30.123 | 緯度です(小数点以下 6 桁まで)。 |
| position_key | String | 9E459D1xxxx | 場所の一意の識別子です。 |
| errcode | Number | 0 | 返却コードです。 |
| errmsg | String | ok | 返却コードの説明です。 |
| success | Boolean | true | リクエストが成功したかどうかを示します。 - true:成功 - false:失敗 |
| request_id | String | rndx5wfzebph | リクエスト ID です。 |
レスポンスボディの例
{
"result": {
"errcode": 0,
"errmsg" "ok",
"result": {
"success_list": [
{
"address": "Alibaba Group 西渓北苑",
"foreign_id": "0151E23B1",
"latitude": "30.123",
"longitude": "120.123",
"position_key": "9E459D1xxxx"
}
]
},
"success": true
},
"request_id": "rndx5wfzebph"
}