开发者中心

成员管理

成员管理

新增员工信息

接口URL

/adduserinfo

请求参数定义

参数名参数说明必填参数类型长度值举例备注
Version版本号YString103.0固定为3.0。
MsgID唯一标识YString1281000120150511190411000001企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN
CorpCode操作企业账号YString50企业账号
TenantUserId操作人帐号YString200HW_0000011、如果是系统维护，写"sysadmin"
2、如果是普通员工维护，写员工id
Employee员工信息YEmployeeAdd

EmployeeAdd

参数名参数说明必填参数类型长度值举例备注
TenantUserId租户用户idYString200zhangsan员工唯一标识ID，企业内唯一。格式为英文字母、数字和下划线
Name中文姓名YString100张三中文姓名与英文姓名必填其一。如果国内出差，必填。
Surname英文姓NString100Zhang中文姓名与英文姓名必填其一。如果国际出差，必填。
GivenName英文名NString100San如果国际出差，必填。
Gender性别NString2MM：男（默认），F：女
Nationality国籍NString10156预订国际机票和国际酒店必填，填写Itravel系统国家ID。中国:156
Birthday生日NString1019881111格式为yyyyMMdd
Mailbox邮箱YString200zhangsan@huawei.com为企业的员工时必填，用于接收初始密码
Cellphone手机号YString1613710001000企业内唯一
MobileCountryCode手机号归属国家区号NString1086不带+号的手机号归属国家区号；若此字段未传值且Cellphone为中国大陆手机号，默认赋值为86(中国)
Telephone座机电话NString128075528560000
EmployeeNum员工工号NString3212345企业内部的员工工号，企业内唯一
Status员工状态NString111:正常（默认），2:冻结
ExtInfo扩展字段NString5120{"data":"123"}同步时务必保证差旅平台内已创建所有扩展字段类型标识和中文名称；填写格式为｛"扩展字段类型标识"："扩展字段类型值"}
PlatformUserId平台用户idNString200第三方（钉钉、welink等）平台用户id。企业内唯一。格式为英文字母、数字和下划线
Type乘客类型NString100：成人(默认)，1：儿童，2：婴儿
机票信息需携带,酒店则不做要求
EmployeeLevel员工差旅级别NString21举例：1,2,3,4
在系统中配置的按数字大小排序的级别。如不传递，则以系统系统中配置的员工差旅级别为准。
Remark备注NString100100字以内
NeedApproval是否需审批NString100：不需要审批，1：需要审批
为0时，支持本人进行无申请单预定或给他人进行无申请单预定；为1时，本人必须存在申请单才可预定，且不支持为他人进行无申请单预定。
BaseLocationBase地信息NBaseLocationBase地信息
DeptNum主部门编号YString501234主部门视为默认部门，企业内唯一，格式为英文字母、数字、下划线、中划线和英文点
DeptName主部门名称YString200市场部主部门视为默认部门，同一父部门下的部门名称不能重复
DeptList员工所属部门列表YList<Dept>员工所属部门列表。员工有多个部门时，若未传参“主部门信息”，则默认取第一个部门为主部门
CertificateInfoList证件信息NList<Certificate>
RoleGroupList角色组列表NList<RoleGroup>角色组列表

响应参数定义

参数名参数说明必填参数类型长度值举例备注
ResultCode返回码YString00表示成功，其他值为失败。注意重复创建的处理逻辑：系统直接返回，不做处理
Description描述YStringSuccess描述信息，出错时为错误信息即错误原因。

样例

请求

{
  "Version": "3.0",
  "MsgID": "0008120220929071248283828",
  "CorpCode": "0008",
  "TenantUserId": "sysadmin",
  "Employee": {
    "TenantUserId":"26215236521",
    "Name": "颜敏",
    "Surname": "YAN",
    "GivenName": "MIN",
    "Gender": "M",
    "Nationality": "156",
    "Birthday": "19881111",
    "Mailbox": "yanmin@**.com",
    "Cellphone": "18500000001",
    "MobileCountryCode": "86",
    "Telephone": null,
    "EmployeeNum": "10234118",
    "Status": "1",
    "ExtInfo": "{\"settlementUnitCode\":\"112233\",\"settlementUnitName\":\"结算单位\"}",
    "PlatformUserId": "platform_user_id",
    "Type": "0",
    "EmployeeLevel": "1",
    "Remark": "员工备注信息",
    "BaseLocation": {
      "CountryID":"156", 
      "CityID":"156310100"
    },
    "DeptNum": "Num_001",
    "DeptName": "产品与解决方案",
    "DeptList": [{
      "DeptNum": "Num_001",
      "DeptName": "产品与解决方案"
    }],
    "CertificateInfoList": [{
      "CertificateType": "1",
      "CertificateNum": ""
    }],
    "RoleGroupList": [{
      "Name": "职级",
      "RoleList": [{
        "Name": "领导"
      }]
    }]
  }
}

