接口描述
获取单个组织架构成员信息。
请求方法
POST(application/json)
输入参数
参数名称 | 参数描述 | 参数类型 | 是否必填 | 备注 |
access_token | 应用有效凭证 | String | 是 | 通过获取应用有效凭证接口获取 |
org_id | 组织架构唯一 ID | Integer | 是 | 传0代表整个主体 |
fetch_child | 是否递归获取子组织架构下面的成员 | Integer | 是 | 1:是;0:否,默认为否 |
page | 分页下标 | Integer | 是 | |
page_size | 分页大小 | Integer | 是 | 每页最大数据是5000 |
输出参数
参数名称 | 参数描述 | 参数类型 | 是否必填 | 备注(以下为示例) | |
errcode | | 响应状态码,0为成功 | Integer | 是 | 0 |
errmsg | | 响应状态信息 | String | 是 | success |
page | | 当前获取数据为第几页 | Integer | 是 | 1 |
page_size | | 当前获取数据的页大小 | Integer | 是 | 5000 |
total | | 该组织架构下所有的用户总数 | Integer | 是 | 98000 |
userlist | card_number | 用户学工号 | String | 是 | 07302590 |
| name | 用户姓名(需申请) | Integer | 是 | 陈小明 |
| identity_type | Integer | 是 | 1 | |
| grade | 年级(仅限自建应用) | String | 否 | 2016 |
| college | 学院(仅限自建应用) | String | 否 | 人居环境工程学院 |
| profession | 专业(仅限自建应用) | String | 否 | 工程造价 |
| class | 班级(仅限自建应用) | String | 否 | 1班 |
| identity_title | 身份职称(仅限自建应用) | String | 否 | 本科生 |
| gender | 性别(仅限自建应用) 0:未知 1:男 2:女 | Integer | 否 | 1 |
| organization | 用户所属组织架构 ID 列表(需申请) | Array | 否 | [2,222,496] |
| role | 用户所属角色 ID 列表(仅限自建应用) | Array | 否 | [1,2] |
| campus | 校区(仅限自建应用) | String | 否 | 东校区 |
| dorm_number | 宿舍号(仅限自建应用) | String | 否 | 至善园6号 |
| physical_chip_number | 物理芯片号(需申请) | String | 否 | xaqwecf |
| physical_card_number | 物理卡号(需申请) | String | 否 | fqweasd |
| nation | 民族(仅限自建应用) | String | 否 | 汉族 |
| birthday | 生日(仅限自建应用) | String | 否 | 20020319 |
| origin_place | 生源地(仅限自建应用) | String | 否 | 深圳市 |
| graduated_school | 毕业学校(仅限自建应用) | String | 否 | 小碧中学 |
| address | 地址(仅限自建应用) | String | 否 | 广东省深圳市 |
| contact_person | 联系人姓名(仅限自建应用) | String | 否 | 陈大明 |
| contact_phone | 联系人手机号码(带区号)(仅限自建应用) | String | 否 | (+86)13800138000 |
| email | 用户邮箱(仅限自建应用) | String | 否 | 605135612@qq.com |
| id_card | 身份证(仅限自建应用) | String | 否 | 440305200203194013 |
| telephone | 手机号码(带区号)(仅限自建应用) | String | 否 | (+86)13800138000 |
| bind_status | 绑定状态(需申请) | Integer | 否 | 0 |
| frozen_status | 冻结状态(需申请) | Integer | 否 | 0 |
| active_status | 激活状态(需申请) | Integer | 否 | 0 |
| start_at | 有效起始时间(仅限自建应用) | Datatime | 否 | 2019-10-14 00:00:00 |
| entrust_status | 签约状态(需申请) 0:未签约 1:已签约 | Integer | 是 | 0 |
| expire_at | 有效结束时间(仅限自建应用) | Datatime | 否 | 2019-10-18 00:00:00 |
| updated_at | 用户信息变更时间(仅限自建应用) | Datatime | 否 | 2019-10-16 00:00:00 |
| head_image | 用户头像(仅限自建应用) | String | 否 | https://xxxxxxxxxxxxx/a.png |
| serial_number | 编号(仅限自建应用) | String | 否 | 19527123 |
| job_title | 职务(仅限自建应用) | String | 否 | 经理 |
| school_period | 学段 | String | 否 | 幼儿园 |
| register_year | 入学年份 | Int | 否 | 2022 |
示例
输入示例
{"org_id":232,"fetch_child":0,"page":1,"page_size":5000}
输出示例
{"errcode":0,"errmsg":"success","page":1,"page_size":5000,"total":9800,"userlist":[{"card_number":"07302590","name":"陈小明","identity_type":"1","grade":"2016","college":"人居环境工程学院","profession":" 工程造价","class":"1班","identity_title":"本科生","gender":1,"organization":[2,222,496],"role":[1,2],"campus":"东校区","dorm_number":"至善园","physical_chip_number":"xaqwecf","physical_card_number":"fqweasd","nation":"汉族","birthday":"20020319","origin_place":"深圳市","graduated_school":"小碧中学","address":"广东省深圳市","contact_person":"陈大明","contact_phone":"(+86)13800138000","email":"605135612@qq.com","id_card":"440305200203194013","telephone":"(+86)13800138000","bind_status":0,"frozen_status":0,"active_status":0,"entrust_status":0,"start_at":"2019-10-14 00:00:00","expire_at":"2019-10-18 00:00:00","updated_at":"2019-10-16 00:00:00","head_image":"https://xxxxxxxxxxxxxx/a.png","serial_number":"19527123","job_title":"经理","school_period":"幼儿园","register_year":"2022"}]}
注意:
私有化部署的主体不能使用上面接口地址,需要根据主体私有化部署域名拼上对应的路径,主体私有化网关域名(私有化部署域名+/kong)。
access_token 的获取请参见 获取应用有效凭证。
主体组织架构成员需定时更新,推荐每日进行一次全量更新。
应用方可接受组织架构成员变更事件(增、删、改),请参见文档 成员变更事件推送。
每个主体都可以自定义成员身份类型,获取成员身份类型列表,请参见文档 获取成员身份类型。