接口文档.md

GZIC智慧服务小程序校巴预约模块接口文档

一. 基本信息

base_url: "https://life.gzic.scut.edu.cn/commute/open/commute"

发送请求需要附带http头：authorization，其值为统一认证登陆之后获取到的token

参考：api/bus.py

二、预约校巴列表

• Method: POST

• URL: /commuteOrder/frequencyChoice?PageNum={page_num}&PageSize={page_size}

  • page_num和page_size分别为展示页码数和页面容量，都为 0 则展示全部

• Param:

  {
    "startDate": "yyyy/mm/dd",
    "startCampus": "校区名称",
    "endDate": "yyyy/mm/dd",
    "endCampus": "校区名称",
    "startHsTime": "hh:mm",
    "endHsTime": "hh:mm"
  }

  校区名称为广州国际校区、大学城校区、五山校区

• Response:

  {
    "code": 200,
    "msg": "",
    "list": []
  }

三、预约车票

• Method: POST
• URL: /commuteOrder/submitTicket
• Param:

  [
    {
      "ids": "",
      "dateDeparture": "",
      "startDate": "",
      "endDate": "",
      "startLocation": "",
      "downtown": "",
      "tickets": 1,
      "ischecked": true,
      "subTickets": 1
    }
  ]

  参数除ischecked和subTickets外都为预约校巴列表接口返回的信息

• Response:

  {
    "code": 200,
    "msg": ""
  }

四、查看某车票信息

• Method: GET
• URL: /commuteOrder/ticketDetail?id={ticket_id}
  • ticket_id为车票 id
• Response:

  {
    "data": {
      "id": 1,
      "startTime": "",
      "endTime": "",
      "ruteName": ""
    }
  }

五、车票二维码

车票二维码实际上为json文本信息，内容为：

{
  "id": 0, // 车票id
  "frequencyId": 0 // 车票frequencyId
}

只需获取信息后转化为二维码即可

六、查看车票

• Method: GET
• URL: /commuteOrder/orderFindAll?status={status}&PageNum={page_num}&PageSize={page_size}
  • status为 0 时返回全部预约过的车票，为 1 时返回已预约未乘车的车票，为 2 时返回失约未乘车车票，为 3 时返回未评价车票
  • page_num和page_size分别为展示页码数和页面容量，都为 0 则展示全部
• Response:

  {
    "code": 200,
    "msg": "",
    "totalPage": 1,
    "totalSize": 1,
    "list": [
      {
        "id": 0,
        "orderDate": "",
        "dateDeparture": "",
        "startTime": "",
        "ruteName": ""
      }
    ]
  }

七、取消车票

• Method: GET
• URL: /commuteOrder/cancelTicket?id={ticket_id}
  • ticket_id为车票id
• Response:

  {
    "code": 200,
    "msg": "",
  }

八、删除车票记录（请在取消车票后调用）

• Method: GET
• URL: /commuteOrder/removeOrderCanal?id={ticket_id}
  • ticket_id为车票id
• Response:

  {
    "code": 200,
    "msg": "",
  }