文档中心 > API类目 > 神鲸应用API

alibaba.ib.workcore.person.getpersondetail (根据手机号或者姓名获取神鲸人员信息)

根据手机号或者姓名获取神鲸人员信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_query_person_dto TopQueryPersonDto 必须 查询对象
  • └ search_kw
  • String
  • 必须
  • 老王
  • 查询参数 姓名或手机
  • └ page
  • Number
  • 必须
  • 1
  • 页码
  • └ size
  • Number
  • 必须
  • 20
  • 分页大小
work_bench_context WorkBenchContext 必须 系统自动生成
  • └ campus_id
  • Number
  • 可选
  • 11
  • 园区id
  • └ system_id
  • String
  • 可选
  • 11
  • 系统id

响应参数

名称 类型 示例值 描述
result CollectionResult {} CollectionResult
  • └ error_level
  • String
  • 1
  • 错误等级
  • └ error_ext_info
  • String
  • {"":""}
  • 错误详情
  • └ success
  • Boolean
  • false
  • 是否成功
  • └ error_msg
  • String
  • ok
  • 错误消息
  • └ error_code
  • String
  • 200
  • 错误码
  • └ total_count
  • Number
  • 123
  • 总数量
  • └ request_id
  • String
  • 1
  • 请求id
  • contents
  • PersonDto []
  • []
  • 内容
  • └ name
  • String
  • 张三
  • 姓名
  • └ account_id
  • String
  • 1
  • 存放在平台的账号id
  • └ avatar
  • String
  • xx.xx/xx.jpg
  • 头像
  • └ avatar_url
  • String
  • xx.xx/xx.jpg
  • 头像URL
  • └ avatar_pre_view_url
  • String
  • xx.xx/xx.jpg
  • 头像URL
  • └ nick_name
  • String
  • 张三
  • 昵称
  • └ mobile
  • String
  • 1213
  • 存放在buc的手机号
  • └ passport_account_id
  • String
  • 12
  • buc账号ID
  • └ telephone
  • String
  • 1132435454
  • 存放在平台的手机号

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIbWorkcorePersonGetpersondetailRequest req = new AlibabaIbWorkcorePersonGetpersondetailRequest();
AlibabaIbWorkcorePersonGetpersondetailRequest.TopQueryPersonDto obj1 = new AlibabaIbWorkcorePersonGetpersondetailRequest.TopQueryPersonDto();
obj1.setSearchKw("老王");
obj1.setPage(1L);
obj1.setSize(20L);
req.setTopQueryPersonDto(obj1);
AlibabaIbWorkcorePersonGetpersondetailRequest.WorkBenchContext obj2 = new AlibabaIbWorkcorePersonGetpersondetailRequest.WorkBenchContext();
obj2.setCampusId(11L);
obj2.setSystemId("11");
req.setWorkBenchContext(obj2);
AlibabaIbWorkcorePersonGetpersondetailResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_ib_workcore_person_getpersondetail_response>
    <result>
        <error_level>1</error_level>
        <error_ext_info>{&quot;&quot;:&quot;&quot;}</error_ext_info>
        <success>false</success>
        <error_msg>ok</error_msg>
        <error_code>200</error_code>
        <total_count>123</total_count>
        <request_id>1</request_id>
        <contents>
            <person_dto>
                <name>张三</name>
                <account_id>1</account_id>
                <avatar>xx.xx/xx.jpg</avatar>
                <avatar_url>xx.xx/xx.jpg</avatar_url>
                <avatar_pre_view_url>xx.xx/xx.jpg</avatar_pre_view_url>
                <nick_name>张三</nick_name>
                <mobile>1213</mobile>
                <passport_account_id>12</passport_account_id>
                <telephone>1132435454</telephone>
            </person_dto>
        </contents>
    </result>
</alibaba_ib_workcore_person_getpersondetail_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部