API 文档 – 进度查询接口

概述

该接口用于根据订单号查询指定订单的进度信息。

接口 URL

POST /api/chadanoid

请求参数

返回格式

接口返回的结果为 JSON 格式，具体结构如下：

成功响应

{
    "code": 1,
    "data": [
        {
            "id": "订单号",
            "ptname": "平台名称",
            "school": "学校",
            "name": "学生姓名",
            "user": "用户名",
            "kcname": "课程名称",
            "addtime": "下单时间",
            "courseStartTime": "课程开始时间",
            "courseEndTime": "课程结束时间",
            "examStartTime": "考试开始时间",
            "examEndTime": "考试结束时间",
            "status": "订单状态",
            "process": "处理进度",
            "remarks": "备注信息"
        }
    ]
}

失败响应

1. 订单号不能为空

{
    "code": 0,
    "msg": "订单号不能为空"
}

2. 未找到该订单

{
    "code": -1,
    "msg": "未找到该订单"
}

说明

• 请求体需要以 application/x-www-form-urlencoded 格式发送。
• oid 参数是必填项，不能为空。如果未提供该参数或提供空值，则返回相应的错误提示。
• 如果查询的订单在数据库中不存在，将返回错误提示，说明未找到该订单。
• 返回的数据中，data 字段是一个对象数组，包含该订单的详细信息。

示例

请求示例

curl -X POST http://yourapi.com/api/chadanoid \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "oid=123456"

成功的响应示例

{
    "code": 1,
    "data": [
        {
            "id": "123456",
            "ptname": "某平台",
            "school": "某学校",
            "name": "张三",
            "user": "testuser",
            "kcname": "数学",
            "addtime": "2023-10-01 10:00:00",
            "courseStartTime": "2023-10-05 09:00:00",
            "courseEndTime": "2023-10-25 17:00:00",
            "examStartTime": "2023-10-26 09:00:00",
            "examEndTime": "2023-10-26 12:00:00",
            "status": "进行中",
            "process": "已开课",
            "remarks": "无"
        }
    ]
}

失败的响应示例 – 订单号不能为空

{
    "code": 0,
    "msg": "订单号不能为空"
}

失败的响应示例 – 未找到该订单

{
    "code": -1,
    "msg": "未找到该订单"
}

错误处理

在调用过程中，如果发生任何错误，请根据返回的 code 和 msg 字段进行排查和处理。确保传入有效的 oid 参数，并且此订单在系统中真实存在。