查询员工列表
基本信息
请求方式:POST
请求地址:/napi/enterprise/member/list
Body参数
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|
msgId | 消息id | Y | String | 128 | 1000120150511190411000001 | 企业编码+消息方向+YYYYMMDDHHMMSS+NNNNNN |
corpCode | 企业编码 | N | String | 50 | 1000 | 不传默认查询租户级数据 |
pageIndex | 页码 | Y | Int | | 1 | |
pageSize | 每页条数 | Y | Int | | 20 | 建议20,上限50 |
duration | 最近更新时间范围 | N | Duration | | | 不填默认查询最近一天 |
Duration
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|
endTime | 结束时间 | Y | String | | 20240606110101 | yyyyMMddHHmmss格式 |
startTime | 开始时间 | Y | String | | 20240605110101 | yyyyMMddHHmmss格式 |
响应参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|
resultCode | 返回码 | Y | String | | 0 | 0表示成功,其他值为失败。 |
description | 描述 | Y | String | | 操作成功 | 描述信息,出错时为错误信息即错误原因。 |
data | 响应数据 | Y | MemberPage | | | |
MemberPage
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|
pageIndex | 页码 | Y | Int | | 1 | |
pageSize | 每页条数 | Y | Int | | 20 | |
totalSize | 总数 | Y | Long | | 100 | |
memberList | 员工列表 | Y | List<Member> | | | |
Member
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|
tenantUserId | 租户用户id | Y | String | 200 | d00xxxxxx | |
name | 姓名 | Y | String | 100 | 张三 | |
familyName | 姓 | N | String | 100 | ZHANG | |
givenName | 名 | N | String | 100 | SAN | |
mobile | 手机号 | N | String | 30 | 155xxxxx111 | |
mobileCountryCode | 手机号归属国家区号 | N | String | 10 | 86 | |
email | 邮箱 | N | String | 200 | zhangsan@huawei.com | |
staffNo | 工号 | N | String | 32 | 00879xxx | |
nation | 国籍 | N | String | 10 | 156 | Itravel系统国家码 |
status | 状态 | Y | String | 1 | 1 | 1:正常 2:冻结 |
extendInfo | 扩展字段 | N | String | | {"字段1":"值1","字段2":"值2"} | 扩展字段-JsonObject |
baseLocation | Base地 | N | BaseLocation | | | |
departmentList | 部门列表 | N | List<Department> | | | |
corpCodeList | 企业编码列表 | Y | List<String> | | ["1000"] | |
BaseLocation
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|
countryId | 国家Id | Y | String | 10 | 156 | Itravel系统国家码 |
countryName | 国家名 | Y | String | 128 | 中国 | |
cityId | 城市Id | Y | String | 10 | 156110100 | Itravel系统城市码 |
cityName | 城市名 | Y | String | 128 | 北京 | |
Department
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|
departmentNo | 部门编码 | Y | String | 50 | A1234 | |
nameCn | 中文名称 | Y | String | 200 | 市场部 | |
nameEn | 英文名称 | N | String | 200 | Marketing Dept. | |
样例
请求
{
"duration": {
"startTime": "20240522101500",
"endTime": "20240624101553"
},
"pageIndex": 1,
"pageSize": 20,
"msgId": "0008120220929071248283828",
"corpCode": "0008"
}
返回
{
"resultCode": "0",
"description": "操作成功",
"data": {
"pageIndex": 1,
"pageSize": 20,
"totalSize": 1,
"memberList": [
{
"tenantUserId": "d00xxxxxx",
"name": "张三",
"familyName": "ZHANG",
"givenName": "SAN",
"mobile": "155xxxxx111",
"mobileCountryCode": "86",
"email": "zhangsan@huawei.com",
"staffNo": "00879xxx",
"nation": "156",
"status": "1",
"extendInfo": "{\"字段1\":\"值1\",\"字段2\":\"值2\"}",
"baseLocation": {
"countryId": "156",
"countryName": "中国",
"cityId": "156320100",
"cityName": "南京"
},
"departmentList": [
{
"departmentNo": "A1234",
"nameCn": "市场部",
"nameEn": "Marketing Dept."
}
],
"corpCodeList": [
"0008"
]
}
]
}
}
错误码
错误码 | 错误描述 |
---|
840000050 | 重复请求 |
840001021 | 企业不存在 |