API开放平台

TIP

# 角色查询接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/role/v1/queryRole/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "role_name": "老板",
    "create_start_date": "2020-12-31",
    "create_end_date": "2099-12-31",
    "data_scope_type": "3",
    "page_number": 1
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
role_name VARCHAR(32) 否 角色名称，可模糊搜索角色名称中含该字段的所有角色
create_start_date CHAR(10) 否 角色创建的起始时间。格式：yyyy-MM-dd
create_end_date CHAR(10) 否 角色创建的终止时间。格式：yyyy-MM-dd
data_scope_type CHAR(1) 否 数据查看范围类型，查询匹配该数据查看范围的角色。0：查看自己及下属的数据，1：查看所有，2：所在部门及下级部门，3：查看指定部门或人员的数据
page_number INT 是 页码默认1。每页默认1000条，最大1000条

响应示例：

{
    "return_code": "0", 
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
     {
         "role_name":"1111",
         "start_date":"2021-04-01",
         "role_desc":"",
         "data_scope_type":"3",
         "end_date":"2099-12-31",
         "create_date":"2021-06-15",
         "scope":[
             {
                 "code":"xuzy1",
                 "name":"张三111",
                 "type":"1"
             },
             {
                 "code":"ceshishanchu02 ceshisc02",
                 "name":"ceshi删除02",
                 "type":"0"
             }
         ]
     }
]

参数说明：

参数 类型 说明
role_name VARCHAR(32) 角色名称
role_desc VARCHAR(2000) 角色描述
data_scope_type CHAR(1) 数据查看范围类型。0：查看自己及下属的数据，1：查看所有，2：所在部门及下级部门，3：查看指定部门或人员的数据
start_date CHAR(10) 角色员工关系创建的起始时间。格式：yyyy-MM-dd
end_date CHAR(10) 角色员工关系创建的终止时间。格式：yyyy-MM-dd
create_date CHAR(10) 角色员工关系的创建时间。格式：yyyy-MM-dd
scope.type CHAR(1) 数据类型。0：部门，1：人员。如果数据查看范围类型为3：查看指定部门或人员的数据，则该子表有数据
scope.name VARCHAR(100) 部门名称/人员姓名。如果数据查看范围类型为3：查看指定部门或人员的数据，则该子表有数据
scope.code VARCHAR(4000) 部门编码/人员登录账号。如果数据查看范围类型为3：查看指定部门或人员的数据，则该子表有数据

# 角色员工关系查询接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/roleUser/v1/queryRoleUser/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"role_name":"超级表单",
	"emp_code":"19999999999",
    "page_number":1
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
role_name VARCHAR(32) 否 角色名称，可模糊搜索角色名称中含该字段的所有角色
emp_code VARCHAR(100) 否 员工登录账号，可模糊搜索员工登录账号中含该字段的所有员工账号
page_number INT 是 页数，每页默认1000条

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "role_name":"超级表单",
        "end_date":"2099-12-31",
        "emp_code":"19999999999",
        "star_date":"2021-04-01"
    }
]

参数说明：

参数 类型 说明
role_name VARCHAR(32) 角色名称
emp_code VARCHAR(100) 员工登录账号
start_date CHAR(10) 角色员工关系有效期的起始时间。格式：yyyy-MM-dd
end_date CHAR(10) 角色员工关系有效期的终止时间。格式：yyyy-MM-dd

# 岗位新增接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/job/v1/addJob/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "job_id":"1",
    "job_code": "kaifa",
    "job_name":"开发",
    "job_status":"1",
    "job_sequence":"1",
    "notes":"开发"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
job_id VARCHAR(100) 是 来源第三方系统的岗位唯一ID
job_code VARCHAR(100) 是 岗位编码，必须唯一
job_name VARCHAR(100) 是 岗位名称，必须唯一
job_status VARCHAR(1) 否 岗位状态。1：启用，2：停用。默认值为1
notes VARCHAR(32) 否 备注
job_sequence VARCHAR(32) 是 岗位序号，顺序排列

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

异常示例：

