1. 地名地址查询
根据关键词查询最匹配的地名地址信息。
请求方式：POST
请求地址：/bosFoundationService/{appKey}/addresses/query
1.1. 请求参数：
Headers：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
SearchParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| NULL | NULL | NULL | NULL | NULL |
Body(application/json)：
{
"bosclass":"documents", //应用类
"keyword":"胡同张家界" //地址地名关键词
}
1.2. 参数说明：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回：
Http Status Code：200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": [
{
"code": "c5f6ad960c4440508b024662da60920b", //匹配的实体类对象信息
"gtype": "models",
"description": "",
"gcategory": "RVT",
"revision": "0",
"gsource": "文档管理",
"guser": "users/127743004",
"score": 2.8630462, //匹配得分
"gacl": [
{
"principal": "users/127743004",
"permissions": "rwdc",
"flags": "",
"type": "A"
}
],
"size": 377021,
"gtime": "1618817707146",
"enterpriseAddress": "张家界", //地址
"name": "嵌套族测试3（部件）-6.0.1.0.zip",
"currentUserPermissions": "rwdc",
"bosclass": "documents",
"_id": "2c8ab9ba154a40c88a41917d47c9dc4f",
"gicon": "9a08ce29757541e386034951f96d90df",
"enterpriseName": "胡同三路", //地名
"gcreatetime": "1618817705884"
}
]
}
1.4. 错误返回：
| 状态码 | code | message | data | 原因 |
|---|---|---|---|---|
| 200 | object.requiredField.empty | boscalss属性必填 | NULL | bosclass为空 |
| 200 | ENTITY_BOSCLASS_NOTFOUND | 实体类{key}不存在 | NULL | 实体类{key}不存在 |
| 200 | ENTITY_READPERMISSION_REQUIRED | 缺少实体对象{bosclass}的读权限 | NULL | 用户满足不了以下条件之一： 应用管理员，拥有该类的读权限 |
1.5. 注意事项：
暂无注意事项