配車API

POST /sessions?hp_mode=true&callback_url=

curl -X POST -H "Api-Key: YOUR_API_KEY" \\
  -F "[email protected]" \\
  -F "[email protected]" \\
  -F "relax_constraints=@relax_constraints.json" \\
  -F "algo_preset=@algo_preset.json" \\
  "YOUR_API_BASE_URL/sessions?hp_mode=true&callback_url=YOUR_CALLBACK_URL"

レスポンス例

{
  "callback_url":"<http://localhost:3001/cb>",
  "session_id":"2023-11-12_ae34f1d5-38ef-464d-980e-b2f3857ff1f6",
  "status":"queued"
}

リクエスト

YOUR_API_KEY	APIキーを指定する
config	設定ファイル (cofnig.json) を指定する
input	配車情報ファイル (input.json) を指定する
relax_constraints	制約緩和情報ファイル (relax_constraints.json)を指定する
algo_preset	アルゴリズム設定ファイル (algo_preset.json) を指定する
YOUR_API_BASE_URL	配車APIのURLを設定する
YOUR_CALLBACK_URL	配車は非同期実行のため、結果を POST で受け取るためのコールバックAPIのURLを指定する

config.jsonについて

input.jsonについて

relax_constraints.json について

algo_preset.json について

レスポンス

callback_url	リクエストに設定したコールバックURLを返す
session_id	非同期で実行する配車を識別するためのセッションID
status	queued (実行開始待ち)

コールバック例

成功時

{
    "file": "plan/2023/12/2023-12-03_3b80cc9b-5fd6-413e-acf9-3265669b26ce.json",
    "url": "<https://deliver-localdev.s3.amazonaws.com/plan/2023/12/2023-12-03_3b80cc9b-5fd6-413e-acf9-3265669b26ce.json?AWSAccessKeyId=AKIAQAQCSNERQRDPGV7B&Signature=sXv%2Byv0IiZgoOlCSCGWccEDQ9%2F0%3D&Expires=1701607900>",
    "api_version": "local",
    "not_alloc_reasons_redis_key": "2023-12-03_3b80cc9b-5fd6-413e-acf9-3265669b26ce",
    "not_alloc_reasons_s3_url": "<https://deliver-stg.s3.amazonaws.com/not_alloc_reasons/2024-07-06_aa7c902d-9c4b-456e-9c3e-460f670b18bc.json?AWSAccessKeyId=AKIAQAQCSNERQRDPGV7B&Signature=rN08qqYgXLwtF3AfJBH3P9xuSxU%3D&Expires=1720273889>",
    "session_id": "2023-12-03_3b80cc9b-5fd6-413e-acf9-3265669b26ce",
    "code": 200
}