返回

{
    "ResultCode": "0",
    "Description": "Success"
}

修改员工信息

接口URL

/modiuserinfo

请求参数定义

参数名参数说明必填参数类型长度值举例备注
Version版本号YString103.0固定为3.0。
MsgID唯一标识YString1281000120150511190411000001企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN
CorpCode操作企业账号YString50企业账号
TenantUserId操作人帐号YString200HW_0000011、如果是系统维护，写"sysadmin"
2、如果是普通员工维护，写员工id
Employee员工信息YEmployeeModify

EmployeeModify

参数名参数说明必填参数类型长度值举例备注
TenantUserId租户用户idYString200zhangsan员工唯一标识ID，企业内唯一。格式为英文字母、数字和下划线
Name中文姓名NString100张三
Surname英文姓NString100Zhang
GivenName英文名NString100San
Gender性别NString2MM：男（默认），F：女
Nationality国籍NString10156预订国际机票和国际酒店必填，填写Itravel系统国家ID。中国:156
Birthday生日NString1019881111格式为yyyyMMdd
Mailbox邮箱NString200zhangsan@huawei.com
Cellphone手机号NString1613710001000
MobileCountryCode手机号归属国家区号NString1086不带+号的手机号归属国家区号；若此字段未传值且Cellphone为中国大陆手机号，默认赋值为86(中国)
Telephone座机电话NString128075528560000
EmployeeNum员工工号NString3212345企业内部的员工工号，企业内唯一
Status员工状态NString111:正常（默认），2:冻结
ExtInfo扩展字段NString5120{"data":"123"}同步时务必保证差旅平台内已创建所有扩展字段类型标识和中文名称；填写格式为｛"扩展字段类型标识"："扩展字段类型值"}
PlatformUserId平台用户idNString200第三方（钉钉、welink等）平台用户id。企业内唯一。格式为英文字母、数字和下划线
若平台用户id已存在则不支持修改。
Type乘客类型NString100：成人(默认)，1：儿童，2：婴儿
机票信息需携带,酒店则不做要求
EmployeeLevel员工差旅级别NString21举例：1,2,3,4
在系统中配置的按数字大小排序的级别。如不传递，则以系统系统中配置的员工差旅级别为准。
Remark备注NString100100字以内
NeedApproval是否需审批NString100：不需要审批，1：需要审批
为0时，支持本人进行无申请单预定或给他人进行无申请单预定；为1时，本人必须存在申请单才可预定，且不支持为他人进行无申请单预定。
BaseLocationBase地信息NBaseLocationBase地信息
DeptNum主部门编号NString501234主部门视为默认部门，企业内唯一；格式为英文字母、数字、下划线、中划线和英文点
DeptName主部门名称NString200市场部主部门视为默认部门，同一父部门下的部门名称不能重复
DeptList员工所属部门列表NList<Dept>员工所属部门列表。员工有多个部门时，若未传参“主部门信息”，则默认取第一个部门为主部门
CertificateInfoList证件信息NList<Certificate>
RoleGroupList角色组列表NList<RoleGroup>角色组列表

响应参数定义

参数名参数说明必填参数类型长度值举例备注
ResultCode返回码YString00表示成功，其他值为失败。
Description描述YStringSuccess描述信息，出错时为错误信息即错误原因。

样例

请求

{
  "Version": "3.0",
  "MsgID": "0008120220929071248283828",
  "CorpCode": "0008",
  "TenantUserId": "sysadmin",
  "Employee": {
    "TenantUserId":"26215236521",
    "Name": "颜敏",
    "Surname": "YAN",
    "GivenName": "MIN",
    "Gender": "M",
    "Nationality": "156",
    "Birthday": "19881111",
    "Mailbox": "yanmin@**.com",
    "Cellphone": "18500000001",
    "MobileCountryCode": "86",
    "Telephone": null,
    "EmployeeNum": "10234118",
    "Status": "1",
    "ExtInfo": "{\"settlementUnitCode\":\"112233\",\"settlementUnitName\":\"结算单位\"}",
    "PlatformUserId": "platform_user_id",
    "Type": "0",
    "EmployeeLevel": "1",
    "Remark": "员工备注信息",
    "BaseLocation": {
      "CountryID":"156",
      "CityID":"156310100"
    },
    "DeptNum": "Num_001",
    "DeptName": "产品与解决方案",
    "DeptList": [{
      "DeptNum": "Num_001",
      "DeptName": "产品与解决方案"
    }],
    "CertificateInfoList": [{
      "CertificateType": "1",
      "CertificateNum": ""
    }],
    "RoleGroupList": [{
      "Name": "职级",
      "RoleList": [{
        "Name": "领导"
      }]
    }]
  }
}

