API docs by Redocly

集荷配車システム (1.0.0)

Download OpenAPI specification:Download

認証系

ログインAPI

ログインを行うAPI

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
email
required
string

メールアドレス

password
required
string

パスワード

Responses

Request samples

Content type
application/json
{
  • "email": "tsugarubuta@kmfarm.co.jp",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "木村牧場"
}

ログイン情報取得API

ログインユーザ情報取得を行うAPI

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "木村牧場"
}

ログアウトAPI

ログアウトを行うAPI

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

集荷管理

集荷詳細取得API

id に紐づく、集荷詳細取得を行うAPI

path Parameters
cargo_booking_id
required
integer

集荷ID

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "date": "2024-07-22",
  • "farmer_id": 1,
  • "name": "農家A",
  • "number_of_flecon": 12,
  • "specific_time": "AM",
  • "is_staple_rice": true,
  • "notes": "到着後インターホンを鳴らさずに電話"
}

集荷更新API

id に紐づく、集荷更新を行うAPI
DB に表示時間より最新の更新日時が存在する場合 >> 400 を返却
DB に表示時間より最新の更新日時が存在しない場合 >> 更新

path Parameters
cargo_booking_id
required
integer

集荷ID

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
date
required
string

集荷予定日

farmer_id
required
string

生産者ID

number_of_flecon
required
integer

フレコン数

specific_time
string or null

時間指定

is_staple_rice
required
boolean

主食米フラグ

notes
required
string

備考

operating_time
required
integer

稼働時間

opened_at
required
string

表示時間

Responses

Request samples

Content type
application/json
{
  • "date": "2024-07-29",
  • "farmer_id": 1,
  • "number_of_flecon": 14,
  • "specific_time": null,
  • "is_staple_rice": true,
  • "notes": "到着後インターホンを鳴らさずに電話",
  • "operating_time": "02:00:00",
  • "opened_at": "2024-07-29 10:00:00"
}

Response samples

Content type
application/json
{ }

集荷削除API

id に紐づく、集荷削除を行うAPI
集荷が削除された際に、集荷ID に紐づく配車データも削除

path Parameters
cargo_booking_id
required
integer

集荷ID

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

集荷登録API

集荷登録を行うAPI
DB に表示時間より最新の更新日時が存在する場合 >> 400 を返却
DB に表示時間より最新の更新日時が存在しない場合 >> 登録

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
date
required
string <date>

集荷予定日

farmer_id
required
integer

生産者ID

number_of_flecon
required
integer

フレコン数

specific_time
string or null

時間指定

is_staple_rice
required
boolean

主食米フラグ

operating_time
required
string <time>

稼働時間

opened_at
required
string <date>

表示時間

Responses

Request samples

Content type
application/json
{
  • "date": "2024-07-29",
  • "farmer_id": 1,
  • "number_of_flecon": 14,
  • "specific_time": "AM",
  • "is_staple_rice": false,
  • "operating_time": "02:00:00",
  • "opened_at": "2024-07-29 10:00:00"
}

Response samples

Content type
application/json
{ }

集荷一覧取得API

集荷一覧取得を行うAPI
リクエストの日付から日数分の集荷を取得する
生産者の積載量ID の昇順でソートする

query Parameters
date
required
string <date>

日付

number_of_days
required
integer

日数

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "cargo_booking_list": [
    ]
}

集荷先生産者一覧取得API

集荷先生産者一覧取得を行うAPI

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "farmer_list": [
    ]
}

集荷フラグ更新API

idに紐づく、集荷完了フラグを更新するAPI

path Parameters
cargo_booking_id
required
integer
header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
is_completed
required
boolean

集荷完了フラグ

Responses

Request samples

Content type
application/json
{
  • "is_completed": true
}

Response samples

Content type
application/json
{ }

配車管理

依頼書エクセル出力API

依頼書エクセル出力に使用するAPI

