# 部门接口

# 新增部门

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/organization/v1/addOrganization/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "org_id":"ORG00001",
    "org_code":"waiqin00001",
    "org_name":"南京掌控网络",
    "org_parent_id":"",
    "waiqin365_parent_id":"",
    "org_sequence":20,
    "org_status":"1"
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
org_id VARCHAR(32) 来源第三方系统的部门唯一ID
org_code VARCHAR(100) 部门编码,必须唯一
org_name VARCHAR(100) 部门名称。同一部门下的子部门的名称不能重复
org_parent_id VARCHAR(32) 来源第三方系统的上级部门唯一ID,如果与勤策(原外勤365)上级部门唯一标识同时存在,优先获取waiqin365_parent_id
waiqin365_parent_id VARCHAR(20) 勤策(原外勤365)上级部门唯一标识,默认值为-1
org_sequence NUMBER(20) 排序号,顺序排列
org_status CHAR(1) 部门状态。0:删除,1:正常。默认值为1

响应示例:

{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":""
}

异常示例:

{
    "msg_id":"X000001",
    "return_code":100101,
    "return_msg":"部门唯一标识已经存在!值为:ORG00001"
}               

参数说明:

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

# 修改部门

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/organization/v1/modifyOrganization/{openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "org_id":"ORG00001",
    "id":"ORG00001",
    "org_code":"waiqin00001",
    "org_name":"南京掌控网络",
    "org_parent_id":"ORG001",
    "waiqin365_parent_id":"ORG002",
    "org_sequence":20,
    "org_status":"1"
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
org_id VARCHAR(32) 来源于第三方系统的部门唯一ID,对应新增部门 (org_id)字段,只有当数据来源于新增接口时才有值,如果数据从勤策(原外勤365)系统中直接创建则该字段值为空。 调用此接口时该字段值(org_id)和勤策(原外勤365)的部门唯一ID(id)作为更新数据的唯一标识,所以不能同时为空, 如果两个值同时存在则优先顺序为idorg_id
id VARCHAR(32) 勤策(原外勤365)的部门唯一ID,和来源于第三方系统部门唯一ID(org_id)作为更新数据的唯一标识,所以不能同时为空
org_code VARCHAR(100) 部门编码,必须唯一
org_name VARCHAR(100) 部门名称。同一部门下的子部门的名称不能重复
org_parent_id VARCHAR(32) 来源第三方系统的上级部门唯一ID,如果与勤策(原外勤365)上级部门唯一标识同时存在,优先获取waiqin365_parent_id
waiqin365_parent_id VARCHAR(20) 勤策(原外勤365)上级部门唯一标识,默认值为-1
org_sequence NUMBER(20) 排序号,顺序排列
org_status CHAR(1) 部门状态。0:删除,1:正常。默认值为1

响应示例:

{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":""
}

异常示例:

{
    "msg_id":"X000001",
    "return_code":100103,
    "return_msg":"部门唯一标识不存在!值为:ORG001"
}              

参数说明:

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

# 删除部门

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/organization/v1/removeOrganization/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "org_id":"ORG00001"
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
org_id VARCHAR(32) 来源于第三方系统的部门唯一ID,对应新增部门 (org_id)字段,只有当数据来源于新增接口时才有值,如果数据从勤策(原外勤365)系统中直接创建则该字段值为空

响应示例:

{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":""
}
                  

参数说明:

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

# 查询部门

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/organization/v1/queryOrganization/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "org_id": "ORG00001"
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
id VARCHAR(20) 根据勤策(原外勤365)的部门唯一ID精确查询,org_id、id如果同时存在优先取id
org_id VARCHAR(32) 根据来源第三方系统部门唯一标识ID查询,对应新增部门 (org_id)字段,只有当数据来源于新增接口时才有值,如果数据从勤策(原外勤365)系统中直接创建则该字段值为空。
org_code VARCHAR(100) 根据部门编码精确查询
org_name VARCHAR(100) 根据部门名称精确查询
org_status CHAR(1) 根据部门状态查询。0:删除,1:正常
create_date CHAR(10) 根据创建日期查询数据。格式:yyyy-MM-dd
modify_date CHAR(10) 根据修改日期查询数据。格式:yyyy-MM-dd

响应示例:

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
        {
            "id": "10",
            "org_id": "ORG001",
            "org_name": "南京掌控网络",
            "waiqin365_parent_id": "-1",
            "org_parent_id": "",
            "parent_code": "",
            "parent_name": "",
            "full_ids": "/10",
            "full_codes": "/DD001",
            "full_names": "/南京掌控网络",
            "org_sequence": "0",
            "org_status": "1",
            "org_code": "DD001",
            "create_time": "2017-09-09 13:14:11",
            "modify_time": "2018-09-09 13:14:11"
        },
        {
            "id": "6875557051887001077",
            "org_id": "ORG00101",
            "org_name": "市场部",
            "waiqin365_parent_id": "10",
            "org_parent_id": "ORG001",
            "parent_code": "DD001",
            "parent_name": "南京掌控网络",
            "full_ids": "/10/6875557051887001077",
            "full_codes": "/DD001/DD002",
            "full_names": "/南京掌控网络/市场部",
            "org_sequence": "1",
            "org_status": "1",
            "org_code": "DD002",
            "create_time": "2017-09-09 13:14:11",
            "modify_time": "2018-09-09 13:14:11"
        }
    ]

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 勤策(原外勤365)的部门唯一ID。如果idorg_id同时存在则优先顺序为idorg_id
org_id VARCHAR(32) 来源于第三方系统的部门唯一ID,对应新增部门 (org_id)字段,只有当数据来源于新增接口时才有值,如果数据从勤策(原外勤365)系统中直接创建则该字段值为空。如果idorg_id同时存在则优先顺序为idorg_id
org_code VARCHAR(100) 部门编码,必须唯一
org_name VARCHAR(100) 部门名称。同一部门下的子部门的名称不能重复
org_parent_id VARCHAR(32) 第三方系统上级部门唯一ID
parent_code VARCHAR(100) 上级部门编码
parent_name VARCHAR(100) 上级部门名称
waiqin365_parent_id VARCHAR(32) 勤策(原外勤365)上级部门唯一ID
full_ids VARCHAR(4000) 勤策(原外勤365)部门ID全路径
full_codes VARCHAR(4000) 部门编码全路径
full_names VARCHAR(4000) 部门名称全路径
org_sequence NUMBER(20,2) 排序号,顺序排列
org_status CHAR(1) 部门状态。0:删除,1:正常
create_time VARCHAR(32) 创建时间。格式:yyyy-MM-dd HH:mm:ss
modify_time VARCHAR(32) 修改时间。格式:yyyy-MM-dd HH:mm:ss