返回

{
    "ResultCode": "0",
    "Description": "Success"
}

删除员工信息

调用该接口后，员工信息会被软删除。

接口URL

/deluserinfo

请求参数定义

参数名参数说明必填参数类型长度值举例备注
Version版本号YString103.0固定为3.0。
MsgID唯一标识YString1281000120150511190411000001企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN
CorpCode操作企业账号YString50企业账号
TenantUserId操作人帐号YString200HW_0000011、如果是系统维护，写"sysadmin"
2、如果是普通员工维护，写员工id
EmployeeTenantUserId租户用户idYString200员工唯一标识ID

响应参数定义

参数名参数说明必填参数类型长度值举例备注
ResultCode返回码YString00表示成功，其他值为失败。
Description描述YStringSuccess描述信息，出错时为错误信息即错误原因。

样例

请求

{
  "Version": "3.0",
  "MsgID": "0008120220929071248283828",
  "CorpCode": "0008",
  "TenantUserId": "sysadmin",
  "EmployeeTenantUserId": "10215118"
}

返回

{
    "ResultCode": "0",
    "Description": "Success"
}

查询员工信息

通过该接口查询用户详情。

接口URL

/employee/detail/query

请求参数定义

参数名参数说明必填参数类型长度值举例备注
Version版本号YString103.0固定为3.0。
MsgID唯一标识YString1281000120150511190411000001企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN
CorpCode操作企业账号YString500001企业账号
TenantUserId操作人帐号YString200HW_0000011、如果是系统维护，写"sysadmin"
2、如果查询具体员工，写员工id
EmployeeNum企业内部的员工工号NString3212345当TenantUserId为sysadmin时，此字段生效，且EmployeeNum和Mobile必填其一
Mobile企业内部的员工手机号NString3013055051111当TenantUserId为sysadmin时，此字段生效，且EmployeeNum和Mobile必填其一

响应参数定义

参数名参数说明必填参数类型长度值举例备注
ResultCode返回码YString00表示成功
Description描述YStringSuccess描述信息，出错时为错误信息即错误原因。
EmployeeDetailList员工详情YList<EmployeeDetail>包含LoginName /Name/EmployeeNum/EmployeeUID等字段

EmployeeDetail

参数名参数说明必填参数类型长度值举例备注
CorpCode企业账号YString501000系统提供的企业账号
CorpName企业名称YString200xxx有限公司系统提供的企业账号
EmployeeList员工信息YList<Employee>包含TenantUserId/Name/EmployeeNum/EmployeeUID等字段

Employee

