• 同步部门员工数据

    同步部门员工数据

    基地址:baseAddress

    创建部门

    请求方式: > post

    请求地址 > baseAddress/hipspfm/hippius/v1/sync/dept/create?access_token=ACCESS_TOKEN

    参数:

    {
        "parentUnitCode": "00001",
        "unitCode": "00003",
        "unitName": "财务部",
        "orderSeq":"2"
    }
    

    参数说明:

    参数 必须 说明
    access_token 调用接口凭证
    parentUnitCode 父部门编码, 如果没有默认新增根部门
    unitCode 部门编码,唯一不可重复,只能是字母、数字或二者组合,且字母大写
    unitName 部门名称
    orderSeq 父部门内的排序,int类型

    返回结果:

    -- 成功:
    {
        "code": "success",
        "failed": false,
        "message": "成功"
    }
    
    --- 失败
    {
        "failed": true,
        "code": "error.code_repeat",
        "message": "编码重复"
    }
    
    

    参数说明:

    参数 说明
    failed 结果,true:调用失败,false:调用成功
    code 返回码
    message 返回码的文本描述

    修改部门

    请求方式: > put

    请求地址 > baseAddress/hipspfm/hippius/v1/sync/dept/update?access_token=ACCESS_TOKEN

    参数:

    {
        "unitCode": "00003",
        "unitName": "财务部",
        "orderSeq":"2"
    }
    

    参数说明:

    参数 必须 说明
    access_token 调用接口凭证
    unitCode 部门编码
    unitName 部门名称
    orderSeq 父部门中的次序值。order值大的排序靠前,数字类型

    返回结果:

    -- 成功:
    {
        "code": "success",
        "failed": false,
        "message": "成功"
    }
    
    --- 失败
    {
        "failed": true,
        "code": "error.dept_not_exists",
        "message": "部门不存在",
        "type": "warn"
    }
    
    

    参数说明:

    参数 说明
    failed 结果,true:调用失败,false:调用成功
    code 返回码
    message 返回码的文本描述

    删除部门

    请求方式: > delete

    请求地址 > baseAddress/hipspfm/hippius/v1/sync/dept/delete?access_token=ACCESS_TOKEN

    参数:

    {
        "unitCode": "00003"
    }
    

    参数说明:

    参数 必须 说明
    access_token 调用接口凭证
    unitCode 部门编码

    返回结果:

    -- 成功:
    {
        "code": "success",
        "failed": false,
        "message": "成功"
    }
    
    --- 失败
    {
        "failed": true,
        "code": "error.dept_not_exists",
        "message": "部门不存在",
        "type": "warn"
    }
    
    

    参数说明:

    参数 说明
    failed 结果,true:调用失败,false:调用成功
    code 返回码
    message 返回码的文本描述

    新增岗位

    请求方式: > post

    请求地址 > baseAddress/hipspfm/hippius/v1/sync/position/create?access_token=ACCESS_TOKEN

    参数:

    {
        "positionCode": "FIN0001",
        "positionName":"财务总监",
        "unitCode":"00003",
        "orderSeq":"1"
    }
    

    参数说明:

    参数 必须 说明
    access_token 调用接口凭证
    positionCode 岗位编码,唯一不可重复,只能是字母、数字或二者组合,且字母大写
    positionName 岗位名称
    unitCode 部门编码
    orderSeq 岗位顺序,数字

    返回结果:

    -- 成功:
    {
        "code": "success",
        "failed": false,
        "message": "成功"
    }
    
    --- 失败
    {
        "failed": true,
        "code": "error.data_invalid",
        "message": "数据校验不通过",
        "type": "warn"
    }
    
    

    参数说明:

    参数 说明
    failed 结果,true:调用失败,false:调用成功
    code 返回码
    message 返回码的文本描述

    编辑岗位

    请求方式: > put

    请求地址 > baseAddress/hipspfm/hippius/v1/sync/position/update?access_token=ACCESS_TOKEN

    参数:

    {
        "positionCode": "FIN0001",
        "positionName":"财务助理",
        "orderSeq":"2"
    }
    

    参数说明:

    参数 必须 说明
    access_token 调用接口凭证
    positionCode 岗位编码
    positionName 岗位名称
    orderSeq 岗位顺序,数字

    返回结果:

    -- 成功:
    {
        "code": "success",
        "failed": false,
        "message": "成功"
    }
    
    --- 失败
    {
        "failed": true,
        "code": "error.position_not_exists",
        "message": "岗位不存在",
        "type": "warn"
    }
    
    

    参数说明:

    参数 说明
    failed 结果,true:调用失败,false:调用成功
    code 返回码
    message 返回码的文本描述

    新增员工

    请求方式: > post

    请求地址 > baseAddress/hipspfm/hippius/v1/sync/employee/create?access_token=ACCESS_TOKEN

    参数:

    {
        "name":"海马汇",
        "employeeNum":"HIPS001",
        "mobile":"",
        "email":"",
        "gender":"1",
        "status":"ON",
        "list":[
        	{
        		"unitCode":"00003",
        		"positionCode":"FIN0001",
        		"primaryPositionFlag":"1"
        	},{
        		"unitCode":"00002",
        		"positionCode":"HR0001",
        		"primaryPositionFlag":"0"
        	}
        	],
         "propertyInfoDTOS":[
         	{
         		"propertyName":"地址",
         		"infoName":"北京"
         	}
         	]
    }
    

    参数说明:

    参数 必须 说明
    access_token 调用接口凭证
    name 姓名
    employeeNum 员工编码,唯一不可重复,只能是字母、数字或二者组合,且字母大写
    mobile 手机号码
    email 邮箱
    gender 性别,1表示男性, 0表示女性
    status 员工状态 在职:ON,试用:TRIAL,实习:INTERNSHIP,离职:LEAVE
    list 部门和岗位集合 如下表list
    propertyInfoDTOS 额外字段属性值,如下表propertyInfoDTOS,参考通讯录个性化配置

    list:

    参数 必须 说明
    unitCode 部门编码
    positionCode 岗位编码
    primaryPositionFlag 是否主岗,0表示非主岗,1表示主岗位,而且list集合中有且只能有一个主岗位

    propertyInfoDTOS:

    参数 必须 说明
    propertyName 字段名,来自通讯录个性化配置
    infoName 员工对应的值

    返回结果:

    -- 成功:
    {
        "code": "success",
        "failed": false,
        "message": "成功"
    }
    
    --- 失败
    {
        "failed": true,
        "code": "error.code_repeat",
        "message": "编码重复",
        "type": "warn"
    }
    
    

    参数说明:

    参数 说明
    failed 结果,true:调用失败,false:调用成功
    code 返回码
    message 返回码的文本描述

    编辑员工

    请求方式: > put

    请求地址 > baseAddress/hipspfm/hippius/v1/sync/employee/update?access_token=ACCESS_TOKEN

    参数:

    {
        "name":"海马汇",
        "employeeNum":"HIPS001",
        "mobile":"",
        "email":"",
        "gender":"1",
        "status":"ON",
        "list":[
        	{
        		"unitCode":"00003",
        		"positionCode":"FIN0001",
        		"primaryPositionFlag":"1"
        	}
        	],
         "propertyInfoDTOS":[
         	{
         		"propertyName":"地址",
         		"infoName":"北京"
         	}
         	]
    }
    

    参数说明:

    参数 必须 说明
    access_token 调用接口凭证
    name 姓名
    employeeNum 员工编码
    mobile 手机号码
    email 邮箱
    gender 性别,1表示男性, 0表示女性
    status 员工状态 在职:ON,试用:TRIAL,实习:INTERNSHIP,离职:LEAVE
    list 部门和岗位集合,如果有值就会替换已有岗位和部门 字段如下表list
    propertyInfoDTOS 额外字段属性值,如下表propertyInfoDTOS,参考通讯录个性化配置

    list:

    参数 必须 说明
    unitCode 部门编码
    positionCode 岗位编码
    primaryPositionFlag 是否主岗,0表示非主岗,1表示主岗位,而且list集合中有且只能有一个主岗位

    propertyInfoDTOS:

    参数 必须 说明
    propertyName 字段名
    infoName 员工对应的值

    返回结果:

    -- 成功:
    {
        "code": "success",
        "failed": false,
        "message": "成功"
    }
    
    --- 失败
    {
        "failed": true,
        "code": "error.code_repeat",
        "message": "编码重复",
        "type": "warn"
    }
    
    

    参数说明:

    参数 说明
    failed 结果,true:调用失败,false:调用成功
    code 返回码
    message 返回码的文本描述