组织机构列表 接口地址:/weda/auth/v1/{envType}/describeOrgs 请求方式:POST 请求数据类型:application/json 响应数据类型:*/* 请求示例: { "PageNo": 1, "PageSize": 10 } 请求参数: 参数名称 参数说明 请求类型 是否必须 数据类型 schema envType 环境类型,prod正式环境,固定传prod path true string Authorization 鉴权参数,传入Bearer AccessToken;token获取方式详见概述 header true string 查询部门列表入参对象 查询部门列表入参对象 body true 查询部门列表入参对象 查询部门列表入参对象  PageNo 页码,默认为1 false integer(int32)  PageSize 每页数目,默认为1000 false integer(int32) 响应状态: 状态码 说明 schema 200 OK ServerResponse 响应参数: 参数名称 参数说明 类型 schema Response 公共出参对象 公共出参对象  RequestId requestId string  Error 错误信息 错误信息   Code 错误码 string   Message 错误消息提示 string  Data 部门列表   DataList 部门列表,参数值为json字符串 DataId和_id都表示部门id; 示例： ["DataId":"zbm_kfbm","DataRecord":"{\"_id\":\"zbm_kfbm\",\"departmentCode\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"\"}"] array   Total 总数 integer 响应示例: { "Response": { "RequestId": "", "Error": { "Code": "", "Message": "" }, "Data": { "DataList": [ { "DataId": "zbm_kfbm", "DataRecord": "{\"_id\":\"zbm_kfbm\",\"departmentCode\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"zbm_kfbm_parent\"}" } ], "Total": 1 } } }

### 接口概述 `/weda/auth/v1/{envType}/describeOrgs` 是用于查询组织机构列表的 RESTful API 接口。该接口支持通过指定环境类型 (`envType`) 和其他可选参数来获取对应的组织机构信息。 --- ### 请求方式与 URL 此接口采用 **GET** 方法访问，URL 的基本形式如下： ``` https://<base-url>/weda/auth/v1/{envType}/describeOrgs ``` 其中 `{envType}` 表示运行环境类型，可能取值包括但不限于 `prod`, `test`, 或其他自定义环境名称[^1]。 --- ### 请求头 (Headers) 调用此接口时需提供必要的认证信息和其他标准 HTTP 头部字段，具体如下： | 字段名 | 类型 | 是否必填 | 描述 | |----------------|---------|----------|----------------------------------------------------------------------| | Authorization | String | 是 | Bearer Token 认证字符串，格式为 `Bearer <token>` | | Content-Type | String | 否 | 默认为 `application/json;charset=UTF-8` | --- ### 请求参数 以下是 `/weda/auth/v1/{envType}/describeOrgs` 接口支持的请求参数及其说明： #### 路径参数 | 参数名 | 类型 | 是否必填 | 描述 | |-------------|----------|-----------|----------------------------------------| | envType | String | 是 | 运行环境类型，例如 `prod`, `test` 等 | #### 查询参数 | 参数名 | 类型 | 是否必填 | 描述 | |-----------------|----------|----------|------------------------------------------------| | pageSize | Integer | 否 | 每页返回的最大记录数，默认值为 20 | | pageNumber | Integer | 否 | 当前分页编号，默认值为 1 | | orgNameKeyword | String | 否 | 组织机构名称的关键字匹配条件 | | statusFilter | List<String> | 否 | 需要过滤的状态集合，例如 ["active", "inactive"]| --- ### 响应数据结构 成功调用后，服务器会返回 JSON 格式的响应体，其主要字段描述如下： ```json { "code": "SUCCESS", "message": "", "data": { "totalRecords": 100, "pageSize": 20, "pageNumber": 1, "orgList": [ { "id": "ORG_001", "name": "Example Organization A", "status": "ACTIVE", "createTime": "2023-09-01T12:00:00Z" }, { "id": "ORG_002", "name": "Example Organization B", "status": "INACTIVE", "createTime": "2023-09-02T15:30:00Z" } ] } } ``` #### 主要字段解释 | 字段名 | 类型 | 描述 | |-------------------|----------------|--------------------------------------------------------------| | code | String | 返回状态码，通常为 `"SUCCESS"` 或错误代码 | | message | String | 错误消息或附加提示 | | data.totalRecords| Integer | 总记录数量 | | data.pageSize | Integer | 单次返回的数据条目上限 | | data.pageNumber | Integer | 当前页面号 | | data.orgList | Array<Object> | 符合条件的组织机构列表 | 每一条组织机构对象的具体字段含义如下： | 字段名 | 类型 | 描述 | |--------------------|----------|------------------------------| | id | String | 组织机构唯一标识符 | | name | String | 组织机构名称 | | status | String | 组织机构当前状态，如 ACTIVE, INACTIVE 等 | | createTime | DateTime | 创建时间，ISO 8601 时间戳格式 | --- ### 示例代码 以下是一个基于 Python 使用 `requests` 库调用该接口的示例代码片段： ```python import requests url = "https://example.com/weda/auth/v1/prod/describeOrgs" headers = { "Authorization": "Bearer YOUR_ACCESS_TOKEN", "Content-Type": "application/json;charset=UTF-8" } params = { "pageSize": 50, "pageNumber": 1, "orgNameKeyword": "Example", "statusFilter": ["ACTIVE"] } response = requests.get(url, headers=headers, params=params) if response.status_code == 200: result = response.json() print(f"Total Records: {result['data']['totalRecords']}") for org in result['data']['orgList']: print(f"- ID: {org['id']} Name: {org['name']} Status: {org['status']}") else: print(f"Error: {response.status_code}, Message: {response.text}") ``` --- ### 注意事项 - 如果未传递任何筛选条件，则默认返回所有符合条件的组织机构。 - 对于大规模数据集，建议合理设置 `pageSize` 和 `pageNumber` 来实现分页加载。 - 若需要更复杂的业务逻辑处理，可以结合服务端文档进一步扩展功能[^2]。 ---