query Parameters
date
required
string <date>

日付

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

配車一覧取得API

配車一覧取得を行うAPI
稼働車両の昇順 >> ソート順の昇順

query Parameters
date
required
string <date>

日付

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "vehicle_assignment_list": [
    ]
}

配車登録/更新/削除API

配車登録を行うAPI
リクエストの 配車ID と 稼働車両ID が null の場合 >>登録しない
リクエストの 配車ID が null, 稼働車両ID が null ではない場合 >>登録
リクエストの 配車ID, 集荷ID, 稼働車両ID が null ではない場合 >>更新
リクエストの 配車ID が null ではなく、稼働車両ID が null の場合 >>削除

DB に表示時間より最新の更新日時が存在する場合 >> 400 を返却
DB に表示時間より最新の更新日時が存在しない場合 >> 登録

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
required
Array of objects
opened_at
required
string

表示時間

Responses

Request samples

Content type
application/json
{
  • "vehicle_assignment_list": [
    ],
  • "opened_at": "2024-07-29 10:00:00"
}

Response samples

Content type
application/json
{ }

稼働車両管理

稼働車両登録/削除API

稼働車両の登録、削除を行うAPI
リクエストの車両ID に紐づくデータが DB に存在しなかった場合>>登録
リクエストに DB のデータに紐づく車両ID が存在しなかった場合>>削除

header Parameters
Accept
string
Example: application/json
Request Body schema: application/json
date
required
string <date>

稼働日

vehicle_id
required
Array of integers

車両IDリスト

Responses

Request samples

Content type
application/json
{
  • "date": "2024-07-25",
  • "vehicle_id": [
    ]
}

Response samples

Content type
application/json
{ }

稼働車両一覧取得API

稼働車両一覧取得を行うAPI
リクエストの日付から日数分の稼働車両を取得する
日数が指定されていない場合は、日付に紐づく稼働車両のみを取得

query Parameters
date
required
string <date>

日付

number_of_days
integer

日数

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "operational_vehicle_list": [
    ]
}

車両管理

車両一覧取得API

車両一覧取得を行うAPI

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "vehicle_list": [
    ]
}

車両登録API

車両登録を行うAPI

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
carrier_id
required
integer

依頼先業者ID

name
required
string

車両名

capacity_id
required
integer

積載量ID

Responses

Request samples

Content type
application/json
{
  • "carrier_id": 1,
  • "name": "車両X",
  • "capacity_id": 1
}

Response samples

Content type
application/json
{ }

車両更新API

id に紐づく、車両更新を行うAPI

path Parameters
vehicle_id
required
integer

車両ID

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
carrier_id
required
integer

依頼先業者ID

name
required
string

車両名

capacity_id
required
integer

積載量ID

Responses

Request samples

Content type
application/json
{
  • "carrier_id": 1,
  • "name": "車両X",
  • "capacity_id": 1
}

Response samples

Content type
application/json
{ }

車両詳細取得API

id に紐づく、車両詳細取得を行うAPI

path Parameters
vehicle_id
required
integer
header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "carrier_id": 1,
  • "name": "車両A",
  • "capacity_id": 1
}

車両削除API

id に紐づく、車両削除を行うAPI

path Parameters
vehicle_id
required
integer

車両ID

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

契約生産者管理

生産者一覧取得API

生産者一覧取得を行うAPI

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "farmer_list": [
    ]
}

生産者登録API

生産者登録を行うAPI

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
farmer_code
required
string

生産者コード

name
required
string

生産者名

name_kana
required
string

生産者名（かな）

address_prefecture
required
string

住所（都道府県）

address_city
required
string

住所（地区町村）

address_block
required
string

住所（番地以降）

address_latitude
required
integer

住所（緯度）

address_longitude
required
integer

住所（経度）

location_name
string or null

集荷先名称

capacity_id
required
integer

侵入可能車両

travel_time
required
integer

移動時間（分）