参数名参数说明必填参数类型长度值举例备注
TenantUserId租户用户idYString200zhangsan员工唯一标识ID，企业内唯一。格式为英文字母、数字和下划线
Name中文姓名NString100张三
Surname英文姓NString100Zhang
GivenName英文名NString100San如果国际出差，必填。
Gender性别NString2MM：男（默认），F：女
Nationality国籍NString10156预订国际机票和国际酒店必填，填写Itravel系统国家ID。中国:156
Birthday生日NString1019881111格式为yyyyMMdd
Mailbox邮箱YString200zhangsan@huawei.com为企业的员工时必填，用于接收初始密码
Cellphone手机号YString1613710001000企业内唯一
MobileCountryCode手机号归属国家区号NString1086不带+号的手机号归属国家区号；若此字段未传值且Cellphone为中国大陆手机号，默认赋值为86(中国)
Telephone座机电话NString128075528560000
EmployeeNum员工工号NString3212345企业内部的员工工号，企业内唯一
Status员工状态YString111:正常,2:冻结,3:删除
ExtInfo扩展字段NString5120{"data":"123"}同步时务必保证差旅平台内已创建所有扩展字段类型标识和中文名称；填写格式为｛"扩展字段类型标识"："扩展字段类型值"}
PlatformUserId平台用户idNString200第三方（钉钉、welink等）平台用户id。企业内唯一。格式为英文字母、数字和下划线
Type乘客类型NString100：成人(默认)，1：儿童，2：婴儿
机票信息需携带,酒店则不做要求
EmployeeLevel员工差旅级别NString21举例：1,2,3,4
在系统中配置的按数字大小排序的级别。如不传递，则以系统系统中配置的员工差旅级别为准。
EmployeeVIPLevel员工VIP级别NString211：VIP
Remark备注NString100100字以内
NeedApproval是否需审批NString100：不需要审批，1：需要审批
为0时，支持本人进行无申请单预定或给他人进行无申请单预定；为1时，本人必须存在申请单才可预定，且不支持为他人进行无申请单预定。
BaseLocationBase地信息NBaseLocalDetailBase地信息
DeptNum主部门编号NString501234主部门视为默认部门,企业内唯一
DeptName主部门名称NString200市场部主部门视为默认部门，同一父部门下的部门名称不能重复
DeptList员工所属部门列表NList<Dept>员工所属部门列表。员工有多个部门时，若未传参“主部门信息”，则默认取第一个部门为主部门
CertificateInfoList证件信息NList<Certificate>
RoleGroupList角色组列表NList<RoleGroup>角色组列表

BaseLocalDetail

参数名参数说明必填参数类型长度值举例备注
CountryID国家或区域IdYString3156Itravel系统国家码
CountryEnglishName国家或区域英文名称NStringChinese
CountryChineseName国家或区域中文名称NString中国
CityID城市IdYString10156310100Itravel系统城市码
CityEnglishName城市英文名称NStringShanghai
CityChineseName城市中文名称NString上海

样例

请求

{
  "Version": "3.0",
  "MsgID": "0008120220929071248283828",
  "CorpCode": "0008",
  "TenantUserId": "sysadmin",
  "EmployeeNum": "10234118",
  "Mobile": "18500000001"
}

返回

{
  "ResultCode": "0",
  "Description": "Success",
  "EmployeeDetailList": [
    {
      "CorpCode": "0008",
      "CorpName": "xxx有限公司",
      "EmployeeList": [
        {
          "TenantUserId": "10215118",
          "Name": "颜敏",
          "Surname": "YAN",
          "GivenName": "MIN",
          "Gender": "M",
          "Type": "0",
          "Nationality": "156",
          "Birthday": "19881111",
          "Mailbox": "yanmin@**.com",
          "Cellphone": "18500000001",
          "MobileCountryCode": "86",
          "Telephone": null,
          "CertificateInfoList": [
            {
              "CertificateType": "1",
              "CertificateNum": ""
            }
          ],
          "DeptList": [
            {
              "DeptNum": "1",
              "DeptName": "产品与解决方案"
            }
          ],
          "EmployeeNum": "10234118",
          "EmployeeUID": "1011118",
          "RoleGroupList": [
            {
              "Name": "职级",
              "RoleList": [
                {
                  "Name": "领导"
                }
              ]
            }
          ],
          "EmployeeLevel": "1",
          "EmployeeVIPLevel": null,
          "Remark": null,
          "ExtInfo": "{\"settlementUnitCode\":\"112233\",\"settlementUnitName\":\"结算单位\"}",
          "BaseLocation": null
        }
      ]
    }
  ]
}

变更员工归属子公司

此接口专用于集团公司中员工切换不同子公司使用，此集团中的不同子公司在系统中可能有不同企业账号、企业密码和证书。

如果是同一个公司内的员工信息变更，必须使用“修改员工信息接口”，不能使用本接口进行变更。

接口说明：
1、该信息将完全覆盖系统系统中的员工信息。如果级别、工号等变更，需要重新提供，否则员工此部分数据将缺失，可能影响对账。
2、部门信息必要要传入新部门的信息，不传信息也会清空原有部门信息
3、员工证件信息列表为空，则保持员工证件信息不变，如需要更新则传递指定证件类型的证件信息。

接口URL

/changesubcompany

请求参数定义

参数名参数说明必填参数类型长度值举例备注
Version版本号YString103.0固定为3.0。
MsgID唯一标识YString1281000120150511190411000001企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN
CorpCode操作企业账号YString50企业账号
TenantUserId操作人帐号YString200HW_0000011、如果是系统维护，写"sysadmin"
2、如果是普通员工维护，写员工id
OldTenantUserId旧员工租户用户idYString200原子公司的员工租户用户id
OldCorpCode旧企业账号YString501000变更前的企业账号
Employee新员工信息YEmployeeChangeCompany注意查看接口说明
NewCorpCode新企业账号YString501000变更后的企业账号

