baoshi-was/doc/api_data.json

[
  {
    "type": "post",
    "url": "/login",
    "title": "登录接口",
    "name": "login",
    "group": "User",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "string",
            "optional": false,
            "field": "username",
            "description": "<p>用户名</p>"
          },
          {
            "group": "Parameter",
            "type": "string",
            "optional": false,
            "field": "password",
            "description": "<p>用户密码,需要base64加密</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "message",
            "description": "<p>响应描述</p>"
          },
          {
            "group": "Success 200",
            "type": "int",
            "optional": false,
            "field": "status_code",
            "description": "<p>HTTP响应码</p>"
          },
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "data.token",
            "description": "<p>认证token</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "data.menu",
            "description": "<p>菜单JSON</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"message\": \"请求成功\",\n  \"status_code\": \"200\"\n  \"data\":{\n        \"toke\":\"token\",\n        \"menu\":\"{}\",\n   }\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "app/Http/ApiControllers/LoginController.php",
    "groupTitle": "User",
    "sampleRequest": [
      {
        "url": "https://was.baoshi56.com/api/v1/login"
      }
    ]
  },
  {
    "type": "post",
    "url": "/waybill/dispatch/dailyBilling",
    "title": "修改每日专线费",
    "name": "dailyBilling",
    "group": "Waybill",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "string",
            "optional": false,
            "field": "deliver_at",
            "description": "<p>发货时间</p>"
          },
          {
            "group": "Parameter",
            "type": "number",
            "optional": false,
            "field": "fee",
            "description": "<p>费用</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "message",
            "description": "<p>响应描述</p>"
          },
          {
            "group": "Success 200",
            "type": "int",
            "optional": false,
            "field": "status_code",
            "description": "<p>HTTP响应码</p>"
          },
          {
            "group": "Success 200",
            "type": "bool",
            "optional": false,
            "field": "data",
            "description": "<p>结果</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"message\": \"请求成功\",\n  \"status_code\": \"200\"\n  \"data\":true\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "app/Http/ApiControllers/WaybillController.php",
    "groupTitle": "Waybill",
    "sampleRequest": [
      {
        "url": "https://was.baoshi56.com/api/v1/waybill/dispatch/dailyBilling"
      }
    ]
  },
  {
    "type": "get",
    "url": "/waybill/dispatch",
    "title": "获取调度数据",
    "name": "dispatch",
    "group": "Waybill",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "string",
            "optional": false,
            "field": "search",
            "description": "<p>搜索文本(运单号或物流单号)</p>"
          },
          {
            "group": "Parameter",
            "type": "string",
            "optional": false,
            "field": "deliver_at",
            "description": "<p>发货时间</p>"
          },
          {
            "group": "Parameter",
            "type": "int",
            "optional": false,
            "field": "page",
            "description": "<p>页数</p>"
          },
          {
            "group": "Parameter",
            "type": "int",
            "optional": false,
            "field": "paginate",
            "description": "<p>每页多少</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "message",
            "description": "<p>响应描述</p>"
          },
          {
            "group": "Success 200",
            "type": "int",
            "optional": false,
            "field": "status_code",
            "description": "<p>HTTP响应码</p>"
          },
          {
            "group": "Success 200",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>数据列表</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"message\": \"请求成功\",\n  \"status_code\": \"200\"\n  \"data\":[\n     {\n         \"waybill_number\"=>\"宝时单号\",\n         \"destination\"   =>\"目的地\",\n         \"recipient\"     =>\"收件人\",\n         \"recipient_mobile\"=>\"收件人电话\",\n         \"carrier_bill\"=>\"承运商单号\",\n         \"carrier_name\"=>\"承运商\",\n         \"warehouse_weight\"=>\"预估体积\",\n         \"carrier_weight\"=>\"实际体积\",\n         \"inquire_tel\"=>\"查件电话\",\n         \"warehouse_weight_other\"=>\"预估重量\",\n         \"carrier_weight_other\"=>\"实际重量\",\n         \"amount\"=>\"数量\",\n         \"amount_unit_name\"=>\"数量单位\",\n         \"origination\"=>\"提货仓\"\n         \"subjoin_fee\"=>\"附加费\"\n     }\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "app/Http/ApiControllers/WaybillController.php",
    "groupTitle": "Waybill",
    "sampleRequest": [
      {
        "url": "https://was.baoshi56.com/api/v1/waybill/dispatch"
      }
    ]
  },
  {
    "type": "post",
    "url": "/waybill/dispatch",
    "title": "修改调度信息",
    "name": "updateDispatch",
    "group": "Waybill",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "int",
            "optional": false,
            "field": "id",
            "description": "<p>唯一码</p>"
          },
          {
            "group": "Parameter",
            "type": "string",
            "optional": false,
            "field": "carrier_bill",
            "description": "<p>物流单号</p>"
          },
          {
            "group": "Parameter",
            "type": "string",
            "optional": false,
            "field": "inquire_tel",
            "description": "<p>查件电话</p>"
          },
          {
            "group": "Parameter",
            "type": "int",
            "optional": false,
            "field": "amount",
            "description": "<p>货品数量</p>"
          },
          {
            "group": "Parameter",
            "type": "string",
            "optional": false,
            "field": "amount_unit_name",
            "description": "<p>数量单位(件/托)</p>"
          },
          {
            "group": "Parameter",
            "type": "number",
            "optional": false,
            "field": "carrier_weight_other",
            "description": "<p>重量/KG</p>"
          },
          {
            "group": "Parameter",
            "type": "number",
            "optional": false,
            "field": "carrier_weight",
            "description": "<p>体积/M³</p>"
          },
          {
            "group": "Parameter",
            "type": "string",
            "optional": false,
            "field": "subjoin_fee",
            "description": "<p>附加费描述</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "message",
            "description": "<p>响应描述</p>"
          },
          {
            "group": "Success 200",
            "type": "int",
            "optional": false,
            "field": "status_code",
            "description": "<p>HTTP响应码</p>"
          },
          {
            "group": "Success 200",
            "type": "bool",
            "optional": false,
            "field": "data",
            "description": "<p>结果</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"message\": \"请求成功\",\n  \"status_code\": \"200\"\n  \"data\":true\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "app/Http/ApiControllers/WaybillController.php",
    "groupTitle": "Waybill",
    "sampleRequest": [
      {
        "url": "https://was.baoshi56.com/api/v1/waybill/dispatch"
      }
    ]
  }
]