Responses

Request samples

Content type
application/json
{
  • "farmer_code": "1000",
  • "name": "農家A",
  • "name_kana": "のうかえー",
  • "address_prefecture": "青森県",
  • "address_city": "つがる市木造丸山竹鼻",
  • "address_block": "in amet",
  • "address_latitude": 11.1111,
  • "address_longitude": 22.2222,
  • "location_name": "ほげほげ",
  • "capacity_id": 1,
  • "travel_time": 30
}

Response samples

Content type
application/json
{ }

生産者更新API

id に紐づく、生産者更新を行うAPI

path Parameters
farmer_id
required
integer

生産者ID

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
farmer_code
required
string

生産者コード

name
required
string

生産者名

name_kana
required
string

生産者名（かな）

address_prefecture
required
string

住所（都道府県）

address_city
required
string

住所（地区町村）

address_block
required
string

住所（番地以降）

address_latitude
required
integer

住所（緯度）

address_longitude
required
integer

住所（経度）

location_name
string or null

集荷先名称

capacity_id
required
integer

侵入可能車両

travel_time
required
integer

移動時間（分）

Responses

Request samples

Content type
application/json
{
  • "farmer_code": "1000",
  • "name": "農家A",
  • "name_kana": "のうかえー",
  • "address_prefecture": "青森県",
  • "address_city": "つがる市木造丸山竹鼻",
  • "address_block": "in amet",
  • "address_latitude": 11.1111,
  • "address_longitude": 22.2222,
  • "location_name": "ふがふが",
  • "capacity_id": 1,
  • "travel_time": 30
}

Response samples

Content type
application/json
{ }

生産者詳細取得API

id に紐づく、生産者詳細取得を行うAPI

path Parameters
farmer_id
required
integer

生産者ID

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "農家A",
  • "name_kana": "のうかえー",
  • "address_prefecture": "青森県",
  • "address_city": "つがる市木造丸山竹鼻",
  • "address_block": "118-5",
  • "address_latitude": 11.1111,
  • "address_longitude": 22.2222,
  • "location_name": "ほげほげ",
  • "capacity_id": 1,
  • "travel_time": 30
}

生産者削除API

id に紐づく、生産者削除を行うAPI

path Parameters
farmer_id
required
integer

生産者ID

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

集荷依頼先業者管理

集荷依頼先業者一覧取得API

集荷依頼先業者一覧取得を行うAPI

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "carrier_list": [
    ]
}

集荷依頼先業者登録API

集荷依頼先業者登録を行うAPI

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
official_name
required
string

正式名称

abbreviated_name
required
string

略式

Responses

Request samples

Content type
application/json
{
  • "official_name": "サンライズ産業株式会社",
  • "abbreviated_name": "サンライズ"
}

Response samples

Content type
application/json
{ }

集荷依頼先業者詳細取得API

id に紐づく、集荷依頼先業者詳細取得を行うAPI

path Parameters
carrier_id
required
integer

集荷依頼先業者ID

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "official_name": "サンライズ産業株式会社",
  • "abbreviated_name": "サンライズ"
}

集荷依頼先業者更新API

id に紐づく、集荷依頼先業者更新を行うAPI

path Parameters
carrier_id
required
integer

集荷依頼先業者ID

header Parameters
Accept
required
string
Example: application/json
Request Body schema: application/json
official_name
required
string

正式名称

abbreviated_name
required
string

略式

Responses

Request samples

Content type
application/json
{
  • "official_name": "サンライズ産業株式会社",
  • "abbreviated_name": "サンライズ"
}

Response samples

Content type
application/json
{ }

集荷依頼先業者削除API

id に紐づく、集荷依頼先業者削除を行うAPI

path Parameters
carrier_id
required
integer

集荷依頼先業者ID

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

積載量管理

積載量一覧取得API

積載量一覧取得API

header Parameters
Accept
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "capacity_list": [
    ]
}