EmployeeChangeCompany

参数名参数说明必填参数类型长度值举例备注
TenantUserId租户用户idYString200zhangsan员工唯一标识ID，企业内唯一。格式为英文字母、数字和下划线
Name中文姓名NString100张三
Surname英文姓NString100Zhang
GivenName英文名NString100San
Gender性别NString2MM：男,F：女
Nationality国籍NString10156预订国际机票和国际酒店必填，填写Itravel系统国家ID。中国:156
Birthday生日NString1019881111格式为yyyyMMdd
Mailbox邮箱NString200zhangsan@huawei.com
Cellphone手机号NString1613710001000企业内唯一
MobileCountryCode手机号归属国家区号NString1086不带+号的手机号归属国家区号；若此字段未传值且Cellphone为中国大陆手机号，默认赋值为86(中国)
Telephone座机电话NString128075528560000
EmployeeNum员工工号NString3212345企业内部的员工工号，企业内唯一
EmployeeLevel员工差旅级别NString21举例：1,2,3,4
在系统中配置的按数字大小排序的级别。如不传递，则以系统系统中配置的员工差旅级别为准。
Remark备注NString100100字以内
DeptNum主部门编号YString501234主部门视为默认部门,部门编号企业内唯一
DeptName主部门名称YString200市场部主部门视为默认部门，同一父部门下的部门名称不能重复
CertificateInfoList证件信息NList<Certificate>

响应参数定义

参数名参数说明必填参数类型长度值举例备注
ResultCode返回码YString00表示成功，其他值为失败。
Description描述YStringSuccess描述信息，出错时为错误信息即错误原因。

样例

请求

{
  "Version": "3.0",
  "MsgID": "0008120220929071248283828",
  "CorpCode": "0008",
  "TenantUserId": "sysadmin",
  "OldTenantUserId": "10215118",
  "OldCorpCode": "0007",
  "Employee": {
    "TenantUserId":"26215236521",
    "Name": "颜敏",
    "Surname": "YAN",
    "GivenName": "MIN",
    "Gender": "M",
    "Nationality": "156",
    "Birthday": "19881111",
    "Mailbox": "yanmin@**.com",
    "Cellphone": "18500000001",
    "MobileCountryCode": "86",
    "Telephone": null,
    "EmployeeNum": "10234118",
    "EmployeeLevel": "1",
    "Remark": null,
    "DeptNum": "main_dept_no",
    "DeptName": "主部门名称",
    "CertificateInfoList": [{
      "CertificateType": "1",
      "CertificateNum": ""
    }]
  },
  "NewCorpCode": "0008"
}

返回

{
    "ResultCode": "0",
    "Description": "Success"
}

数据字典

BaseLocation

参数名参数说明必填参数类型长度值举例备注
CountryID国家或区域IdYString3156Itravel系统国家码
CityID城市IdYString10156310100Itravel系统城市码

Dept

参数名参数说明必填参数类型长度值举例备注
DeptNum部门编号YString501234部门标识字段，开发者可用该字段来唯一标识一个部门，与差旅系统部门做映射。
格式为英文字母、数字和下划线
DeptName部门名称YString200市场部同一父部门下的部门名称不能重复
DeptDescription部门描述NString300市场部
UpperDeptNum上级部门编号NString505678为空表示为一级部门

Certificate

参数名参数说明必填参数类型长度值举例备注
CertificateType证件类型YString211:身份证,2:护照,3:其他,4:台湾通行证,5:回乡证,6:港澳通行证,7:台胞证,8:户口簿,9:出生证明,10:港澳台居民证,11:外国人永久居留证,12:军人证,13:旅行证
CertificateNum证件号码YString12835222519771081001X
ExpiredDate有效期NString2020180811证件类型为2(护照)时建议填写，作为护照失效日期。格式为yyyyMMdd
PassportIssueDate护照签发日期NString2020180811113019格式为yyyyMMddHHmmss
PassportIssueCountry护照签发国家NString3156Itravel系统国家码。
PassportIssueProvince护照签发省份NString字符串，比如"Jiangsu"。

RoleGroup

参数名参数说明必选参数类型长度值举例备注
Name角色组名YString职级
RoleList角色列表YList<Role>

Role

参数名参数说明必选参数类型长度值举例备注
Name角色名YString科长、职员