获取保单列表 #
描述 #
使用此接口获取/查询保单列表信息。
接口说明 #
授权对象 APP
请求地址 GET /open/insurance/orderList
请求规则 请查阅开发必读
请求参数 #
参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
---|---|---|---|---|
页码数 | page | uint32 | 否 | query页码从1开始计数,若不填则默认为1。 示例值:1 |
每页记录数 | limit | uint32 | 否 | query每一页返回的记录条数,请勿多次使用过大数值,推荐30以内,若多次请求过大数值将会被拉入黑名单一定时间,若不填则默认为10。 示例值:10 |
搜索关键词 | keyword | string[1, 32] | 否 | query支持通过真实姓名、身份证号、关联订单号、保单号、开放平台订单号精确搜索。 示例值:布尔 |
开始时间 | startAt | int64 | 否 | query保险订单下单时间范围。 示例值:1626537600 |
结束时间 | endAt | int64 | 否 | query保险订单下单时间范围。 示例值:1626616800 |
请求示例 #
{
"page": 1,
"limit": 10,
"keyword": "布尔",
"startAt": 1626537600,
"endAt": 1626537600
}
响应结果 #
参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
---|---|---|---|---|
保单列表 | list | object | 是 | |
总记录数 | total | int64 | 是 |
保单列表 list #
参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
---|---|---|---|---|
能力ID | abilityId | uint32 | 是 | 此参数为能力的唯一标识。 示例值:1 |
关联订单号 | orderNumber | string[1, 32] | 是 | 此数据为投保方关联的业务订单号。 示例值:202107188491437550138214 |
平台订单号 | transactionId | string[1, 32] | 是 | 此数据为开放平台的订单号,在平台为唯一订单号信息。 示例值:202107187462757791703647 |
保险单号 | insuranceId | string[1, 32] | 是 | 此数据为保险公司的订单号,在保险公司为唯一订单号信息。 示例值:202107188168316148713525 |
保险费用 | price | float64 | 是 | 示例值:3.8 |
真实姓名 | realName | string[1, 16] | 是 | 示例值:布尔 |
身份证号 | idCard | string[1, 32] | 是 | 示例值:520888201712088888 |
手机号码 | mobile | string[1, 32] | 是 | 示例值:13024777828 |
下单时间 | createdAt | int64 | 是 | 保险下单时间。 示例值:1626610000 |
生效时间 | insuranceStartAt | int64 | 是 | 保险开始承保时间。 示例值:1626610000 |
保单时间 | insuranceEndAt | int64 | 是 | 保险有效时间截至。 示例值:1626623999 |
保单状态 | status | uint32 | 是 | 保险状态 9为成功,低于9即待生效,10/11/12表示失败需退款。 示例值:9 |
备注 | remark | string[1, 64] | 否 | 订单备注 |
响应示例 #
> 200 Response
{
"code": 20000,
"msg": "success",
"data": {
"list": [
{
"abilityId": 1,
"orderNumber": "202107188491437550138214",
"transactionId": "202107187462757791703647",
"insuranceId": "202107188168316148713525",
"price": 3.8,
"createdAt": 1626610000,
"insuranceStartAt": 1626610000,
"insuranceEndAt": 1626623999,
"idCard": "520888201712088888",
"mobile": "13024777828",
"status": 9,
"realName": "布尔"
}
],
"total": 1
}
}