第5章車両位置情報の検索

API名：
matchingLoadAndUnload

概要：
指定された時間帯と地点範囲内に集荷と荷卸の両方が存在する車両情報を取得します。

URI：
https://ドメイン名/openapi/v1/vehicle/matchingLoadAndUnload

メソッド：
POST

5.1POSTメソッド

5.1.1リクエスト

API使用例：

Request URL: https://ドメイン名/openapi/v1/vehicle/matchingLoadAndUnload
Request Method: POST
Request Head:
　　　　content-type: application/json
　　　　Authorization:Bearer eyJ4NX…

Request body:
{
  "startDate":"2021/04/26",
  "endDate":"2021/04/27",
  "loadInfo": {
   "startTime":"05:00:00",
   "endTime":"05:30:00",
   "latitude":"35.123456",
   "longitude":"139.123456",
   "range":"500",
  },
  "unLoadInfo": {
   "startTime":"05:00:00",
   "endTime":"05:30:00",
   "latitude":"35.654321",
   "longitude":"139.654321",
   "range":"500",
  }
}

各リクエストパラメータは下記の通りです。


パラメータ名	必須	データ型	デフォルト	説明
startDate	○	String		検索する範囲の開始期間を指定します。※1
endDate	○	String		検索する範囲の終了期間を指定します。※1
loadInfo	○※2	Object		荷積情報を指定します。
	startTime	○※2	String		荷積開始時刻を指定します。
	endTime	○※2	String		荷積終了時刻を指定します。
	latitude	○	String		荷積地点の緯度を指定します。※3
	longitude	○	String		荷積地点の経度を指定します。※3
	range	○	Integer		荷積地点を中心に半径〇mの円範囲を指定します。
unLoadInfo	○	Object		荷卸情報を指定します。
	startTime	○※2	String		荷卸開始時刻を指定します。
	endTime	○※2	String		荷卸終了時刻を指定します。
	latitude	○	String		荷卸地点の緯度を指定します。※3
	longitude	○	String		荷卸地点の経度を指定します。※3
	range	○	Integer		荷卸地点を中心に半径〇mの円範囲を指定します。

※1

指定できるstartDate～endDateは最大1ヶ月間です。
以下のフォーマットで指定します。
フォーマット: yyyy/MM/dd

※2

指定できるstartTime～endTimeまでの長さは最大180分です。
以下のフォーマットで指定します。
フォーマット:HH:mm:ss

※3

以下のフォーマットで指定します。
フォーマット: 度形式、”xxx.xxxx”

5.1.2レスポンス

各レスポンスパラメータは下記の通りです。


パラメータ名	データ型	説明
status	Object	ステータス情報が入ります。
	code	String	ステータスコードが入ります。詳しい内容は状態コードとエラー‌を参照してください。
	message	String	ステータス内容に関するメッセージが入ります。詳しい内容は状態コードとエラー‌を参照してください。
results	Object	リクエスト結果の情報が入ります。

resultsの中身は下記の通りです。


パラメータ名	データ型	説明
loadAndUnloadMatch	Object	検索した情報が入ります。
	movementCount	Integer	検索した運行件数が入ります。
	responseLimit	Integer	レスポンス上限の件数が入ります。
	vehicleInfoList	Array	検索した車両情報が入ります。
		vehicleCode	String	車両コードが入ります。(数字8桁)
		vehicleName	String	車両名称が入ります。
		movementInfoList	Array	運行情報が入ります。
			dbId	Integer	運行IDが入ります。
			roadKind	Integer	検索時の走行道路帯情報が入ります。（1: 一般道、 3: 高速道）

レスポンス例

{
  status: {
   code: "AF00E0000",
   message: "SUCCESS"
  },
  results: {
   "loadAndUnloadMatch":{
    "movementCount":4,
    "responseLimit":500,
    "vehicleInfoList":[
     {
      "vehicleCode":"14001234",
      "vehicleName":"車両1234",
      "movementInfoList":[
       {
        "dbId":1,
        "roadKind":1
       },
       {
        "dbId":2,
        "roadKind":1
       }
      ]
     },
     {
      "vehicleCode":"14004321",
      "vehicleName":"車両4321",
      "movementInfoList":[
       {
        "dbId":11,
        "roadKind":3
       },
       {
        "dbId":12,
        "roadKind":1
       }
      ]
     }
    ]
   }
}
}