# 推送部门数据

勤策(原外勤365)平台在部门基础信息发生变化时向第三方系统推送数据接口
请求方式: POST(HTTPS
请求地址: 第三方服务接口URL
请求参数:

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本,如:001
dataFormat 数据格式:json
dataSource 数据来源。biz:业务功能产生,api:开放接口产生
timestamp 请求时间戳,如:1503276678552
status 数据同步状态。0:数据首次同步,2:数据失败同步
statusTime 上次同步失败时间。格式:yyyy-MM-dd HH:mm:ss
tenantId 企业ID,各注册企业在勤策(原外勤365)中对应的唯一ID
digest 数据签名,md5(data|pushsecret|timestamp)
dataType department:部门
data <<请求数据体>> ,说明:格式为JSON格式数据

请求数据体:

{
    "id": "7849836266635917787",
    "org_id": "ORG0002",
    "org_code": "YFZX",
    "org_name": "研发中心",
    "waiqin365_parent_id": "8137874469135381061",
    "org_parent_id": "ORG0001",
    "org_sequence": 99999,
    "org_status": "1"
}

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 勤策(原外勤365)部门唯一ID
org_id VARCHAR(32) 来源第三方系统的部门唯一ID
org_code VARCHAR(100) 部门编码,必须唯一
org_name VARCHAR(100) 部门名称。同一部门下的子部门的名称不能重复
org_parent_id VARCHAR(32) 第三方系统上级部门唯一ID
waiqin365_parent_id VARCHAR(32) 勤策(原外勤365)上级部门唯一ID
org_sequence NUMBER(20,2) 排序号,顺序排列
org_status CHAR(1) 部门状态。0:注销,1:正常

响应示例:

{
    "return_code": 0,
    "return_msg": ""
}

参数说明:

参数 类型 说明
return_code int 响应编码。0:成功,1:失败
return_msg String 响应说明