4. 项目中台API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
4.1 | 获取项目列表 | /mid/prof/project/query/list | 1.0 |
4.2 | 获取项目信息 | /mid/prof/project/query/info | 1.0 |
4.3 | 创建项目 | /mid/prof/project/create | 1.0 |
4.4 | 更新项目信息 | /mid/prof/project/update/info | 1.0 |
4.5 | 更新项目数据状态 | /mid/prof/project/update/state | 1.0 |
4.6 | 获取项目房屋列表 | /mid/prof/project/house/query/list | 1.0 |
4.7 | 获取项目车位列表 | /mid/prof/project/parking/query/list | 1.0 |
API调用
4.1: 获取项目列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/mid/prof/project/query/list
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
organStructId | BODY | STRING | 否 | 组织机构ID |
请求Body描述(非Form表单数据)
{
"organStructId": "12345"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
projects | data | JSONArray | 是 | 项目列表 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"projects":[{
}]
}
}
异常返回示例
{"code":"1401","message":""}
错误码列表(1401-1499)
错误码 | 错误信息 | 描述 |
---|---|---|
1401 | the project not exists | 项目不存在 |
公共错误码 | -- | 所有API公用的错误码,请参照《 公共错误码 》 |