person/add
目录 |
1.接口说明
1.1接口描述
添加一个新人员
1.2适用版本
支持U8V12.0 及更高版本
2.使用场景
基础数据同步或前端展示
3.接口调用说明
3.1请求说明
| url | https://api.yonyouup.com/api/person/add |
| 格式 | JSON |
| https请求方式 | POST |
| 编码类型 | UTF-8 |
3.2url参数说明
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| from_account | string | 是 | 调用方id |
| to_account | string | 是 | 提供方id |
| app_key | string | 是 | 应用编码 |
| token | string | 是 | api调用唯一识别码 |
| tradeid | string | 是 | 交易唯一识别码，tradeid与biz_id只能传入一个 |
| ds_sequence | number | 否 | 数据源序号（默认取应用的第一个数据源） |
| biz_id | string | 是 | 上游id，需要保证biz_id与ERP主键唯一对应关系，tradeid与biz_id只能传入一个 |
| sync | number | 否 | 0=异步新增（默认）;1=同步新增; |
3.3请求体参数说明
| 参数 | 类型 | 参数路径 | 是否必填 | 描述 |
|---|---|---|---|---|
| code | string | 是 | 人员编码 | |
| name | string | 是 | 人员名称 | |
| cdept_num | string | 是 | 部门编码 | |
| cdept_name | string | 是 | 部门名称 | |
| cpsnproperty | string | 否 | 人员属性 | |
| rsex | string | 是 | 人员性别（1:男 2:女） | |
| cpsnmobilephone | string | 否 | 人员手机号 | |
| cpsnemail | string | 否 | 人员邮箱 | |
| cjobcode | string | 否 | 职位编码 | |
| vjobname | number | 否 | 职位名称 | |
| cpsnpostaddr | string | 否 | 通讯地址 | |
| rpersontype | number | 否 | 人员类型 | |
| rpersontypename | string | 否 | 人员类型名称 | |
| rIDType | number | 是 | 证件类型（0：身份证 1：护照 2：军人证 3：港澳身份证 4：台胞证 9：其他） | |
| rEmployState | number | 是 | 雇佣状态（10：在职 20：离退 30：离职） | |
| cpsnqqcode | number | 否 | QQ号 | |
| vIDNo | string | 否 | 证件号码 | |
| bpsnperson | string | 否 | 0=非业务员；1=业务员； | |
| cdepcode | string | 否 | 业务或费用部门 |
3.4请求示例
POST https://api.yonyouup.com/api/person/add?from_account=openapi_dev&to_account=openapi_ent&app_key=opa6fdd4bea98b95ad7&token=843d03f66e6544e19707ccec11030296&biz_id=0971&ds_sequence=1
POST 内容：
{
"person":{
"cdept_name":"总裁会",
"cdept_num":"01",
"cjobcode":"0101",
"code":"00001",
"cpsnemail":"wming@yonyou.com",
"cpsnmobilephone":"18698085765",
"cuser_id":"demo",
"name":"王铭",
"remploystate":"10",
"ridtype":"1",
"rpersontype":"10",
"rpersontypename":"正式员工",
"rsex":"1",
"vidno":"130903197208072011",
"vjobname":"总裁"
}
}
3.5返回参数说明
| 参数说明 | 类型 | 描述 |
|---|---|---|
| errcode | string | 错误码，0 为正常。 |
| errmsg | string | 错误信息。 |
| id | string | 新增成功后返回人员编号。 |
| tradeid | string | 新增成功后返回交易唯一识别码 |
3.6正确返回示例
JSON示例:
{
"tradeid": "158f3f05730711e591c702004c4f4f50",
"ping_after": "3",
"url": "https://api.yonyouup.com/result?requestid=158f3f05730711e591c702004c4f4f50"
}
上述 api 请求返回信息表示建议客户端 3 秒钟后向 https://api.yonyouup.com/result?requestid=158f3f05730711e591c702004c4f4f50 发送 GET 请求获取真正的 api 调用结果，结果格式如下：
{
"errcode" : "0",
"errmsg" : "",
"id" : "883",
"tradeid" : "158f3f05730711e591c702004c4f4f50"
}
3.7错误返回示例
application/json;charset=UTF-8
{
"errcode" : "30021",
"errmsg" : "此应用未上线"
}