Mbox空间信息
新增
接口地址:/v1/iot/door/mboxInfo/add
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"createId": 0,
"createName": "",
"createTime": "",
"deviceId": "",
"deviceName": "",
"enableMaxClock": 0,
"enableMinClock": 0,
"id": 0,
"isEnable": 0,
"isRemoved": 0,
"location": "",
"maxHoursOnceTime": 0,
"maxTimesPerPersonPerDay": 0,
"mboxName": "",
"pictureUrls": "",
"projectId": 0,
"projectName": "",
"updateId": 0,
"updateName": "",
"updateTime": "",
"version": 0
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| jsonObject | mbox空间基本信息表 | body | true | SmartCmtyMboxInfo对象 | SmartCmtyMboxInfo对象 |
| createId | false | integer(int64) | |||
| createName | false | string | |||
| createTime | false | string(date-time) | |||
| deviceId | 设备id | false | string | ||
| deviceName | 设备名称 | false | string | ||
| enableMaxClock | 每天开放时间段——最大时钟（单位：24小时制的小时数） | false | integer(int32) | ||
| enableMinClock | 每天开放时间段——最小时钟（单位：24小时制的小时数） | false | integer(int32) | ||
| id | false | integer(int32) | |||
| isEnable | 是否启用 0启用，1禁用 ，默认启动 | false | integer(int32) | ||
| isRemoved | false | integer(int32) | |||
| location | 所在位置 | false | string | ||
| maxHoursOnceTime | 用户单次可预约最长时间（范围：1-24） | false | integer(int32) | ||
| maxTimesPerPersonPerDay | 每人每天可预约次数 | false | integer(int32) | ||
| mboxName | mbox空间名称 | false | string | ||
| pictureUrls | 轮播图url（多个轮播图url用,分隔） | false | string | ||
| projectId | 项目id | false | integer(int64) | ||
| projectName | 项目名 | false | string | ||
| updateId | false | integer(int64) | |||
| updateName | false | string | |||
| updateTime | false | string(date-time) | |||
| version | false | integer(int32) | |||
| tokenInfo | tokenInfo | header | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Mono |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
null
查询
接口地址:/v1/iot/door/mboxInfo/get/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | SmartCmtyMboxInfo对象 |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| createId | integer(int64) | integer(int64) | |
| createName | string | ||
| createTime | string(date-time) | string(date-time) | |
| deviceId | 设备id | string | |
| deviceName | 设备名称 | string | |
| enableMaxClock | 每天开放时间段——最大时钟（单位：24小时制的小时数） | integer(int32) | integer(int32) |
| enableMinClock | 每天开放时间段——最小时钟（单位：24小时制的小时数） | integer(int32) | integer(int32) |
| id | integer(int32) | integer(int32) | |
| isEnable | 是否启用 0启用，1禁用 ，默认启动 | integer(int32) | integer(int32) |
| isRemoved | integer(int32) | integer(int32) | |
| location | 所在位置 | string | |
| maxHoursOnceTime | 用户单次可预约最长时间（范围：1-24） | integer(int32) | integer(int32) |
| maxTimesPerPersonPerDay | 每人每天可预约次数 | integer(int32) | integer(int32) |
| mboxName | mbox空间名称 | string | |
| pictureUrls | 轮播图url（多个轮播图url用,分隔） | string | |
| projectId | 项目id | integer(int64) | integer(int64) |
| projectName | 项目名 | string | |
| updateId | integer(int64) | integer(int64) | |
| updateName | string | ||
| updateTime | string(date-time) | string(date-time) | |
| version | integer(int32) | integer(int32) |
响应示例:
{
"createId": 0,
"createName": "",
"createTime": "",
"deviceId": "",
"deviceName": "",
"enableMaxClock": 0,
"enableMinClock": 0,
"id": 0,
"isEnable": 0,
"isRemoved": 0,
"location": "",
"maxHoursOnceTime": 0,
"maxTimesPerPersonPerDay": 0,
"mboxName": "",
"pictureUrls": "",
"projectId": 0,
"projectName": "",
"updateId": 0,
"updateName": "",
"updateTime": "",
"version": 0
}
列表
接口地址:/v1/iot/door/mboxInfo/list/all
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | SmartCmtyMboxInfo对象 |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| createId | integer(int64) | integer(int64) | |
| createName | string | ||
| createTime | string(date-time) | string(date-time) | |
| deviceId | 设备id | string | |
| deviceName | 设备名称 | string | |
| enableMaxClock | 每天开放时间段——最大时钟（单位：24小时制的小时数） | integer(int32) | integer(int32) |
| enableMinClock | 每天开放时间段——最小时钟（单位：24小时制的小时数） | integer(int32) | integer(int32) |
| id | integer(int32) | integer(int32) | |
| isEnable | 是否启用 0启用，1禁用 ，默认启动 | integer(int32) | integer(int32) |
| isRemoved | integer(int32) | integer(int32) | |
| location | 所在位置 | string | |
| maxHoursOnceTime | 用户单次可预约最长时间（范围：1-24） | integer(int32) | integer(int32) |
| maxTimesPerPersonPerDay | 每人每天可预约次数 | integer(int32) | integer(int32) |
| mboxName | mbox空间名称 | string | |
| pictureUrls | 轮播图url（多个轮播图url用,分隔） | string | |
| projectId | 项目id | integer(int64) | integer(int64) |
| projectName | 项目名 | string | |
| updateId | integer(int64) | integer(int64) | |
| updateName | string | ||
| updateTime | string(date-time) | string(date-time) | |
| version | integer(int32) | integer(int32) |
响应示例:
{
"createId": 0,
"createName": "",
"createTime": "",
"deviceId": "",
"deviceName": "",
"enableMaxClock": 0,
"enableMinClock": 0,
"id": 0,
"isEnable": 0,
"isRemoved": 0,
"location": "",
"maxHoursOnceTime": 0,
"maxTimesPerPersonPerDay": 0,
"mboxName": "",
"pictureUrls": "",
"projectId": 0,
"projectName": "",
"updateId": 0,
"updateName": "",
"updateTime": "",
"version": 0
}
分页
接口地址:/v1/iot/door/mboxInfo/page
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| jsonObject | jsonObject | body | true |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Mono |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
null
删除
接口地址:/v1/iot/door/mboxInfo/remove/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | SmartCmtyMboxInfo对象 |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| createId | integer(int64) | integer(int64) | |
| createName | string | ||
| createTime | string(date-time) | string(date-time) | |
| deviceId | 设备id | string | |
| deviceName | 设备名称 | string | |
| enableMaxClock | 每天开放时间段——最大时钟（单位：24小时制的小时数） | integer(int32) | integer(int32) |
| enableMinClock | 每天开放时间段——最小时钟（单位：24小时制的小时数） | integer(int32) | integer(int32) |
| id | integer(int32) | integer(int32) | |
| isEnable | 是否启用 0启用，1禁用 ，默认启动 | integer(int32) | integer(int32) |
| isRemoved | integer(int32) | integer(int32) | |
| location | 所在位置 | string | |
| maxHoursOnceTime | 用户单次可预约最长时间（范围：1-24） | integer(int32) | integer(int32) |
| maxTimesPerPersonPerDay | 每人每天可预约次数 | integer(int32) | integer(int32) |
| mboxName | mbox空间名称 | string | |
| pictureUrls | 轮播图url（多个轮播图url用,分隔） | string | |
| projectId | 项目id | integer(int64) | integer(int64) |
| projectName | 项目名 | string | |
| updateId | integer(int64) | integer(int64) | |
| updateName | string | ||
| updateTime | string(date-time) | string(date-time) | |
| version | integer(int32) | integer(int32) |
响应示例:
{
"createId": 0,
"createName": "",
"createTime": "",
"deviceId": "",
"deviceName": "",
"enableMaxClock": 0,
"enableMinClock": 0,
"id": 0,
"isEnable": 0,
"isRemoved": 0,
"location": "",
"maxHoursOnceTime": 0,
"maxTimesPerPersonPerDay": 0,
"mboxName": "",
"pictureUrls": "",
"projectId": 0,
"projectName": "",
"updateId": 0,
"updateName": "",
"updateTime": "",
"version": 0
}
更新
接口地址:/v1/iot/door/mboxInfo/update
请求方式:PUT
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"createId": 0,
"createName": "",
"createTime": "",
"deviceId": "",
"deviceName": "",
"enableMaxClock": 0,
"enableMinClock": 0,
"id": 0,
"isEnable": 0,
"isRemoved": 0,
"location": "",
"maxHoursOnceTime": 0,
"maxTimesPerPersonPerDay": 0,
"mboxName": "",
"pictureUrls": "",
"projectId": 0,
"projectName": "",
"updateId": 0,
"updateName": "",
"updateTime": "",
"version": 0
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| jsonObject | mbox空间基本信息表 | body | true | SmartCmtyMboxInfo对象 | SmartCmtyMboxInfo对象 |
| createId | false | integer(int64) | |||
| createName | false | string | |||
| createTime | false | string(date-time) | |||
| deviceId | 设备id | false | string | ||
| deviceName | 设备名称 | false | string | ||
| enableMaxClock | 每天开放时间段——最大时钟（单位：24小时制的小时数） | false | integer(int32) | ||
| enableMinClock | 每天开放时间段——最小时钟（单位：24小时制的小时数） | false | integer(int32) | ||
| id | false | integer(int32) | |||
| isEnable | 是否启用 0启用，1禁用 ，默认启动 | false | integer(int32) | ||
| isRemoved | false | integer(int32) | |||
| location | 所在位置 | false | string | ||
| maxHoursOnceTime | 用户单次可预约最长时间（范围：1-24） | false | integer(int32) | ||
| maxTimesPerPersonPerDay | 每人每天可预约次数 | false | integer(int32) | ||
| mboxName | mbox空间名称 | false | string | ||
| pictureUrls | 轮播图url（多个轮播图url用,分隔） | false | string | ||
| projectId | 项目id | false | integer(int64) | ||
| projectName | 项目名 | false | string | ||
| updateId | false | integer(int64) | |||
| updateName | false | string | |||
| updateTime | false | string(date-time) | |||
| version | false | integer(int32) | |||
| tokenInfo | tokenInfo | header | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Mono |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
null