Appearance
outline: deep
功能概述
合同文件获取接口
- 合同文件获取接口
接口访问
接口地址
rental/order/material/list
请求方式 Method
GET
Header - Authorization Type : Bearer Token
| 属性 | 类型 | 长度 | 必填 | 默认值 | 说明 | 访问版本 |
|---|---|---|---|---|---|---|
| token | string | 32 | true | 用户身份标识令牌 | - |
请求参数
| 属性 | 类型 | 长度 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| rentalID | int | 64 | true | 0 | 租赁订单ID |
| uploadType | int | 64 | true | 1 | 上传类型,1-租房上传,2-退租上传 |
请求示例
{
"rentalID": 55,
"uploadType":1
}返回值
| 属性 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | int | true | 编号ID |
| rentalID | int | true | 合同ID |
| userID | int | true | 用户ID |
| roleID | int | true | 用户角色ID,1-系统,2-代理,3-业主,4-租客 |
| materialName | string | true | 材料文件标题 |
| materialFileName | string | true | 材料文件原标题 |
| materialUrl | string | true | 合同材料地址 |
| materialFileFormat | string | true | 合同文件类型 |
| materialFileSize | int | true | 合同材料文件大小 |
| materialRemarks | string | true | 合同材料备注 |
| remark | string | true | 备注 |
| uploadType | int | true | 上传类型,1-租房上传,2-退租上传 |
返回示例
{
"response": {
"materialList": [
{
"id": 11,
"userID": 39,
"roleID": 3,
"rentalID": 35,
"materialName": "55eaafec3172ade871199861b9bcfed3.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialFileName": "55eaafec3172ade871199861b9bcfed3.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialUrl": "https://file.juliyouren.com/55eaafec3172ade871199861b9bcfed3.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialFileFormat": ".png",
"materialFileSize": 1190,
"materialRemarks": "",
"remark": "",
"uploadType": 2
},
{
"id": 12,
"userID": 39,
"roleID": 3,
"rentalID": 35,
"materialName": "f1fe084523f5f9877e72c6084e81b9a5.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialFileName": "f1fe084523f5f9877e72c6084e81b9a5.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialUrl": "https://file.juliyouren.com/f1fe084523f5f9877e72c6084e81b9a5.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialFileFormat": ".png",
"materialFileSize": 1190,
"materialRemarks": "",
"remark": "",
"uploadType": 2
},
{
"id": 13,
"userID": 39,
"roleID": 3,
"rentalID": 35,
"materialName": "55eaafec3172ade871199861b9bcfed3.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialFileName": "55eaafec3172ade871199861b9bcfed3.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialUrl": "https://file.juliyouren.com/55eaafec3172ade871199861b9bcfed3.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialFileFormat": ".png",
"materialFileSize": 1190,
"materialRemarks": "",
"remark": "",
"uploadType": 2
},
{
"id": 14,
"userID": 39,
"roleID": 3,
"rentalID": 35,
"materialName": "f1fe084523f5f9877e72c6084e81b9a5.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialFileName": "f1fe084523f5f9877e72c6084e81b9a5.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialUrl": "https://file.juliyouren.com/f1fe084523f5f9877e72c6084e81b9a5.png?watermark/4/text/5bGF6YeM5pyJ5Lq6/fontsize/400/fill/Z3JheQ==/dissolve/50/rotate/30/uw/180/uh/180/resize/1",
"materialFileFormat": ".png",
"materialFileSize": 1190,
"materialRemarks": "",
"remark": "",
"uploadType": 2
}
]
},
"requestId": "61c09a43-31fc-4216-b766-deaaba740235"
}错误码
| 错误码 | 说明 | 解决方案 |
|---|---|---|
| 91021 | 订单ID不能为空 | 检查参数是否正确 |
| 404 | Fail | 代码报错 |
