文档中心 > API类目 > 钉钉API

dingtalk.oapi.hrm.employee.get (获取智能人事指定员工花名册详细数据)

获取智能人事指定员工花名册详细数据

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
userid	String	必须	11111		查询用户userid

响应参数

名称	类型	示例值	描述
group_list	FieldGroupVpo []	[{...},{...}]	花名册分组列表
field_list SysCustomFieldVpo [] [{...},{...}] 字段列表 └ hidden_from_employee_flag Boolean true 员工查看个人档案时，该字段是否隐藏 └ contact_client_flag Boolean true 手机端通讯录个人信息页，是否显示该字段 └ contact_system_flag Boolean true 是否是通讯录系统字段 └ contact_flag Boolean true 是否是通讯录字段，包括系统字段和扩展字段 └ system_flag Boolean true 智能人事花名册默认的系统字段，包含通讯录的系统字段和花名册新增的字段 └ value String 字段的值字段的值 └ hint String 请选择花名册字段说明 └ option_text String ["女","男"] 选项类花名册字段的选择内容，是一个json数组 └ type_name String - 类型名，有文本，图片，选项，时间四种类型 └ field_type String - 字段类型，有TEXT,IMAGE,SELECT,TIME四种类型，与type_name一一对应 └ required Boolean true 是否必须 └ editable_by_hr Boolean true HR是否可编辑该字段 └ deleted Boolean true 是否已删除 └ editable_by_emp Boolean true 员工是否可编辑 └ visible_by_emp Boolean true 员工填写入职登记表的时候，该字段是否可见 └ field_name String 手机号码字段名称 └ field_code String d1f3 字段code └ corp_id String ding123123 corpId └ no_watermark Boolean true 是否无水印，仅针对图片类型的字段 └ confirm_entry_required Boolean true 人事管理员确认员工入职的时候，是否必填该字段 └ group_name String 工作信息花名册分组名 └ group_id String sys02 花名册分组id
errcode	Number	略	dingOpenErrcode
errmsg	String	参数异常	错误信息

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/hrm/employee/get");
OapiHrmEmployeeGetRequest req = new OapiHrmEmployeeGetRequest();
req.setUserid("11111");
OapiHrmEmployeeGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/hrm/employee/get");
OapiHrmEmployeeGetRequest req = new OapiHrmEmployeeGetRequest();
req.Userid = "11111";
OapiHrmEmployeeGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiHrmEmployeeGetRequest;
$req->setUserid("11111");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/hrm/employee/get");

curl -X POST "https://oapi.dingtalk.com/topapi/hrm/employee/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a761f79f-0088-4f73-b92f-562801df3873' \
-d 'userid=11111'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiHrmEmployeeGetRequest("https://oapi.dingtalk.com/topapi/hrm/employee/get")

req.userid="11111"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.hrm.employee.get");
add_param(pRequest,"userid","11111");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.hrm.employee.get', {
	'userid':'11111'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "group_list":[
        {
                "field_list":[
                    {
                            "hidden_from_employee_flag":true,
                            "contact_client_flag":true,
                            "contact_system_flag":true,
                            "contact_flag":true,
                            "system_flag":true,
                            "value":"字段的值",
                            "hint":"请选择",
                            "option_text":"[\"女\",\"男\"]",
                            "type_name":"-",
                            "field_type":"-",
                            "required":true,
                            "editable_by_hr":true,
                            "deleted":true,
                            "editable_by_emp":true,
                            "visible_by_emp":true,
                            "field_name":"手机号码",
                            "field_code":"d1f3",
                            "corp_id":"ding123123",
                            "no_watermark":true,
                            "confirm_entry_required":true
                    }
                ],
                "group_name":"工作信息",
                "group_id":"sys02"
        }
    ],
    "errcode":略,
    "errmsg":"参数异常"
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.hrm.employee.get (获取智能人事指定员工花名册详细数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