月卡管理

API列表

请求方式	API	描述
POST	/v1.0/iot-02/third/parking/month-cards	创建月卡
PUT	/v1.0/iot-02/third/parking/month-cards/{month_card_id}	修改月卡
DELETE	/v1.0/iot-02/third/parking/month-cards/{month_card_id}	删除月卡
GET	/v1.0/iot-02/third/parking/month-cards/{month_card_id}	根据月卡 id 查询
GET	/v1.0/iot-02/third/parking/month-cards/plate-number/{plate_number}	根据车牌号查询
GET	/v1.0/iot-02/third/parking/month-cards	月卡条件查询；支持分页
PUT	/v1.0/iot-02/third/parking/month-cards/{month_card_id}/status	启用禁用月卡

创建月卡

功能描述

创建月卡

接口地址

POST /v1.0/iot-02/third/parking/month-cards

请求参数

参数名	类型	参数类型	说明	是否必需
target_type	String	body	月卡对象类型：车组，车位，(parking_group:车组；parking_spot:车位)	false
target_id	String	body	月卡对象 id：车组 id，车位 id	false
source	String	body	来源，(web:web 端；app:移动端；device:设备端)	false
rule_id	String	body	计费规则编号	true
car_info_requests	Object[]	body	车信息	true
- plate_number	String	body	车牌号	true
- owner_id	String	body	车主 id，不超过 32 个字符	true
- owner_name	String	body	车主姓名，不超过 32 个字符	false
- gateway_id	String	body	授权的网关 id，不超过 32 个字符	true
- device_cids	String[]	body	授权的车闸 id 集合	true
start_time	long	body	计费开始时间(毫秒)	true
end_time	long	body	计费结束时间(毫秒)	true
payable_amount	long	body	应收金额:分	true
paid_amount	long	body	实收金额：分	true
pay_mode	String	body	收费方式，(alipay:支付宝；wechat_pay:微信支付；bank_card:银行卡；cash:现金；other:其它)	false
payer_name	String	body	缴费人名称	false
payer_mobile	String	body	缴费人手机号	false
pay_time	long	body	缴费时间(毫秒)	true
invoice	boolean	body	是否提供发票	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	String	月卡 id

请求示例

POST /v1.0/iot-02/third/parking/month-cards
{
  "target_type": "parking_group",
  "target_id": "f8sBB5lVWm",
  "source": "web",
  "rule_id": "ZB2w8lXfIZ",
  "car_info_requests": [
    {
      "plate_number": "浙A12345",
      "owner_id": "owner1",
      "owner_name": "张三"
    }
  ],
  "authorize_device_request": {
    "gateway_id": "aaaww233xx33",
    "device_cids": [
      "uYM6mKfSRy"
    ]
  },
  "start_time": 575158,
  "end_time": 914262,
  "payable_amount": 704124,
  "paid_amount": 29422,
  "pay_mode": "alipay",
  "payer_name": "SMOEpBEvGq",
  "payer_mobile": "YqJcKX76f7",
  "pay_time": 471087,
  "invoice": true
}

响应示例

{
  "success": true,
  "t": 1573441137,
  "result": "uKtgOLinDB"
}

修改月卡

功能描述

修改月卡

接口地址

PUT /v1.0/iot-02/third/parking/month-cards/{month_card_id}

请求参数

参数名	类型	参数类型	说明	是否必需
month_card_id	String	url	月卡 id	true
car_info_requests	Object[]	body	车信息	true
- plate_number	String	body	车牌号	true
- owner_id	String	body	车主 id，不超过 32 个字符	true
- owner_name	String	body	车主姓名，不超过 32 个字符	false
- gateway_id	String	body	授权的网关 id，不超过 32 个字符	true
- device_cids	String[]	body	授权的车闸 id 集合	true
start_time	long	body	计费开始时间(毫秒)	true
end_time	long	body	计费结束时间(毫秒)	true

返回参数

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

请求示例

PUT /v1.0/iot-02/third/parking/month-cards/{month_card_id}
{
  "car_info_requests": [
    {
      "plate_number": "浙A12345",
      "owner_id": "owner1",
      "owner_name": "张三"
    }
  ],
  "authorize_device_request": {
    "gateway_id": "aaaww233xx33",
    "device_cids": [
      "BpvXbOLWoO"
    ]
  },
  "start_time": 283656,
  "end_time": 427043
}

响应示例

{
  "success": true,
  "t": 1573441137,
  "result": false
}

删除月卡

功能描述

删除月卡

接口地址

DELETE /v1.0/iot-02/third/parking/month-cards/{month_card_id}

请求参数

参数名	类型	参数类型	说明	是否必需
month_card_id	String	url	月卡 id	true

返回参数

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

请求示例

DELETE /v1.0/iot-02/third/parking/month-cards/{month_card_id}

响应示例

{
  "success": true,
  "t": 1573441137,
  "result": false
}

根据月卡 id 查询

功能描述

根据月卡id查询

接口地址

GET /v1.0/iot-02/third/parking/month-cards/{month_card_id}

请求参数

参数名	类型	参数类型	说明	是否必需
month_card_id	String	url	月卡 id	true

返回参数

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

result 参数说明

