# 企业部门接入

# 1 创建部门接口

# 接口说明

名称	描述
功能	企业通过该接口，创建相应的部门
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/ent/org/add
method	ent.org.add
服务端超时时间	5秒

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
name	String	是	测试部门	部门名称(不允许存在英文字符"-"和",")
parentId	Long	是	0	上级部门id,如果上级部门是公司填0
unitCode	String	否	cod11	企业内部门唯一编码(企业内唯一)。要求：编码不重复，不超过128个字符，不包含“表情”符号

# 业务响应

名称	类型	是否非空	示例	说明
orgId	Long	是	177589	部门id

# 示例结果

业务请求

{
    "method":"ent.org.add",
    "ts":1512963578,
    "entId":1,
    "name":"部门1",
    "parentId":0
}

业务响应

{
    "msg": "",
    "data": {
        "orgId": 177589
    },
    "status": 0
}

# 2 更新部门接口

# 接口说明

名称	描述
功能	企业通过该接口，更新部门的名字和上级
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/ent/org/update
method	ent.org.update
服务端超时时间	5秒

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
orgId	Long	是	0	需要修改的部门id
name	String	是	测试部门	新部门名称(不允许存在英文字符"-"和",")
unitCode	String	否	cod11	新企业内部门唯一编码(企业内唯一) 。要求：编码不重复，不超过128个字符，不包含“表情”符号
parentId	Long	否	0	新的上级部门id,如果上级部门是公司填0

# 业务响应

名称	类型	是否非空	示例	说明
updateResult	Boolean	否	true	更新部门结果

# 示例结果

业务请求

{
    "method":"ent.org.update",
    "ts":1512963578,
    "entId":1,
    "orgId":177589,
    "name":"企业后台1组",
    "parentId":177590
}

业务响应

{
    "msg": "",
    "data": {
        "updateResult": true
    },
    "status": 0
}

# 3 删除部门接口

# 接口说明

名称	描述
功能	企业通过该接口，从美团企业版删除部门信息
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/ent/org/delete
method	ent.org.delete
服务端超时时间	5秒

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
orgId	Long	是	0	需要删除的部门 id

# 业务响应

名称	类型	是否非空	示例	说明
deleteResult	Boolean	否	true	删除部门结果

# 示例结果

业务请求

{
    "method":"ent.org.delete",
    "ts":1512963578,
    "entId":1,
    "orgId":177589
}

业务响应

{
    "msg": "",
    "data": {
        "deleteResult": true
    },
    "status": 0
}

# 4 查询部门接口

# 接口说明

名称	描述
功能	企业通过该接口，从美团企业版查部门信息
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/ent/org/query
method	ent.org.query
服务端超时时间	5秒

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
orgId	Long	是	0	需要查询的部门id

# 业务响应

名称	类型	是否非空	示例	说明
orgId	Long	是	0	部门id
name	String	是	测试部	部门名字
parentId	Long	否	11224	上级部门id 如果上级部门是公司为0
path	String	是	0-78-6144-221-1235656	部门路径id 以'-'分割包含当前部门id
unitCode	String	否	xxf	企业内部门唯一编码(企业内唯一)。要求：编码不重复，不超过128个字符，不包含“表情”符号

# 示例结果

业务请求

{
    "method":"ent.org.query",
    "ts":1512963578,
    "entId":1,
    "orgId":177589
}

业务响应

{
    "msg": "",
    "data": {
        "orgId": 177589,
        "name": "美团企业版",
        "parentId": 0,
        "path": "0-177589",
        "unitCode": null
    },
    "status": 0
}

# 5 调整人员部门关系接口

# 接口说明

名称	描述
功能	企业通过该接口，调整人员到对应的部门下面
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/ent/org/staff/relation/adjust
method	ent.org.staff.relation.adjust
服务端超时时间	5秒

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
staffId	Integer	是	23456	美团企业版员工ID
orgInfoList	List<OrgInfo>	是		部门信息

OrgInfo字段说明

名称	类型	是否必填	示例	说明
orgId	Long	是	23456	调整的部门id
isAdmin	Boolean	是	false	是否为当前部门主管;一个人最多属于20个部门

