项目托管管理

更新时间:2025-05-30 01:56:03下载pdf

API 列表

请求方式 API 描述
POST /v1.0/cloud/osaas/construction/escrow-projects 新增项目托管
PUT /v1.0/cloud/osaas/construction/escrow-projects/{project_id} 更新项目托管
DELETE /v1.0/cloud/osaas/construction/escrow-projects/{project_id} 取消项目托管
GET /v1.0/cloud/osaas/construction/escrow-projects 分页查询已托管项目
GET /v1.0/cloud/osaas/construction/escrow-projects/{project_id}/escrow-rooms 查询项目下已托管房间列表

新增项目托管

接口描述

调用该接口将未托管的项目托管给服务商

接口地址

POST /v1.0/cloud/osaas/construction/escrow-projects

请求参数

参数名 类型 参数类型 说明 是否必需
contractor_uid String BODY 已合作的服务商用户唯一标识
project_id String BODY 项目唯一标识
room_id_list List BODY 房屋唯一标识列表,一次最多支持50个

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13位
result Boolean 结果

请求示例

POST /v1.0/cloud/osaas/construction/escrow-projects
{
    "project_id": "16*****************",
    "contractor_uid": "ba******************",
    "room_id_list":["150001"]
}

响应成功示例

{
    "result": true,
    "success": true,
    "t": 1685504124953
}

响应失败示例

{
    "code": 10101402,
    "msg": "PROJECT_ALREADY_ESCROW",
    "success": false,
    "t": 1685504178840
}

更新项目托管

接口描述

调用该接口更新已托管的项目的托管房间

  • 将托管过的房间取消托管
  • 将未托管的房间进行托管

接口地址

PUT /v1.0/cloud/osaas/construction/escrow-projects/{project_id}

请求参数

参数名 类型 参数类型 说明 是否必需
project_id String PATH 项目唯一标识
add_room_id_list List BODY 新增托管房屋唯一标识列表,一次最多支持50个
delete_room_id_list List BODY 取消托管房屋唯一标识列表,一次最多支持50个

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13位
result Boolean 结果

请求示例

PUT /v1.0/cloud/osaas/construction/escrow-projects/16***********
{
    "add_room_id_list":[" 150002","150003"],
    "delete_room_id_list":[]
}

响应成功示例

{
    "result": true,
    "success": true,
    "t": 1685504124953
}

响应失败示例

{
    "code": 10101403,
    "msg": "PROJECT_HAVE_NOT_ESCROW",
    "success": false,
    "t": 1685504538246
}

取消项目托管

接口描述

调用该接口将已托管的项目取消托管, 会将托管项目下的托管房间一并取消托管

接口地址

DELETE /v1.0/cloud/osaas/construction/escrow-projects/{project_id}

请求参数

参数名 类型 参数类型 说明 是否必需
project_id String PATH 项目唯一标识

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13位
result Boolean 结果

请求示例

DELETE /v1.0/cloud/osaas/construction/escrow-projects/16***********

响应成功示例

{
    "result": true,
    "success": true,
    "t": 1685504124953
}

响应失败示例

{
    "code": 10101403,
    "msg": "PROJECT_HAVE_NOT_ESCROW",
    "success": false,
    "t": 1685504538246
}

分页查询已托管项目

接口描述

调用该接口查询开发者已经托管的项目(项目托管的服务商用户唯一标识)

接口地址

GET /v1.0/cloud/osaas/construction/escrow-projects	

请求参数

参数名 类型 参数类型 说明 是否必需
page_no int Query page_no 最小 1, 最大 100
page_size int Query page_size 最小 1, 最大 100
project_ids String Query 项目唯一标识列表, 多个 ID 用[,]分隔,最多 50 个

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13位
result Object 结果

result参数说明

参数名 类型 说明
escrow_contractor_uid String 托管的服务商用户唯一标识
project_id String 项目唯一标识

请求示例

GET /v1.0/cloud/osaas/construction/escrow-projects?page_no=1&page_size=10&project_ids=16********,16********,16********

响应成功示例

{
    "result": {
        "data": [
            {
                "escrow_contractor_uid": "ba*****************",
                "project_id": "16**************"
            }
        ],
        "page_no": 1,
        "page_size": 10,
        "total": 1
    },
    "success": true,
    "t": 1685505304191
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

查询项目下已托管房间列表

接口描述

调用该接口查询开发者已经托管的项目下的已托管房间列表。
可用于校验项目下哪些房间已经托管

接口地址

GET /v1.0/cloud/osaas/construction/escrow-projects/{project_id}/escrow-rooms	

请求参数

参数名 类型 参数类型 说明 是否必需
project_id String PATH 项目唯一标识列表
room_ids String Query 房屋唯一标识列表, 多个 ID 用[,]分隔,最多 50 个

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13位
result Object 结果

result参数说明

参数名 类型 说明
room_id String 已托管房屋的唯一标识
room_no String 已托管房屋的编号

请求示例

GET /v1.0/cloud/osaas/construction/escrow-projects?page_no=1&page_size=10&project_ids=16********,16********,16********

响应成功示例

{
    "result": {
        "data": [
            {
                "room_id": "156****",
                "room_no": "888"
            }
        ],
        "page_no": 1,
        "page_size": 10,
        "total": 1
    },
    "success": true,
    "t": 1685505304191
}

响应失败示例


{
    "code": 10101403,
    "msg": "PROJECT_HAVE_NOT_ESCROW",
    "success": false,
    "t": 1685504538246
}