开放接口API说明-部门接口

参数名称 参数值
应用编码 organization
应用版本 v1
接口名称 新增部门
接口编码 addOrganization
接口URL https://openapi.waiqin365.com/api/organization/v1/addOrganization/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
org_id VARCHAR(32) 来源第三方系统的部门唯一标识
org_code VARCHAR(100) 部门编码
org_name VARCHAR(100) 部门名称
org_parent_id VARCHAR(32) 来源第三方系统的上级部门唯一标识
waiqin365_parent_id VARCHAR(20) 外勤365上级部门唯一标识
org_sequence NUMBER(20) 排序号,顺序排列
org_status CHAR(1) 部门状态,0-删除 1-正常,默认值:1
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "org_id":"ORG00001",
    "org_name":"南京掌控网络",
    "org_parent_id":"",
    "org_sequence":20
}

// 成功响应信息示例:
{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":""
}

// 失败响应信息示例:
{
    "msg_id":"X000001",
    "return_code":100101,
    "return_msg":"部门唯一标识已经存在!值为:ORG00001"
}
                  
参数名称 参数值
应用编码 organization
应用版本 v1
接口名称 修改部门
接口编码 modifyOrganization
接口URL https://openapi.waiqin365.com/api/organization/v1/modifyOrganization/{openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
org_id VARCHAR(32) 来源第三方的部门唯一标识
id VARCHAR(32) 需要修改的部门的外勤365唯一ID,和org_id只需要其中任意一个,
同时存在时以id优先
org_code VARCHAR(100) 部门编码
org_name VARCHAR(100) 部门名称
org_parent_id VARCHAR(32) 来源第三方的上级部门唯一标识
waiqin365_parent_id VARCHAR(20) 外勤365上级部门唯一标识
org_sequence NUMBER(20) 排序号,顺序排列
org_status CHAR(1) 部门状态,0-删除 1-正常,默认值:1
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
// 示例1:
{
    "org_id":"ORG00001",
    "org_name":"南京掌控网络",
    "org_parent_id":"ORG001",
    "org_sequence":20
}
// 示例2:
{
    "id":"7755411029235897747",
    "org_name":"南京掌控网络",
    "waiqin365_parent_id":"5411562832309900523",
    "org_sequence":20
}

// 成功响应信息示例:
{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":""
}

// 失败响应信息示例:
{
    "msg_id":"X000001",
    "return_code":100103,
    "return_msg":"部门唯一标识不存在!值为:ORG001"
}
                  
参数名称 参数值
应用编码 organization
应用版本 v1
接口名称 删除部门
接口编码 removeOrganization
接口URL https://openapi.waiqin365.com/api/organization/v1/removeOrganization/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
org_id VARCHAR(32) 部门唯一标识
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "org_id":"ORG00001"
}

// 响应信息示例:
{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":""
}
                  
参数名称 参数值
应用编码 organization
应用版本 v1
接口名称 查询部门
接口编码 queryOrganization
接口URL https://openapi.waiqin365.com/api/organization/v1/queryOrganization/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
id VARCHAR(20) 根据外勤365部门ID精确查询
org_id VARCHAR(32) 根据来源第三方系统部门ID精确查询,如果查询条件包含id参数,优先根据id查询
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”
响应信息 参照表响应信息格式
id VARCHAR(32) 外勤365部门唯一ID
org_id VARCHAR(32) 来源第三方系统的部门唯一标识
org_code VARCHAR(100) 部门编码
org_name VARCHAR(100) 部门名称
org_parent_id VARCHAR(32) 第三方系统上级部门唯一标识
parent_code VARCHAR(100) 上级部门编码
parent_name VARCHAR(100) 上级部门名称
waiqin365_parent_id VARCHAR(32) 外勤365上级部门唯一标识
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”

// 请求消息体示例:
{
    "org_id": "ORG00001"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": "0",
    "return_msg": "",
    "response_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"
        }
    ]"
}