参数名	类型	说明
project_id	String	项目 id
creator	String	创建者
modifier	String	修改者
gmt_create	long	创建时间（毫秒）
gmt_modified	long	修改时间（毫秒）
month_card_id	String	月卡 id
rule_id	String	计费规则 id
bill_flow_id	String	缴费流水号
target_type	String	月卡对象类型
target_id	String	月卡对象 id
start_time	long	开始时间
end_time	long	结束时间
month_card_status	String	月卡状态

请求示例

GET /v1.0/iot-02/third/parking/month-cards/{month_card_id}

响应示例

{
  "success": true,
  "t": 1573441137,
  "result": {
    "project_id": "80ULOOTeG5",
    "creator": "gBHn3vrEUV",
    "modifier": "FhzUyqUjru",
    "gmt_create": 161910,
    "gmt_modified": 937880,
    "month_card_id": "eVJvXSOIUc",
    "rule_id": "w8lgRzjj5y",
    "bill_flow_id": "r9y2kt5VtJ",
    "target_type": "hH75V9G6yr",
    "target_id": "XyphPHpAJm",
    "start_time": 163647,
    "end_time": 147678,
    "month_card_status": "v0kowOEdgj"
  }
}

根据车牌号查询

功能描述

根据车牌号查询

接口地址

GET /v1.0/iot-02/third/parking/month-cards/plate-number/{plate_number}

请求参数

参数名	类型	参数类型	说明	是否必需
plate_number	String	url	车牌号	true

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object[]	月卡信息列表

result 参数说明

参数名	类型	说明
project_id	String	项目 id
creator	String	创建者
modifier	String	修改者
gmt_create	long	创建时间（毫秒）
gmt_modified	long	修改时间（毫秒）
month_card_id	String	月卡 id
rule_id	String	计费规则 id
bill_flow_id	String	缴费流水号
target_type	String	月卡对象类型
target_id	String	月卡对象 id
start_time	long	开始时间
end_time	long	结束时间
month_card_status	String	月卡状态

请求示例

GET /v1.0/iot-02/third/parking/month-cards/plate-number/{plate_number}

响应示例

{
  "success": true,
  "t": 1573441137,
  "result": [
    {
      "project_id": "Bi0gvybRgW",
      "creator": "30Trz2UqOe",
      "modifier": "AbmGpMPaYB",
      "gmt_create": 898725,
      "gmt_modified": 549216,
      "month_card_id": "W3MkeRW4Yy",
      "rule_id": "l7CF0C9sXr",
      "bill_flow_id": "yGPfUSZQSg",
      "target_type": "gR1D2HpP4R",
      "target_id": "qtMTBp7sQK",
      "start_time": 281534,
      "end_time": 491491,
      "month_card_status": "GNWDwlZOSt"
    }
  ]
}

月卡条件查询；支持分页

功能描述

月卡条件查询；支持分页

接口地址

GET /v1.0/iot-02/third/parking/month-cards

请求参数

参数名	类型	参数类型	说明	是否必需
page_no	int	query	页码，最小值 1	false
page_size	int	query	页大小，最小值 1，最大值 1000	false
target_type	String	query	月卡对象类型：车组，车位，(parking_group:车组；parking_spot:车位)	false
target_id	String	query	月卡对象 id：车组 id，车位 id	false
start_time	long	query	计费开始时间(毫秒)	false
end_time	long	query	计费结束时间(毫秒)	false
month_card_status	String	query	月卡状态，(enable:启用状态；disable:禁用状态)	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	月卡分页列表

result 参数说明

参数名	类型	说明
total	int	总数
data	Object[]	当前页数据
- project_id	String	项目 id
- creator	String	创建者
- modifier	String	修改者
- gmt_create	long	创建时间（毫秒）
- gmt_modified	long	修改时间（毫秒）
- month_card_id	String	月卡 id
- rule_id	String	计费规则 id
- bill_flow_id	String	缴费流水号
- target_type	String	月卡对象类型
- target_id	String	月卡对象 id
- start_time	long	开始时间
- end_time	long	结束时间
- month_card_status	String	月卡状态

请求示例

GET /v1.0/iot-02/third/parking/month-cards?page_no=1&page_size=100&target_type=parking_group&target_id=4RjvX2sKoY&start_time=925776&end_time=996060&month_card_status=enable

响应示例

{
  "success": true,
  "t": 1573441137,
  "result": {
    "total": 1,
    "data": [
      {
        "project_id": "q8xi5w4fiq",
        "creator": "WwOLPnijaM",
        "modifier": "y8Sw1DPRE3",
        "gmt_create": 242150,
        "gmt_modified": 518231,
        "month_card_id": "kV7ZTarka4",
        "rule_id": "wVDYlxjX01",
        "bill_flow_id": "9saJyNaQik",
        "target_type": "SsKZJrVUYb",
        "target_id": "nGWxKsVOWG",
        "start_time": 441753,
        "end_time": 613879,
        "month_card_status": "OPDKimcfVv"
      }
    ]
  }
}

启用禁用月卡

功能描述

启用禁用月卡

接口地址

PUT /v1.0/iot-02/third/parking/month-cards/{month_card_id}/status

请求参数

参数名	类型	参数类型	说明	是否必需
month_card_id	String	body	月卡 id	true
month_card_status	String	body	月卡状态，(enable:启用状态；disable:禁用状态)	true

返回参数

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

请求示例

PUT /v1.0/iot-02/third/parking/month-cards/{month_card_id}/status
{
  "month_card_id": "Im8vTCB91Z",
  "month_card_status": "enable"
}

响应示例

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