{
  "return_code": "1",
  "return_msg": "来源第三方系统的岗位唯一ID已经存在！",
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 岗位修改接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/job/v1/updateJob/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "job_id":"1",
    "waiqin365_job_id":"1",
    "job_code": "kaifa",
    "job_name":"开发",
    "job_status":"1",
    "job_sequence":"1",
    "notes":"开发"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
job_id VARCHAR(100) 否 来源于第三方系统的岗位唯一ID，对应新增岗位 (job_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。 调用此接口时该字段值(job_id)和勤策的岗位唯一ID(waiqin365_job_id)作为更新数据的唯一标识，所以不能同时为空， 如果两个值同时存在则优先顺序为waiqin365_job_id、job_id
waiqin365_job_id VARCHAR(100) 否 岗位ID，和来源于第三方系统岗位唯一ID(job_id)作为更新数据的唯一标识，所以不能同时为空
job_code VARCHAR(100) 是 岗位编码，必须唯一
job_name VARCHAR(100) 是 岗位名称，必须唯一
job_status VARCHAR(1) 否 岗位状态。1：启用，2：停用，0：删除。默认值为1
notes VARCHAR(32) 否 备注
job_sequence VARCHAR(32) 是 岗位序号，顺序排列

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

异常示例：

{
  "return_code": "1",
  "return_msg": "来源第三方系统的岗位唯一ID不能同时为空！",
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 岗位查询接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/job/v1/queryJob/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "waiqin365_job_id":"1",
    "job_code": "kaifa",
    "job_name":"开发",
    "job_status":"1",
    "create_date":"2021-08-09",
    "modify_date":"2021-08-09"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
job_id VARCHAR(100) 否 来源于第三方系统的岗位唯一ID，对应新增岗位 (job_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。 调用此接口时该字段值(job_id)和勤策的岗位唯一ID(waiqin365_job_id)作为更新数据的唯一标识，所以不能同时为空， 如果两个值同时存在则优先顺序为waiqin365_job_id、job_id
waiqin365_job_id VARCHAR(100) 否 岗位ID，和来源于第三方系统岗位唯一ID(job_id)作为更新数据的唯一标识，所以不能同时为空
job_code VARCHAR(100) 否 岗位编码，必须唯一
job_name VARCHAR(100) 否 岗位名称，必须唯一
job_status VARCHAR(1) 否 岗位状态。1：启用，2：停用，0：删除。默认值为1
notes VARCHAR(32) 否 备注
job_sequence VARCHAR(32) 否 岗位序号，顺序排列
create_date VARCHAR(32) 否 根据创建日期查询岗位。格式：yyyy-MM-dd
modify_date VARCHAR(32) 否 根据修改日期查询岗位。格式：yyyy-MM-dd

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "waiqin365_job_id":"9037794779624736886",
        "job_code":"1",
        "job_name":"ceshi",
        "job_status":"1",
        "job_sequence":"0",
        "create_date":"2021-08-02 17:13:55",
        "modify_date":"2021-08-28 17:04:04",
        "notes":"",
        "job_id": "8634678340679716255"
    }
]

参数说明：

参数 类型 说明
job_id VARCHAR(64) 来源于第三方系统的岗位唯一ID，对应新增岗位 (job_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。
waiqin365_job_id VARCHAR(64) 岗位ID，勤策的岗位唯一标识
job_code VARCHAR(100) 岗位编码
job_name VARCHAR(100) 岗位名称
job_status CHAR(1) 岗位状态。1：启用，2：停用，0：删除
job_sequence VARCHAR(15) 岗位序号，角色员工关系有效期的终止时间。格式：yyyy-MM-dd
create_date VARCHAR(32) 创建时间。格式：yyyy-MM-dd
modify_date VARCHAR(32) 修改时间。格式：yyyy-MM-dd
notes VARCHAR(32) 备注

# 岗位删除接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/job/v1/deleteJob/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "job_id":"1"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
job_id VARCHAR(100) 是 来源第三方系统的岗位唯一ID

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

异常示例：

{
  "return_code": "1",
  "return_msg": "来源第三方系统的岗位唯一ID不存在！",
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 职务新增接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/position/v1/addPosition/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "position_id":"1",
    "position_code": "kaifa",
    "position_name":"开发",
    "position_status":"1",
    "position_sequence":"1",
    "notes":"开发"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
position_id VARCHAR(100) 是 来源第三方系统的职务唯一ID
position_code VARCHAR(100) 是 职务编码，必须唯一
position_name VARCHAR(100) 是 职务名称，必须唯一
position_status VARCHAR(1) 否 职务状态。1：启用，2：停用。默认值为1
notes VARCHAR(32) 否 备注
position_sequence VARCHAR(32) 是 职务序号，顺序排列

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

异常示例：

{
  "return_code": "1",
  "return_msg": "来源第三方系统的职务唯一ID已经存在！",
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 职务修改接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/position/v1/updatePosition/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "position_id":"1",
    "waiqin365_position_id":"1",
    "position_code": "kaifa",
    "position_name":"开发",
    "position_status":"1",
    "position_sequence":"1",
    "notes":"开发"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
position_id VARCHAR(100) 否 来源于第三方系统的职务唯一ID，对应新增职务 (position_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。 调用此接口时该字段值(position_id)和勤策的职务唯一ID(waiqin365_position_id)作为更新数据的唯一标识，所以不能同时为空， 如果两个值同时存在则优先顺序为waiqin365_position_id、position_id
waiqin365_position_id VARCHAR(100) 否 职务ID，和来源于第三方系统职务唯一ID(position_id)作为更新数据的唯一标识，所以不能同时为空
position_code VARCHAR(100) 是 职务编码，必须唯一
position_name VARCHAR(100) 是 职务名称，必须唯一
position_status VARCHAR(1) 否 职务状态。1：启用，2：停用，0：删除。默认值为1
notes VARCHAR(32) 否 备注
position_sequence VARCHAR(32) 是 职务序号，顺序排列

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

异常示例：

{
  "return_code": "1",
  "return_msg": "来源第三方系统的职务唯一ID不能同时为空！",
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 职务查询接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/position/v1/queryPosition/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "waiqin365_position_id":"1",
    "position_code": "kaifa",
    "position_name":"开发",
    "position_status":"1",
    "create_date":"2021-08-09",
    "modify_date":"2021-08-09"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
position_id VARCHAR(100) 否 来源于第三方系统的职务唯一ID，对应新增职务 (position_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。 调用此接口时该字段值(position_id)和勤策的职务唯一ID(waiqin365_position_id)作为更新数据的唯一标识，所以不能同时为空， 如果两个值同时存在则优先顺序为waiqin365_position_id、position_id
waiqin365_position_id VARCHAR(100) 否 职务ID，和来源于第三方系统职务唯一ID(position_id)作为更新数据的唯一标识，所以不能同时为空
position_code VARCHAR(100) 否 职务编码，必须唯一
position_name VARCHAR(100) 否 职务名称，必须唯一
position_status VARCHAR(1) 否 职务状态。1：启用，2：停用，0：删除。默认值为1
notes VARCHAR(32) 否 备注
position_sequence VARCHAR(32) 否 职务序号，顺序排列
create_date VARCHAR(32) 否 根据创建日期查询职务。格式：yyyy-MM-dd
modify_date VARCHAR(32) 否 根据修改日期查询职务。格式：yyyy-MM-dd

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "waiqin365_position_id":"9037794779624736886",
        "position_code":"1",
        "position_name":"ceshi",
        "position_status":"1",
        "position_sequence":"0",
        "create_date":"2021-08-02 17:13:55",
        "modify_date":"2021-08-28 17:04:04",
        "notes":"",
        "position_id": "8634678340679716255"
    }
]

参数说明：

参数 类型 说明
position_id VARCHAR(64) 来源于第三方系统的职务唯一ID，对应新增职务 (position_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。
waiqin365_position_id VARCHAR(64) 职务ID，勤策的职务唯一标识
position_code VARCHAR(100) 职务编码
position_name VARCHAR(100) 职务名称
position_status CHAR(1) 职务状态。1：启用，2：停用，0：删除
position_sequence VARCHAR(15) 职务序号，角色员工关系有效期的终止时间。格式：yyyy-MM-dd
create_date VARCHAR(32) 创建时间。格式：yyyy-MM-dd
modify_date VARCHAR(32) 修改时间。格式：yyyy-MM-dd
notes VARCHAR(32) 备注

# 职务删除接口

请求方式： POST（HTTPS）
请求地址： https://{region}/api/position/v1/deletePosition/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "position_id":"1"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
position_id VARCHAR(100) 是 来源第三方系统的职务唯一ID

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

异常示例：

{
  "return_code": "1",
  "return_msg": "来源第三方系统的职务唯一ID不存在！",
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": null
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

← 注销账号记录接口 →