10. mbox

API列表

API调用

1.0: 获取小区集合

描述 获取小区集合 大屏

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/mboxApp/get/projects

方法：POST

header

请求参数

无

返回结果示例

{
    "code": "200",
    "success": true,
    "data": [
        {
            "projectId": 21906,
            "projectName": "领贤公馆aavv"
        },
        {
            "projectId": 610,
            "projectName": "简岸花园"
        }
    ]
}

1.1: 获取可访问时间段

描述 获取指定mbox可访问时间段

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/mboxApp/reservation

方法：POST

BODY

请求示例

http://localhost:30088/v1/iot/door/mboxApp/reservation

Body:

{

"mboxId":1

}

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "minClock": 7, //最小可选时间段
        "maxClock": 21,//最大可选时间段
        "reservations": [
            {
                "date": "2021/09/17",
                "clock": {
                    "07:00~08:00": 0,
                    "08:00~09:00": 0,
                    "09:00~10:00": 0,
                    "10:00~11:00": 1,
                    "11:00~12:00": 0,
                    "12:00~13:00": 1,
                    "13:00~14:00": 1,
                    "14:00~15:00": 1,
                    "15:00~16:00": 0,
                    "16:00~17:00": 0,
                    "17:00~18:00": 0,
                    "18:00~19:00": 0,
                    "19:00~20:00": 0,
                    "20:00~21:00": 0
                }
            },
            {
                "date": "2021/09/18",
                "clock": {
                    "07:00~08:00": 0,
                    "08:00~09:00": 0,
                    "09:00~10:00": 0,
                    "10:00~11:00": 1,
                    "11:00~12:00": 0,
                    "12:00~13:00": 0,
                    "13:00~14:00": 0,
                    "14:00~15:00": 1,
                    "15:00~16:00": 1,
                    "16:00~17:00": 1,
                    "17:00~18:00": 1,
                    "18:00~19:00": 0,
                    "19:00~20:00": 0,
                    "20:00~21:00": 0
                }
            },
            {
                "date": "2021/09/19",
                "clock": {
                    "07:00~08:00": 0,
                    "08:00~09:00": 0,
                    "09:00~10:00": 0,
                    "10:00~11:00": 1,
                    "11:00~12:00": 1,
                    "12:00~13:00": 1,
                    "13:00~14:00": 1,
                    "14:00~15:00": 1,
                    "15:00~16:00": 0,
                    "16:00~17:00": 0,
                    "17:00~18:00": 0,
                    "18:00~19:00": 0,
                    "19:00~20:00": 0,
                    "20:00~21:00": 0
                }
            }
        ]
    }
}

1.2: 根据小区id获取mbox信息

描述 根据小区id获取mbox信息

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/mboxApp/getByCommunityId

方法：POST

header

请求参数

请求Body描述(非Form表单数据)

{
    "projectId":21906
}

返回参数

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "id": 1,
        "createTime": "2021-09-10 10:00:00",
        "updateTime": "2021-09-16 16:52:10",
        "isRemoved": 0,
        "mboxName": "大华mbox",
        "projectId": 21906,
        "projectName": "领贤公馆aavv",
        "location": "15栋架空层kjk",
        "deviceId": "112",
        "deviceName": "mbox01门禁",
        "enableMinClock": 7,
        "enableMaxClock": 21,
        "maxHoursOnceTime": 3,
        "maxTimesPerPersonPerDay": 1,
        "pictureUrls": "url1",
        "isEnable": 0
    }
}

1.3: 获取预约详情

描述 获取预约详情

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/mboxApp/getById

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "id":1
}

返回参数 返回字段来的，不用传

| 名称 | 位置 | 类型 | 必填 | 描述 | | authState | body | int | y | 审核状态 1待审核 2通过 3驳回 4过期 5审核取消|

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "id": 1,
        "isRemoved": 0,
        "mboxId": "1",
        "mboxName": "mbox01",
        "projectId": 21906,
        "projectName": "领贤公馆aavv",
        "startTime": "2021-09-17 10:00:00",
        "endTime": "2021-09-17 11:00:00",
        "personId": "26083",
        "personName": "小完",
        "personPhone": "13988880001",
        "customerId": "86599",
        "faceUrl": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/iot_box_image/82c8abcbfdea43289fe54496afea059a1.jpg",
        "status": 0,
        "qrCodeSendStatus": 0,
        "faceSendStatus": 0,
        "expireProcessStatus": 1
    }
}

1.4: 新增预约

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/mboxApp/save

方法：POST

header

请求Body描述(非Form表单数据)

{
        "isRemoved": 0,
        "mboxId": "1",
        "mboxName": "mbox01",
        "projectId": 21906,
        "projectName": "领贤公馆aavv",
        "startTime": "2021-09-17 10:00:00",
        "endTime": "2021-09-17 11:00:00",
        "personId": "26083",
        "personName": "小完",
        "personPhone": "13988880001",
        "customerId": "86599",
        "faceUrl": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/iot_box_image/82c8abcbfdea43289fe54496afea059a1.jpg",
        "status": 0,
        "qrCodeSendStatus": 0,
        "faceSendStatus": 0,
        "expireProcessStatus": 1
    }

返回参数 返回字段来的，不用传

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "success": true,
    "data": 6276   -- 预约记录id
}

1.5: 取消预约

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/mboxApp/cancel

方法：POST

header

请求参数

请求Body描述(非Form表单数据)

{
    "id":6272
}

返回参数 返回字段来的，不用传

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "success": true,
    "data": true
}