组织管理

1. 获取组织列表（getOrgList）

前端： 谭海涛
后端： 何俊霖 url： /v1/homing/system/web/org/list
备注： WEB-机构管理-列表

//! 注意，TS版本4^
import type { GetOrgListReq, GetOrgListRes } from '@homing/web'

homingClient.getOrgList().then((res: any) => {
  console.log('组织列表数据', res);
});

参数说明

参数名	类型	必填	说明	备注/枚举值
orgTreeFormat	boolean	否	是否返回树形结构	true: 树形结构, false: 平铺结构
orgTypes	string	否	机构类型	'1': 企业, '2': 总部, '3': 区域/分部, '4': 门店, '5': 职能
orgId	string	否	机构id，按此id查询所有子节点

响应说明

字段名	类型	说明
createdBy	string	创建人
createdTime	number	创建时间，时间戳格式
duty	string	职责
email	string	负责人联系邮箱
fullName	string	机构全称
logo	string	机构logo地址
mobile	string	负责人联系电话
orgCode	string	机构code
orgName	string	机构名称
orgType	string	机构类型 1企业；2总部；3区域/分部；4门店；5职能
parentCode	string	父机构code
sortValue	number	排序
staffCode	string	负责人工号
state	number	状态，1启用；0禁用
tenantCode	string	租户code
children	array	子部门列表（当orgTreeFormat为true时返回）

2. 获取组织详情（getOrgInfo）

前端： 谭海涛
后端： 何俊霖 url： /v1/homing/system/web/org/get
备注： WEB-机构管理-获取详情

//! 注意，TS版本4^
import type { GetOrgInfoReq, GetOrgInfoRes } from '@homing/web'

homingClient.getOrgInfo({
  orgId: 123
}).then((res: any) => {
  console.log('组织详情数据', res);
});

参数说明

参数名	类型	必填	说明	备注/枚举值
orgId	number	是	机构ID

响应说明

字段名	类型	说明
createdBy	string	创建人
createdTime	number	创建时间，时间戳格式
description	string	描述
duty	string	职责
email	string	负责人联系邮箱
fullName	string	机构全称
logo	string	机构logo地址
mobile	string	负责人联系电话
orgCode	string	机构code
orgName	string	机构名称
orgType	string	机构类型 1企业；2总部；3区域/分部；4门店；5职能
parentCode	string	父机构code
staffCode	string	负责人工号
state	number	状态，1启用；0禁用
tenantCode	string	租户code
updatedBy	string	更新人
updatedTime	number	更新时间，时间戳格式
customData	string	自定义扩展数据，json格式
outerOrgId	string	外部机构id
sortValue	number	排序
extendOrgShopInfo	object	门店拓展字段（门店类型机构专属）

extendOrgShopInfo 字段说明

字段名	类型	说明
province	object	省份信息
city	object	城市信息
district	object	区县信息
address	string	详细地址

3. 获取父级机构列表（getAncestors）

前端： 谭海涛
后端： 何俊霖 url： /v1/homing/system/web/org/get-ancestors
备注： WEB-机构管理-父级列表

//! 注意，TS版本4^
import type { GetOrgAncestorsReq, GetOrgAncestorsRes } from '@homing/web' 

try {
    const data: GetOrgAncestorsRes = await client.getAncestors({
        orgTreeFormat: true
    } as GetOrgAncestorsReq);
    console.log(data,"机构信息")
} catch (error: any) {
    console.log(error, '调用失败' + error?.message);
}

参数说明

参数名	类型	必填	说明	备注/枚举值
orgTreeFormat	boolean	否	是否返回树形结构	true: 树形结构, false: 平铺结构
orgTypes	string	否	组织类型	'1': 企业, '2': 总部, '3': 区域/分部, '4': 门店, '5': 职能

响应说明

字段名	类型	说明	备注
createdBy	string	创建人
createdTime	number	创建时间
duty	string	负责人
email	string	负责人联系邮箱
fullName	string	机构全称
logo	string	机构logo地址
mobile	string	负责人联系电话
orgCode	string	机构code
orgName	string	机构名称
orgType	string	机构类型
parentCode	string	父机构code
sortValue	number	排序
staffCode	string	负责人工号
state	number	状态
tenantCode	string	租户code
children	GetOrgAncestorsRes[]	子机构	递归结构

4. 绑定幼儿园列表（bindThirdChildOrg）

//! 注意，TS版本4^
import type { BindThirdChildOrgReq , BindThirdChildOrgRes } from '@homing/web' 

try {
    const data: BindThirdChildOrgRes = await client.bindThirdChildOrg({
        customerId: 123456,
        orgId: 789,
        familyRoles: ['FATHER', 'MOTHER'],
        withOneself: true,
        withDetailedAge: false,
        withOrgInfoList: true
    } as BindThirdChildOrgReq);
    console.log('调用成功', data);
} catch (error: any) {
    console.log(error, '调用失败' + error?.message);
}

参数说明

参数名	类型	必填	说明	备注/枚举值
customerId	number	是	顾客id
orgId	number	是	机构id（年级id）
familyRoles	string[]	否	家庭角色集合	'OTHER' | 'NANNY' | 'AUNT' | 'UNCLE' | 'M_GRANDMOTHER' | 'M_GRANDFATHER' | 'GRANDMOTHER' | 'GRANDFATHER' | 'FATHER' | 'MOTHER' | 'SON' | 'DAUGHTER'
withOneself	boolean	否	是否包含自身	默认包含
withDetailedAge	boolean	否	是否查询顾客详细年龄	默认不查询
withOrgInfoList	boolean	否	是否查询组织树(幼儿园、年级、班级)	默认不查询

响应说明

字段名	类型	说明
memberId	number	成员ID
memberCode	string	成员编号
familyId	number	所属家庭ID
familyRole	string	家庭角色
customerId	number	顾客标识;租户唯一
nickname	string	昵称
realName	string	姓名/真名
trueImg	string	真实头像;头像识别存储
gender	number	性别
birthday	string	生日
age	number	年龄
detailedAge	string	详细年龄
mobile	string	手机号
workCorp	string	工作单位
orgVOList	object[]	机构列表