Developer GuideRequest
| Basic Information | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/positions/add |
| HTTP Method | POST |
| Supported app types | appType-Internal app |
| Required permissions | permission-qyapi_attendance_group_manage-Attendance group management permission |
Query Parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| access_token | String | Yes | 4c9ebd2b1534xxxx | The App credential used to call this API. Obtain it by calling the Get the access_token of an Internal App API. |
Request Body
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| op_userid | String | No | user01 | The user ID of the operator. |
| group_key | String | Yes | 03B1Exxxx | The attendance group ID. Note If your attendance group identifier is group_id, call the Convert groupId to groupKey API to convert group_id to group_key. |
| position_list | Object[] | Yes | The list of positions. Add up to 100 locations per request. | |
| address | String | Yes | Alibaba Group Xixi Beiyuan | The address description. |
| foreign_id | String | Yes | 0151E23B1 | The positionId defined by the business party. |
| longitude | String | Yes | 120.123 | The longitude (up to 6 decimal places). |
| latitude | String | Yes | 30.123 | The latitude (up to 6 decimal places). |
| offset | Number | No | 100 | The allowed offset for the clock-in location, in meters. |
Request Example
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 Xixi Beiyuan");
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 Xixi Beiyuan";
$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 Xixi Beiyuan";
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);
Response
Response Body
| Name | Type | Example | Description |
|---|---|---|---|
| result | DingOpenResult | The returned result. | |
| result | Result | The query result. | |
| error_info_list | ErrorInfo[] | The list of errors. | |
| failure_list | Position[] | The list of failed items. | |
| foreign_id | String | 0151E23B1xxxx | The positionId defined by the business party. |
| address | String | Alibaba Group Xixi Beiyuan | The address description. |
| latitude | String | 120.123 | The longitude (up to 6 decimal places). |
| longitude | String | 30.123 | The latitude (up to 6 decimal places). |
| position_key | String | The location key. Empty if the operation fails. | |
| msg | String | business fault | The error message. |
| code | String | 1000 | The error code. |
| success_list | Position[] | The list of successful items. | |
| foreign_id | String | 0151E23B1 | The positionId defined by the business party. |
| address | String | Alibaba Group Xixi Beiyuan | The address description. |
| latitude | String | 120.123 | The longitude (up to 6 decimal places). |
| longitude | String | 30.123 | The latitude (up to 6 decimal places). |
| position_key | String | 9E459D1xxxx | The unique identifier of the position. |
| errcode | Number | 0 | The return code. |
| errmsg | String | ok | The description of the return code. |
| success | Boolean | true | Indicates whether the request succeeded. - true: Success - false: Failed |
| request_id | String | rndx5wfzebph | The request ID. |
Response Body Example
{
"result": {
"errcode": 0,
"errmsg" "ok",
"result": {
"success_list": [
{
"address": "Alibaba Group Xixi Beiyuan",
"foreign_id": "0151E23B1",
"latitude": "30.123",
"longitude": "120.123",
"position_key": "9E459D1xxxx"
}
]
},
"success": true
},
"request_id": "rndx5wfzebph"
}