# 业务响应

名称	类型	是否非空	示例	说明
adjustResult	Boolean	否	true	调整结果

# 示例结果

业务请求

{
    "method":"ent.org.staff.relation.adjust",
    "ts":1512963578,
    "entId":1,
    "staffId":397375,
    "orgInfoList":[
        {
            "orgId":177590,
            "isAdmin":true
        },
        {
            "orgId":177591,
            "isAdmin":false
        }
    ]
}

业务响应

{
    "msg": "",
    "data": {
        "adjustResult": true
    },
    "status": 0
}

# 6 查询人员部门关系接口

# 接口说明

名称	描述
功能	企业通过该接口，通过人查询人员部门关联关系
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/ent/org/staff/relation/query
method	ent.org.staff.relation.query
服务端超时时间	5秒

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
staffId	Integer	否	23456	美团企业版员工ID，通过人查询人所在的部门
orgId	Long	否	14564	部门id，通过部门查询该部门的人员
pageNo	Integer	是	1	分页页数 >1
pageSize	Integer	是	10	页面大小1~100

说明:只能根据staffId和orgId其一来查询，全不为空时以staffId为主

# 业务响应

名称	类型	是否非空	示例	说明
pageNo	Integer	是	1	分页页数 >1
pageSize	Integer	是	10	页面大小1~100
totalCount	Integer	是	2321	总数量
staffOrgInfoList	List<StaffOrgInfo>	否		关系列表

StaffOrgInfo字段说明

名称	类型	是否必填	示例	说明
staffId	Integer	是	23456	美团企业版员工ID
name	String	是	王先生	美团企业版员工名字
staffForeignName	String	否	Charlie	美团企业版员工外文名
entStaffNum	String	否	1235656	员工在企业中工号
email	String	否	12@qq.com	员工邮箱
phone	String	否	188****8888	员工手机号
orgId	Long	是	1235656	部门 id
orgName	String	是	测试部	部门名字
isAdmin	Boolean	是	true	是否为部门主管

# 示例结果

业务请求

{
    "method":"ent.org.staff.relation.query",
    "ts":1512963578,
    "entId":1,
    "orgId":177590,
    "pageNo":1,
    "pageSize":10
}

业务响应

{
    "msg": "",
    "data": {
        "pageNo": 1,
        "pageSize": 10,
        "totalCount": 2,
        "staffOrgInfoList": [
            {
                "staffId": 397375,
                "name": "wan2",
                "entStaffNum": "",
                "email": "",
                "phone": "18401182232",
                "orgId": 177590,
                "orgName": "企业后台",
                "isAdmin": true
            },
            {
                "staffId": 397375,
                "name": "wan2",
                "entStaffNum": "",
                "email": "",
                "phone": "18401182232",
                "orgId": 177591,
                "orgName": "美团企业版",
                "isAdmin": false
            }
        ]
    },
    "status": 0
}

# 7 部门同步接口

# 接口说明

名称	描述
功能	企业通过该接口创建、更新、删除相应的部门
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/ent/org/save
method	ent.org.save
服务端超时时间	10秒

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
name	String	是	测试部门	部门名称(不允许存在英文字符"-"和",")
parentId	Long	是	0	上级部门id，如果上级部门是公司填0
unitCode	String	是	cod11	企业内部门唯一编码(企业内唯一)。要求：编码不重复，不超过128个字符，不包含“表情”符号
status	Boolean	否	false	数据有效性（true：有效；false：删除）

# 业务响应

名称	类型	是否非空	示例	说明
orgId	Long	是	177589	部门id

# 示例结果

业务请求

{
  "method":"ent.org.save",
  "ts":1512963578,
  "entId":1,
  "name":"部门1",
  "parentId":0,
  "unitCode":"cod11"
}

业务响应（正常返回结果示例）

{
  "msg": "",
  "data": {
    "orgId": 177589
  },
  "status": 0
}

业务响应（错误返回结果示例）

{
  "msg": "错误原因1",
  "status": 1
}

← 企业员工接口企业角色接口 →