特别说明

请求参数统一使用POST+BODY方式请求

请求方式: 如果接口定义为GET请求,则在BODY加入method:GET的参数 以此类推,如果接口定义是POST就加method:POST,PUT就加method:PUT,DELETE就加method:DELETE

停车场服务APP端接口文档


版本更新记录

版本 日期 内容 作者
v1.0.0 2019-08-14 新建文档 潘聪灵

调用说明

1 车场服务中的API接口是依照RestFul原则进行设计(GET:查询;POST:添加;PUT:修改;DELETE:删除;),因此,在调用时需要注意HTTP调用方法的使用;

2 所有的请求与回调参数均为json格式;

3 每个接口的请求与回调均包含通用的参数(如下所示),在本文中的接口说明中描述的字段不包含通用参数,仅包含差异化的字段,具体的json格式,请查看本节中的请求和回调样例;

Request请求参数

字段 是否必须 字段类型 描述
offset int 请求列表的偏移量,默认为0
limit int 请求列表的数量,默认为10
filter array 请求字段过滤,默认返回全量字段,如果不为空,返回filter数组中包含的字段, 例如:"filter":["id","create_date"] 则接口返回 id 和 create_date 字段,其他字段不返回
query array 查询条件,可以通过字段查询结果, 不指定这返回所有结果,查询条件字段包含设备所有默认字段, 不支持扩展属性字段, 支持比较指令包含如下:
$eq: 等于该字段值
$in:包含于该列表任意一个值
$lt:小于该字段值
$lte:小于或等于字段值
$gt:大于该字段值
$gte:大于或等于该字段值
$like:模糊匹配该字段值
order array 排序条件,可以通过任意字段排序

样例

GET方法请求

列表请求:

URL?data={
    "offset": "请求列表的偏移量",
    "limit": "请求数量",
    "filter": [
        "field1",
        "field2"
    ],
    "query": {
        "field1": {
            "$like": "字段值"
        },
        "field2": {
            "$lt": "字段值"
        }
    },
    "order": {
        "field1": "desc",
        "field2": "asc"
    }
}

详情请求:

URL/{id}

注:GET请求中的data数据需要进行encode转码

POST和PUT方法请求(请求参数放置在body中)
{
    "id": "id",
    "field1": "string",
    "field2": 0
}

Response回调参数

字段 是否必须 字段类型 描述
status int HTTP状态码
code string 错误码,000000表示请求成功
msg string 提示内容
data array 返回的数据,非查询类请求,该字段为空
create_by string 创建人
create_date string 创建时间
update_by string 更新人
update_date string 更新时间
delete_date string 逻辑删除时间
deleted int 逻辑删除标记,0:未删除;1:已删除

样例

GET方法回调

列表返回:

{
    "code": "000000",
    "data": {
        "count": 1,
        "list": [
            {
                "field1": "string",
                "feild2": 0
            }
        ]
    },
    "msg": "请求成功",
    "status": 200
}

详情返回:

{
    "code": "000000",
    "data": {
        "feild1": "string",
        "feild2": 0
    },
    "msg": "请求成功",
    "status": 200
}
POST和PUT方法回调
{
    "code": "000000",
    "data": {
        "feild1": "string",
        "feild2": 0
    },
    "msg": "请求成功",
    "status": 200
}

results matching ""

    No results matching ""