历史开单记录接口文档.md
4.96 KB
历史开单记录接口文档
说明
历史开单记录接口用于查询从老系统迁移过来的开单记录数据。
接口列表
1. 获取历史开单记录列表
接口地址: GET /api/Extend/LqOrderRecords
请求参数 (Query参数):
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| currentPage | int | 是 | 当前页码,从1开始 |
| pageSize | int | 是 | 每页数量 |
| memberNo | string | 否 | 会员编号(模糊匹配) |
| memberPhone | string | 否 | 会员手机号(模糊匹配) |
| sidx | string | 否 | 排序字段,默认 "id" |
| sort | string | 否 | 排序方式,默认 "desc"(asc/desc) |
请求示例:
// 基础查询
GET /api/Extend/LqOrderRecords?currentPage=1&pageSize=10
// 通过会员编号筛选
GET /api/Extend/LqOrderRecords?currentPage=1&pageSize=10&memberNo=GK2022120408026
// 通过会员手机号筛选
GET /api/Extend/LqOrderRecords?currentPage=1&pageSize=10&memberPhone=13699443779
// 组合筛选
GET /api/Extend/LqOrderRecords?currentPage=1&pageSize=10&memberNo=GK&memberPhone=136
响应示例:
{
"code": 200,
"msg": "操作成功",
"data": {
"pagination": {
"pageIndex": 1,
"pageSize": 10,
"total": 100
},
"list": [
{
"id": 1,
"orderNo": "KD20231201001",
"imageName": "image1.jpg",
"memberNo": "GK2022120408026",
"memberPhone": "13699443779",
"memberName": "张三",
"remarks": "备注信息",
"createdAt": "2023-12-01T10:00:00",
"updatedAt": "2023-12-01T10:00:00"
}
]
}
}
响应字段说明:
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | int | 主键ID |
| orderNo | string | 开单号 |
| imageName | string | 图片名称 |
| memberNo | string | 会员编号 |
| memberPhone | string | 会员手机号 |
| memberName | string | 会员名称 |
| remarks | string | 备注 |
| createdAt | string | 创建时间(ISO 8601格式) |
| updatedAt | string | 更新时间(ISO 8601格式) |
2. 获取历史开单记录详情
接口地址: GET /api/Extend/LqOrderRecords/{id}
路径参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | int | 是 | 主键ID |
请求示例:
GET /api/Extend/LqOrderRecords/1
响应示例:
{
"code": 200,
"msg": "操作成功",
"data": {
"id": 1,
"orderNo": "KD20231201001",
"imageName": "image1.jpg",
"memberNo": "GK2022120408026",
"memberPhone": "13699443779",
"memberName": "张三",
"remarks": "备注信息",
"createdAt": "2023-12-01T10:00:00",
"updatedAt": "2023-12-01T10:00:00"
}
}
错误响应 (记录不存在):
{
"code": 500,
"msg": "未找到该历史开单记录",
"data": null
}
前端调用示例
Vue/axios 示例
import axios from 'axios'
// 获取列表
async function getOrderRecordsList(params) {
try {
const response = await axios.get('/api/Extend/LqOrderRecords', {
params: {
currentPage: params.currentPage || 1,
pageSize: params.pageSize || 10,
memberNo: params.memberNo || '',
memberPhone: params.memberPhone || '',
sidx: params.sidx || 'id',
sort: params.sort || 'desc'
}
})
return response.data
} catch (error) {
console.error('获取历史开单记录列表失败:', error)
throw error
}
}
// 获取详情
async function getOrderRecordInfo(id) {
try {
const response = await axios.get(`/api/Extend/LqOrderRecords/${id}`)
return response.data
} catch (error) {
console.error('获取历史开单记录详情失败:', error)
throw error
}
}
// 使用示例
// 1. 查询所有记录
getOrderRecordsList({ currentPage: 1, pageSize: 10 })
// 2. 通过会员编号筛选
getOrderRecordsList({
currentPage: 1,
pageSize: 10,
memberNo: 'GK2022120408026'
})
// 3. 通过会员手机号筛选
getOrderRecordsList({
currentPage: 1,
pageSize: 10,
memberPhone: '13699443779'
})
// 4. 获取详情
getOrderRecordInfo(1)
注意事项
- 数据来源: 这些数据是从老系统迁移过来的历史数据,只读不写
- 筛选条件:
memberNo和memberPhone支持模糊匹配(Contains查询) - 分页: 必须提供
currentPage和pageSize参数 - 排序: 默认按
id降序排列,可通过sidx和sort参数自定义 - 认证: 所有接口都需要在请求头中携带认证Token
Authorization: Bearer {token}
接口状态
✅ 已实现并通过测试
- 代码已编译通过
- 接口测试通过,功能正常
- 测试结果:
- ✅ 列表查询:成功(共31495条记录)
- ✅ 会员编号筛选:成功(筛选出30642条记录)
- ✅ 会员手机号筛选:成功(筛选出2756条记录)
- ✅ 详情查询:成功
- ✅ 错误处理:正确返回错误提示