API docs by Redocly

ごみ収集アプリ (3.0)

Download OpenAPI specification:Download

ごみ収集アプリAPI

初回実行時（アプリ）

端末ID生成API

  • 422: バリデーションエラー（※ユーザーに見せる訳ではないので自動生成のメッセージを返却します）
  • 500: サーバーエラー

リクエストされた情報でユーザーを追加し、生成した udid を返却する

Request Body schema: application/json
os_kind
required
integer
Enum: 1 2

OS種別

city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Request samples

Content type
application/json
{
  • "os_kind": 1,
  • "city_id": 1
}

Response samples

Content type
application/json
{
  • "udid": "1268ce0e-cfe1-4a36-bbec-8b6445959e2b",
  • "version": {
    }
}

V3移行用API

  • 422: バリデーションエラー（※ユーザーに見せる訳ではないので自動生成のメッセージを返却します）
  • 500: サーバーエラー

V2 -> V3 移行時に端末内部に保持している V2 データを V3 形式に変換して DB のユーザー情報を更新、保存した値を返却する

変更点

  • city_cd: city_id に変更、値の変化なし
  • area_cd: area_id に変更、各自治体ごとに 1 から振っていた area_cd と違い、area_id は全自治体通して一意
  • previous_notice_hour => 1-5 から 1-22 に変更（19時-23時 => 13時-23時）
  • tody_notice_hour => 1-5 から 1-22 に変更（4時-8時 => 1時-11時）
path Parameters
udid
required
string <uuid>

端末ID（UUID）

Request Body schema: application/json
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Request samples

Content type
application/json
{
  • "city_id": 1
}

Response samples

Content type
application/json
{
  • "city_id": 1,
  • "area_id": 1,
  • "previous_notice_hour": 1,
  • "today_notice_hour": 1,
  • "version": {
    }
}

起動時（アプリ）

自治体情報取得API

  • 500: サーバーエラー

自治体 ID に紐づく自治体情報を取得し返却するAPI

path Parameters
city_id
required
integer

自治体ID

Responses

Response samples

Content type
application/json
{
  • "city_name": "八戸市",
  • "color_hex": "#93C200",
  • "color_rgb": "rgb(147,194,0)",
  • "default_latitude": 40.51230723036494,
  • "default_longitude": 141.48839128127122,
  • "representative_contact_email": "4LdBlACHRq@gmail.com",
  • "oversize_garbage_contact_email": "P7P21pvZ4L@gmail.com",
  • "report_contact_email": "JO9bFULzbn@gmail.com",
  • "can_use_recyclable_trash_base_map": 1,
  • "can_use_oversize_garbage_reservation": 0,
  • "can_use_report": 0,
  • "can_use_information_notification": 1,
  • "can_use_chatbot": 0,
  • "can_use_trash_collection_point_map": 0,
  • "use_open_data": 1,
  • "version": {
    }
}

設定（アプリ）

収集地区一覧取得API

  • 500: サーバーエラー

自治体 ID に紐づく収集地区の情報を全件取得し返却する API

※地区が無く、住所が地区になっている自治体ではこちらの API ではなく、収集住所一覧を使用する想定

query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Response samples

Content type
application/json
Example
{
  • "area_list": [
    ],
  • "version": {
    }
}

収集住所一覧取得API

  • 500: サーバーエラー

自治体 ID に紐づく収集住所の情報を全件取得し返却する API

※複数エリアと紐づく住所は「area_id = -1」

query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Response samples

Content type
application/json
{
  • "address_list": [
    ],
  • "version": {
    }
}

ユーザー設定取得API

  • 500: サーバーエラー

端末 ID に紐づくユーザーの設定情報を取得し返却するAPI

path Parameters
udid
required
string <uuid>

端末ID（UUID）

query Parameters
city_id
required
integer

自治体ID

Responses

Response samples

Content type
application/json
{
  • "area_id": 1,
  • "previous_notice_flag": 1,
  • "today_notice_flag": 1,
  • "previous_notice_hour": 2,
  • "today_notice_hour": 2,
  • "information_notice_flag": 1,
  • "version": {
    }
}

ユーザー設定更新API

  • 422: バリデーションエラー（※ユーザーに見せる訳ではないので自動生成のメッセージを返却します）
  • 500: サーバーエラー

端末 ID に紐づくユーザーの設定を更新するAPI
更新処理が完了したら、更新後の値を取得し返却する
地区設定変更時と通知設定変更時でリクエストする値が異なるため注意

path Parameters
udid
required
string <uuid>

端末ID（UUID）

Request Body schema: application/json
city_id
required
integer

自治体ID

area_id
integer

収集地区ID

previous_notice_flag
integer
Enum: 0 1

前日通知フラグ

today_notice_flag
integer
Enum: 0 1

当日通知フラグ

previous_notice_hour
integer
Enum: 1 2 3 4 5 6 7 8 9 10 11

前日通知時間

today_notice_hour
integer
Enum: 1 2 3 4 5 6 7 8 9 10 11

当日通知時間

information_notice_flag
integer
Enum: 0 1

お知らせ通知フラグ

device_token
string

デバイストークン

Responses

Request samples

Content type
application/json
Example
{
  • "city_id": 1,
  • "area_id": 1
}

Response samples

Content type
application/json
{
  • "area_id": 1,
  • "previous_notice_flag": 1,
  • "today_notice_flag": 1,
  • "previous_notice_hour": 5,
  • "today_notice_hour": 7,
  • "information_notice_flag": 0,
  • "device_token": "cvv2g8zxyMU:APA91bE8Z4gnL-z0lBnK06HicmvB4sbODW_TBGEWHf_a9PhPXsvMLOOVdmYTB4uyFmPaqGf3crXQFLOPlNpHbdxTi4mzzkWjDD_VLSKV1K2uAZLtN8FM6ObOjXWi2AUFR8rl70Igjq6c",
  • "version": {
    }
}

言語設定更新API

  • 500: サーバーエラー

端末ID に紐づくユーザーの言語設定を更新するAPI
※端末ID に紐づくユーザ情報が存在しない場合、更新処理は行わず 200 レスポンスを返却する
※言語情報 が null または空文字だった場合、更新処理は行わず 200 レスポンスを返却する

path Parameters
udid
required
string <uuid>

端末ID（UUID）

Request Body schema: application/json
language
string or null

言語情報

Responses

Request samples

Content type
application/json
{
  • "language": "ja"
}

Response samples

Content type
application/json
{ }

デバイストークン更新API

  • 422: バリデーションエラー（※ユーザーに見せる訳ではないので自動生成のメッセージを返却します）
  • 500: サーバーエラー

端末 ID に紐づくデバイストークンを更新するAPI
更新処理が完了したら、更新後の値を取得し返却する

path Parameters
udid
required
string

端末ID（UUID）

Request Body schema: application/json
city_id
required
integer

自治体ID

device_token
string or null

デバイストークン

Responses

Request samples

Content type
application/json
{
  • "city_id": 1,
  • "device_token": "55C290FF0526CBAE0397026CB7A2D759AEB371A22D"
}

Response samples

Content type
application/json
{
  • "area_id": 1,
  • "previous_notice_flag": 1,
  • "today_notice_flag": 1,
  • "previous_notice_hour": 5,
  • "today_notice_hour": 7,
  • "information_notice_flag": 0,
  • "device_token": "55C290FF0526CBAE0397026CB7A2D759AEB371A22D",
  • "version": {
    }
}

収集ごみ関連（アプリ）

収集日程一覧取得API

  • 500: サーバーエラー

収集地区 ID に紐づく収集日程の情報を全件取得し返却するAPI

query Parameters
area_id
required
integer

地区ID

city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Response samples

Content type
application/json
{
  • "schedule_list": [
    ],
  • "version": {
    }
}

ごみ収集適用日取得API

  • 500: サーバーエラー

ごみ収集適用日を取得し返却するAPI

path Parameters
city_id
required
integer

自治体ID

Responses

Response samples

Content type
application/json
{
  • "apply_start_at": "2022-04-01 00:00:00",
  • "apply_end_at": "2023-03-31 23:59:59",
  • "version": {
    }
}

回収ごみ分類一覧取得API

  • 500: サーバーエラー

自治体 ID に紐づく回収ごみ分類を全件取得し返却するAPI
表示順の昇順にソートして返却すること

query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Response samples

Content type
application/json
{
  • "collect_trash_type_list": [
    ],
  • "version": {
    }
}

ごみの捨て方・出し方一覧取得API

  • 500: サーバーエラー

自治体IDに紐づく、ごみの捨て方・出し方の情報を全件取得し返却するAPI

query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Response samples

Content type
application/json
{
  • "method_list": [
    ],
  • "version": {
    }
}

ごみデータ（アプリ）

ごみ分類一覧取得API

  • 500: サーバーエラー

自治体のごみ分類一覧（ごみ分別辞典用）を返却する

※自治体によっては収集地区で分類が異なるためすべての自治体で area_id も渡し、下記手順を行う

  1. area_id(@param) を基に area_group_id を特定
  2. city_id(@param) と area_group_id で絞り込み
  3. 一致したデータを表示順の昇順にソートして返却
query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

area_id
required
integer

地区ID

Responses

Response samples

Content type
application/json
{
  • "trash_type_list": [
    ],
  • "version": {
    }
}

ごみデータ一覧取得API

  • 500: サーバーエラー

自治体IDと収集地区IDに紐づく、ごみの情報を全件取得しひらがなの50音順で返却するAPI
※自治体によっては収集地区で分類が異なるためすべての自治体で area_id を渡す
※念のためごみ分類 ID でも絞り込めるようにパラメータを用意する

query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

area_id
required
integer

地区ID

trash_type_id
integer

ごみ分類ID

Responses

Response samples

Content type
application/json
{
  • "trash_list": [
    ],
  • "version": {
    }
}

ごみデータ詳細取得API

  • 500: サーバーエラー

ごみ ID に紐づくごみの詳細情報を取得し返却するAPI

path Parameters
trash_id
required
integer

ごみID

query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Response samples

Content type
application/json
{
  • "trash_name": "ACアダプタ",
  • "material_size": null,
  • "collect_point": "小型家電回収ボックス",
  • "notes": "できるだけ使用済小型家電の拠点回収に出すこと",
  • "trash_type_id": 2,
  • "trash_type_name": "燃やせないごみ",
  • "version": {
    }
}

キーワード登録API

  • 422: バリデーションエラー（※ユーザーに見せる訳ではないので自動生成のメッセージを返却します）
  • 500: サーバーエラー

検索ワードと回数を登録するAPI

Request Body schema: application/json
Array of objects

検索ワード

area_id
required
integer

収集地区ID

city_id
required
integer

自治体ID

Responses

Request samples

Content type
application/json
{
  • "keyword_list": [
    ],
  • "area_id": 1,
  • "city_id": 1
}

Response samples

Content type
application/json
{
  • "version": {
    }
}

お知らせ（アプリ）

新着お知らせチェックAPI

  • 500: サーバーエラー

自治体に紐づく新着お知らせがあるかをチェックするAPI

新着お知らせの条件

  • 公開中のお知らせであること
  • 公開後3日以内のお知らせであること
  • udid(@param)に紐づくユーザーが未読であること

条件に当てはまるお知らせが1件でも存在する場合、レスポンスの is_new_information を true で返却する

query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

udid
required
string

端末ID

Responses

Response samples

Content type
application/json
{
  • "is_new_information": 1,
  • "version": {
    }
}

お知らせ一覧取得API

  • 500: サーバーエラー

自治体IDに紐づく、お知らせの情報を全件取得し返却するAPI

query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

udid
required
integer

端末ID

Responses

Response samples

Content type
application/json
{
  • "information_list": [
    ],
  • "version": {
    }
}

お知らせ詳細取得API

  • 500: サーバーエラー

お知らせIDに紐づく、お知らせの詳細情報を取得し返却するAPI
お知らせ詳細APIが叩かれた際に、端末IDを元にお知らせ既読処理を行う。

path Parameters
information_id
required
integer

お知らせID

query Parameters
udid
required
string

端末ID

city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Response samples

Content type
application/json
{
  • "title": "Androidアプリを公開しました。",
  • "sub_title": null,
  • "content": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  • "image_url": "http://XXX/XXX.png",
  • "publication_start_at": "2016-09-13 00:00:00",
  • "publication_end_at": "2016-12-13 23:59:59",
  • "version": {
    }
}

資源物回収拠点（アプリ）

資源物回収品目一覧取得API

  • 500: サーバーエラー

資源物回収品目の情報を全件取得し返却するAPI

is_hidden: 意図的に項目を隠したい場合に使用する => 弘前市は「びん」を非表示

上から順にID 0,1,2,3...

全て
ペットボトル
かん
びん
プラスチック容器
白色トレイ
紙パック
段ボール
新聞
雑誌
雑がみ
小型家電
衣類
その他
query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

Responses

Response samples

Content type
application/json
{
  • "recyclable_trash_type_list": [
    ],
  • "version": {
    }
}

資源物回収拠点一覧取得API

  • 500: サーバーエラー

資源物回収拠点の情報を全件取得し返却するAPI

query Parameters
city_id
required
integer
Enum: 1 2 3 4 5 6 7 8 9

自治体ID

recyclable_trash_type_id
required
integer

資源物ID

Responses

Response samples

Content type
application/json
{
  • "base_list": [
    ],
  • "version": {
    }
}

粗大ごみ受付（アプリ）

粗大ごみ回収受付API

  • 422: バリデーションエラー
  • 500: サーバーエラー

粗大ごみの回収受付をするときに使用するAPI

Request Body schema: application/json
udid
required
string

端末ID

city_id
required
integer

自治体ID

requester_name
required
string

依頼者名

phone_number
required
string

電話番号

collect_location
required
string

回収場所

latitude
required
number <double>

緯度

longitude
required
number <double>

経度

garbage_image_file
required
string <binary>

粗大ごみ画像ファイル

garbage_information
required
string

ごみの情報

Responses

Request samples

Content type
application/json
{
  • "udid": "1268ce0e-cfe1-4a36-bbec-8b6445959e2b",
  • "city_id": 1,
  • "requester_name": "山田 太郎",
  • "phone_number": "0178-00-0000",
  • "collect_location": "青森県八戸市XXXXXXXXX",
  • "latitude": 40.525061,
  • "longitude": 141.508135,
  • "garbage_image_file": "XXX.png",
  • "garbage_information": "XXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Response samples

Content type
application/json
{
  • "version": {
    }
}

不法投棄・小動物死骸通報（アプリ）

不法投棄・小動物死骸通報API

  • 422: バリデーションエラー
  • 500: サーバーエラー

道路上の不法投棄・小動物死骸の通報をする時に使用するAPI

Request Body schema: application/json
udid
required
string

端末ID

city_id
required
integer

自治体ID

report_type
required
integer

通報タイプ

reporter_name
required
string

通報者名

phone_number
required
string

電話番号

report_location
required
string

通報場所

latitude
required
number <double>

緯度

longitude
required
number <double>

経度

object_image_file
string or null <binary>

対象物画像ファイル

remarks
string or null

備考

Responses

Request samples

Content type
application/json
{
  • "udid": "1268ce0e-cfe1-4a36-bbec-8b6445959e2b",
  • "city_id": 1,
  • "report_type": 0,
  • "reporter_name": "山田 太郎",
  • "phone_number": "080-0000-0000",
  • "report_location": "青森県八戸市XXXXXXXXX",
  • "latitude": 40.525061,
  • "longitude": 141.508135,
  • "object_image_file": "XXX.png",
  • "remarks": ""
}

Response samples

Content type
application/json
{
  • "version": {
    }
}

認証系

ログインAPI

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

ログインに使用するAPI

Request Body schema: application/json
login_id
required
string

ログインID

password
required
string <password>

パスワード

Responses

Request samples

Content type
application/json
{
  • "login_id": "admin_hachinohe",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "city_name": "八戸市",
  • "login_id": "admin_hachinohe",
  • "color_hex": "#93C200",
  • "color_rgb": "rgb(147,194,0)",
  • "area_group_list": [
    ],
  • "default_latitude": 40.51230723036494,
  • "default_longitude": 141.48839128127122,
  • "can_use_recyclable_trash_base_map": false,
  • "can_use_oversize_garbage_reservation": false,
  • "can_use_report": false,
  • "can_use_information_notification": false
}

ログイン情報取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

既にログイン済みの場合、ログイン情報を取得して返却するAPI

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "city_name": "八戸市",
  • "login_id": "admin_hachinohe",
  • "color_hex": "#93C200",
  • "color_rgb": "rgb(147,194,0)",
  • "area_group_list": [
    ],
  • "default_latitude": 40.51230723036494,
  • "default_longitude": 141.48839128127122,
  • "can_use_recyclable_trash_base_map": false,
  • "can_use_oversize_garbage_reservation": false,
  • "can_use_report": false,
  • "can_use_information_notification": false
}

ログアウトAPI

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

ログアウトに使用するAPI

Responses

Response samples

Content type
application/json
{ }

お知らせ

お知らせ一覧取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体に紐づくお知らせを全件取得し返却するAPI
公開開始日時の降順で返却

query Parameters
city_id
required
integer

自治体ID

Responses

Response samples

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

お知らせ登録API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

お知らせの登録を行う API

Request Body schema: application/json
city_id
required
integer

自治体ID

title
required
string

タイトル

sub_title
string or null

サブタイトル

content
required
string

本文

image_file
string or null <binary>

画像ファイル

publication_start_at
required
string <date-time>

公開開始日時

publication_end_at
required
string <date-time>

公開終了日時

Responses

Request samples

Content type
application/json
{
  • "city_id": 1,
  • "title": "住所データ更新のお知らせ及び再設定のお願い",
  • "sub_title": null,
  • "content": "\"<div><span style=\"font-size: 12px;\">いつもごみ収集アプリをご利用いただきありがとうございます。</span></div><div><span style=\"font…",
  • "image_file": null,
  • "publication_start_at": "2022-12-01 07:00:00",
  • "publication_end_at": "2022-12-15 07:00:00"
}

Response samples

Content type
application/json
{ }

お知らせ詳細取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

お知らせIDに紐づく、お知らせの詳細情報を取得して返却するAPI

path Parameters
information_id
required
integer

お知らせID

Responses

Response samples

Content type
application/json
{
  • "title": "タイトル",
  • "sub_title": "サブタイトル",
  • "content": "本文",
  • "image_url": "http://XXX/XXX.png",
  • "publication_start_at": "2022-12-01 07:00:00",
  • "publication_end_at": "2022-12-15 07:00:00"
}

お知らせ更新API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

お知らせ情報を更新するAPI

画像ファイルの取扱い

リクエストに画像ファイルがある場合
  1. 画像を追加する
  2. 既存の画像が存在するかチェックする（存在しない場合ここで終了）
  3. 既存の画像を削除する
リクエストに画像ファイルがない場合
  1. 画像ファイル削除フラグが true かチェックする（falseの場合ここで終了）
  2. 既存の画像が存在するかチェックする（存在しない場合ここで終了）
  3. 既存の画像を削除する

※画像が削除された場合は画像URLをnullに、追加/更新された場合は画像URLの更新を行うこと
※処理に失敗した際にロールバックを行うことを前提に、DBの更新 => 画像追加 => 画像削除 の順で行うこと（画像を削除したあと元に戻すのは困難であるため）

path Parameters
information_id
required
integer

お知らせID

Request Body schema: application/json
title
required
string

タイトル

sub_title
string or null

サブタイトル

content
required
string

本文

image_file
string or null <binary>

画像ファイル

is_delete_image
boolean

画像ファイル削除フラグ

publication_start_at
required
string <date-time>

公開開始日時

publication_end_at
required
string <date-time>

公開終了日時

Responses

Request samples

Content type
application/json
{
  • "title": "住所データ更新のお知らせ及び再設定のお願い",
  • "sub_title": null,
  • "content": "\"<div><span style=\"font-size: 12px;\">いつもごみ収集アプリをご利用いただきありがとうございます。</span></div><div><span style=\"font…",
  • "image_file": null,
  • "is_delete_image": false,
  • "publication_start_at": "2022-12-01 07:00:00",
  • "publication_end_at": "2022-12-15 07:00:00"
}

Response samples

Content type
application/json
{ }

お知らせ削除API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

お知らせIDに紐づく、お知らせ情報を削除するAPI

path Parameters
information_id
required
integer

お知らせID

Responses

Response samples

Content type
application/json
{ }

キーワード検索

収集地区取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく、収集地区の一覧情報を取得し返却するAPI

query Parameters
city_id
required
integer

自治体ID

Responses

Response samples

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

キーワード取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく、キーワードの一覧情報を取得し返却するAPI
収集地区IDが存在した場合、収取地区IDに紐づく地区別キーワードを取得し、
収集地区IDが存在しなかった場合、キーワードを取得する
キーワードは昇順で返却する

query Parameters
city_id
required
integer

自治体ID

area_id
integer

収集地区ID

start_date
string <date>

絞り込み開始日

end_date
string <date>

絞り込み終了日

Responses

Response samples

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

資源物回収拠点

資源物回収拠点取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく、資源物回収拠点の一覧情報を取得し返却するAPI
IDの昇順で返却する

query Parameters
city_id
required
integer

自治体ID

Responses

Response samples

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

資源物回収拠点登録API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

資源物回収拠点情報の登録を行うAPI

Request Body schema: application/json
city_id
required
integer

自治体ID

facility
required
string

施設名（資源物回収拠点名）

address
required
string

住所

latitude
required
number <double>

緯度

longitude
required
number <double>

経度

phone
required
string

電話番号

business_hours
required
string

営業時間

pet_bottles
required
boolean

ペットボトル

can
required
boolean

かん

bottle
required
boolean

びん

plastic_container
required
boolean

プラスチック容器

white_tray
required
boolean

白色トレイ

paper_pack
required
boolean

紙パック

cardboard
required
boolean

段ボール

newspaper
required
boolean

新聞紙

magazine
required
boolean

雑誌

miscellaneous_paper
required
boolean

雑がみ

small_household_appliances
required
boolean

小型家電

clothing
required
boolean

衣類

food
required
boolean

食品

other_trash
required
boolean

その他

other_trash_item
string or null

その他項目

collection_item
string

収集項目

point
string or null

ポイント付与

remarks
string or null

備考

Responses

Request samples

Content type
application/json
{
  • "city_id": 1,
  • "facility": "XXX店",
  • "address": "XX市XXX",
  • "latitude": 40.52490432816431,
  • "longitude": 141.5082903158939,
  • "phone": "00-0000",
  • "business_hours": "9:00 ～ 12:00",
  • "pet_bottles": true,
  • "can": true,
  • "bottle": true,
  • "plastic_container": false,
  • "white_tray": false,
  • "paper_pack": false,
  • "cardboard": false,
  • "newspaper": false,
  • "magazine": false,
  • "miscellaneous_paper": false,
  • "small_household_appliances": false,
  • "clothing": false,
  • "food": false,
  • "other_trash": true,
  • "other_trash_item": "インクカートリッジ",
  • "collection_item": "ペットボトル・かん・びん",
  • "point": "XXXX",
  • "remarks": "XXXXXXXXXXXXXXXXXXXXX"
}

Response samples

Content type
application/json
{ }

資源物回収拠点詳細取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

資源物回収拠点IDに紐づく、資源物回収拠点の詳細情報を取得し返却するAPI

path Parameters
base_id
required
integer

資源物回収拠点ID

Responses

Response samples

Content type
application/json
{
  • "facility": "市役所本庁舎",
  • "address": "上白銀町１－１",
  • "latitude": 40.603141,
  • "longitude": 140.463768,
  • "phone": "35-1130",
  • "business_hours": "平日8:30～17:00",
  • "pet_bottles": false,
  • "can": false,
  • "bottle": false,
  • "plastic_container": false,
  • "white_tray": true,
  • "paper_pack": false,
  • "cardboard": true,
  • "newspaper": true,
  • "magazine": true,
  • "miscellaneous_paper": true,
  • "small_household_appliances": true,
  • "clothing": true,
  • "food": true,
  • "other_trash": true,
  • "other_trash_item": "インクカートリッジ・水銀使用製品(温度計・体温計など)",
  • "collection_item": "白色トレイ、段ボール、新聞、雑誌、雑がみ、小型家電、衣類、食品(フードボックス)、その他（インクカートリッジ・水銀使用製品(温度計・体温計など)）",
  • "point": null,
  • "remarks": null
}

資源物回収拠点更新API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

資源物回収拠点IDに紐づく、資源物回収拠点情報を更新するAPI

path Parameters
base_id
required
integer

資源物回収拠点ID

Request Body schema: application/json
facility
required
string

施設名（資源物回収拠点名）

address
required
string

住所

latitude
required
number <double>

緯度

longitude
required
number <double>

経度

phone
required
string

電話番号

business_hours
required
string

営業時間

pet_bottles
required
boolean

ペットボトル

can
required
boolean

かん

bottle
required
boolean

びん

plastic_container
required
boolean

プラスチック容器

white_tray
required
boolean

白色トレイ

paper_pack
required
boolean

紙パック

cardboard
required
boolean

段ボール

newspaper
required
boolean

新聞

magazine
required
boolean

雑誌

miscellaneous_paper
required
boolean

雑がみ

small_household_appliances
required
boolean

小型家電

clothing
required
boolean

衣類

food
required
boolean

食品

other_trash
required
boolean

その他

other_trash_item
string or null

その他項目

collection_item
string

収集項目

point
string or null

ポイント付与

remarks
string or null

備考

Responses

Request samples

Content type
application/json
{
  • "facility": "XXX店",
  • "address": "XX市XXX",
  • "latitude": 40.52490432816431,
  • "longitude": 141.5082903158939,
  • "phone": "00-0000",
  • "business_hours": "9:00 ～ 12:00",
  • "pet_bottles": true,
  • "can": true,
  • "bottle": true,
  • "plastic_container": false,
  • "white_tray": false,
  • "paper_pack": false,
  • "cardboard": false,
  • "newspaper": false,
  • "magazine": false,
  • "miscellaneous_paper": false,
  • "small_household_appliances": false,
  • "clothing": false,
  • "food": false,
  • "other_trash": true,
  • "other_trash_item": "インクカートリッジ",
  • "collection_item": "ペットボトル・かん・びん",
  • "point": "XXXX",
  • "remarks": "XXXXXXXXXXXXXXXXXXXXX"
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

資源物回収拠点削除API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

資源物回収拠点IDに紐づく、資源物回収拠点情報を削除するAPI

path Parameters
base_id
required
integer

資源物回収拠点ID

Responses

Response samples

Content type
application/json
{ }

ごみの捨て方・出し方

ごみの捨て方・出し方取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく、ごみの捨て方・出し方の一覧情報を取得し返却するAPI
表示順の昇順で返却する

query Parameters
city_id
required
integer

自治体ID

Responses

Response samples

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

ごみの捨て方・出し方詳細取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

ごみの捨て方IDに紐づく、ごみの捨て方・出し方の詳細情報を取得し返却するAPI

path Parameters
disposal_method_id
required
integer

ごみの捨て方ID

Responses

Response samples

Content type
application/json
{
  • "text": "XXXXXXXXXXXXXXXX",
  • "image_url": "http://XXX/XXX.png",
  • "is_publish": true,
  • "collect_trash_type": {
    }
}

ごみの捨て方・出し方更新API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

ごみの捨て方・出し方を更新するAPI

画像ファイルの取扱い

リクエストに画像ファイルがある場合
  1. 画像を追加する
  2. 既存の画像が存在するかチェックする（存在しない場合ここで終了）
  3. 既存の画像を削除する
リクエストに画像ファイルがない場合
  1. 画像ファイル削除フラグが true かチェックする（falseの場合ここで終了）
  2. 既存の画像が存在するかチェックする（存在しない場合ここで終了）
  3. 既存の画像を削除する

※画像が削除された場合は画像URLをnullに、追加/更新された場合は画像URLの更新を行うこと
※処理に失敗した際にロールバックを行うことを前提に、DBの更新 => 画像追加 => 画像削除 の順で行うこと（画像を削除したあと元に戻すのは困難であるため）

path Parameters
disposal_method_id
required
integer

ごみの捨て方ID

Request Body schema: application/json
text
string

テキスト

image_file
string <binary>

画像ファイル

is_delete_image
boolean

画像ファイル削除フラグ

is_publish
required
boolean

公開フラグ

Responses

Request samples

Content type
application/json
{
  • "text": "XXXXXXXXXXXXXXXX",
  • "image_file": "XXX.png",
  • "is_delete_image": false,
  • "is_publish": true
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

ごみ分類

ごみ登録・更新画面用ごみ分類取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体ID・地区グループIDに紐づく、ごみ分類の一覧情報を取得し返却するAPI
※弘前市の場合のレスポンスの値が追加されます。

query Parameters
city_id
required
integer

自治体ID

area_group_id
integer

地区グループID

Responses

Response samples

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

ごみ分類取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく、ごみ分類の一覧情報を取得し返却するAPI

query Parameters
city_id
required
integer

自治体ID

area_group_id
integer

地区グループID

Responses

Response samples

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

ごみ分類追加API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

ごみ分類情報の登録を行うAPI

Request Body schema: application/json
city_id
required
integer

自治体ID

trash_name
required
string

ごみ名

trash_name_kana
required
string

ごみ名かな

material_size
string or null

素材・サイズ

collect_point
integer or null

拠点回収

notes
string or null

注意事項

trash_type_id
required
integer

ごみ分類ID

Responses

Request samples

Content type
application/json
{
  • "city_id": 1,
  • "trash_name": "ACアダプタ",
  • "trash_name_kana": "えーしーあだぷた",
  • "material_size": null,
  • "collect_point": 0,
  • "notes": "できるだけ使用済小型家電の拠点回収に出す",
  • "trash_type_id": 2
}

Response samples

Content type
application/json
{ }

ごみ分類詳細取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

ごみIDに紐づく、ごみ分類の詳細情報を取得し返却するAPI

path Parameters
trash_id
required
integer

ごみID

Responses

Response samples

Content type
application/json
{
  • "trash_name": "ACアダプタ",
  • "trash_name_kana": "えーしーあだぷた",
  • "material_size": null,
  • "collect_point": 0,
  • "notes": "できるだけ使用済小型家電の拠点回収に出す",
  • "trash_type_id": 2
}

ごみ分類更新API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

ごみIDに紐づく、ごみ分類情報を更新するAPI

path Parameters
trash_id
required
integer

ごみID

Request Body schema: application/json
trash_name
required
string

ごみ名

trash_name_kana
required
string

ごみ名かな

material_size
string or null

素材・サイズ

collect_point
integer or null

拠点回収

notes
string or null

注意事項

trash_type_id
required
integer

ごみ分類ID

Responses

Request samples

Content type
application/json
{
  • "trash_name": "ACアダプタ",
  • "trash_name_kana": "えーしーあだぷた",
  • "material_size": null,
  • "collect_point": 0,
  • "notes": "できるだけ仕様済小型家電の拠点回収に出す",
  • "trash_type_id": 2
}

Response samples

Content type
application/json
{ }

ごみ分類削除API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

ごみIDに紐づく、ごみ分類情報を削除するAPI

path Parameters
trash_id
required
integer

ごみID

Responses

Response samples

Content type
application/json
{ }

ごみ収集日程

年度一覧取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく、収集日程の適用開始日yyyy-mm-ddの年度yyyyを一覧で取得し返却するAPI
ごみ収集日程の期間の絞り込みで使用

query Parameters
city_id
required
integer

自治体ID

Responses

Response samples

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

収集ごみ分類取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく、回収ごみ分類の一覧情報を取得し返却するAPI
ごみ収集日程のテーブルヘッダー部分で使用

query Parameters
city_id
required
integer

自治体ID

Responses

Response samples

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

ごみ収集日程一覧取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体ID及び適用開始日に紐づく、ごみ収集日程の一覧情報を取得し返却するAPI

query Parameters
city_id
required
integer

自治体ID

apply_started_on
required
string

適用開始日

Responses

Response samples

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

ごみ収集日程詳細取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

ごみ収集日程IDに紐づく、ごみ収集日程の詳細情報を取得し返却するAPI
収集日一覧は収集タイプ、収集週フラグ、収集曜日フラグを元に生成する

path Parameters
schedule_id
required
integer

ごみ収集日程ID

Responses

Response samples

Content type
application/json
Example
{
  • "area_name": "鮫・白銀・湊・上長・美保野",
  • "collect_trash_type_name": "燃えるごみ",
  • "collect_type": "weekly",
  • "is_collect_first_week": true,
  • "is_collect_second_week": true,
  • "is_collect_third_week": true,
  • "is_collect_fourth_week": true,
  • "is_collect_fifth_week": true,
  • "is_collect_sunday": false,
  • "is_collect_monday": true,
  • "is_collect_tuesday": false,
  • "is_collect_wednesday": false,
  • "is_collect_thursday": true,
  • "is_collect_friday": false,
  • "is_collect_saturday": false,
  • "collect_date_list": [
    ],
  • "additional_list": [
    ],
  • "exclusion_list": [
    ],
  • "apply_date": {
    }
}

ごみ収集日程更新API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

ごみ収集日程IDに紐づく、ごみ収集日程情報を更新するAPI

path Parameters
schedule_id
required
integer

ごみ収集日程ID

Request Body schema: application/json
collect_type
string

収集タイプ

is_collect_first_week
boolean

第1収集フラグ

is_collect_second_week
boolean

第2収集フラグ

is_collect_third_week
boolean

第3収集フラグ

is_collect_fourth_week
boolean

第4収集フラグ

is_collect_fifth_week
boolean

第5収集フラグ

is_collect_sunday
boolean

日曜日収集フラグ

is_collect_monday
boolean

月曜日収集フラグ

is_collect_tuesday
boolean

火曜日収集フラグ

is_collect_wednesday
boolean

水曜日収集フラグ

is_collect_thursday
boolean

木曜日収集フラグ

is_collect_friday
boolean

金曜日収集フラグ

is_collect_saturday
boolean

土曜日収集フラグ

additional_list
Array of any

追加収集日程

exclusion_list
Array of any

除外収集日程

Responses

Request samples

Content type
application/json
{
  • "collect_type": "weekly",
  • "is_collect_first_week": true,
  • "is_collect_second_week": true,
  • "is_collect_third_week": true,
  • "is_collect_fourth_week": true,
  • "is_collect_fifth_week": true,
  • "is_collect_sunday": false,
  • "is_collect_monday": false,
  • "is_collect_tuesday": true,
  • "is_collect_wednesday": false,
  • "is_collect_thursday": true,
  • "is_collect_friday": false,
  • "is_collect_saturday": false,
  • "additional_list": [
    ],
  • "exclusion_list": [
    ]
}

Response samples

Content type
application/json
{ }

カレンダ―取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

収集地区IDに紐づく、ごみ収集日程の一覧情報を取得し返却するAPI

path Parameters
area_id
required
integer

収集地区ID

query Parameters
apply_started_on
required
string <date>

適用開始日

Responses

Response samples

Content type
application/json
{
  • "schedule_list": [
    ],
  • "apply_date": {
    }
}

収集日程生成API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

リクエストされた情報に基づいた、収集日程を生成し返却するAPI

収集タイプが custom だった場合 空配列を返却

query Parameters
collect_type
required
string

収集タイプ

apply_started_on
required
string <date>

適用開始日

apply_ended_on
required
string <date>

適用終了日

is_collect_first_week
required
boolean

第1収集フラグ

is_collect_second_week
required
boolean

第2週収集フラグ

is_collect_third_week
required
boolean

第3週収集フラグ

is_collect_fourth_week
required
boolean

第4週収集フラグ

is_collect_fifth_week
required
boolean

第5週収集フラグ

is_collect_sunday
required
boolean

日曜日収集フラグ

is_collect_monday
required
boolean

月曜日収集フラグ

is_collect_tuesday
required
boolean

火曜日収集フラグ

is_collect_wednesday
required
boolean

水曜日収集フラグ

is_collect_thursday
required
boolean

木曜日収集フラグ

is_collect_friday
required
boolean

金曜日収集フラグ

is_collect_saturday
required
boolean

土曜日収集フラグ

Responses

Response samples

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

粗大ごみ回収依頼

粗大ごみ回収依頼一覧取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく、粗大ごみ回収依頼の一覧情報を取得し返却するAPI

query Parameters
city_id
required
integer

自治体ID

Responses

Response samples

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

粗大ごみ回収依頼詳細取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

粗大ごみ回収IDに紐づく粗大ごみ回収依頼の詳細情報を取得し返却するAPI

path Parameters
oversize_garbage_id
required
integer

受付ID

Responses

Response samples

Content type
application/json
{
  • "requester_name": "山田 太郎",
  • "phone_number": "0178-00-0000",
  • "collect_location": "青森県八戸市XXXXXXXXXX",
  • "latitude": 40.525061,
  • "longitude": 141.508135,
  • "garbage_information": "XXXXXXXXXXXXXXXXXX",
  • "garbage_image_url": "http://XXX/XXX.png",
  • "status": 1
}

粗大ごみ回収依頼更新API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

粗大ごみ回収依頼情報を更新するAPI

path Parameters
oversize_garbage_id
required
integer

受付ID

Request Body schema: application/json
status
required
integer

ステータス

Responses

Request samples

Content type
application/json
{
  • "status": 2
}

Response samples

Content type
application/json
{ }

粗大ごみ回収依頼削除API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

粗大ごみ回収依頼情報を削除するAPI

path Parameters
oversize_garbage_id
required
integer

受付ID

Responses

Response samples

Content type
application/json
{ }

不法投棄・小動物死骸通報

不法投棄・小動物死骸通報一覧取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく道路上の不法投棄・小動物死骸通報情報を全件取得し返却するAPI

query Parameters
city_id
required
integer

自治体ID

Responses

Response samples

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

不法投棄・小動物死骸通報詳細取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

通報IDに紐づく道路上の不法投棄・小動物死骸通報の詳細情報を取得し返却するAPI

path Parameters
report_id
required
integer

通報ID

Responses

Response samples

Content type
application/json
{
  • "report_type": 1,
  • "reporter_name": "山田 太郎",
  • "phone_number": "080-0000-0000",
  • "report_location": "青森県八戸市XXXXXXXXX",
  • "latitude": 40.525061,
  • "longitude": 141.508135,
  • "remarks": "XXXXXXXXXXXXXXXXXXXXXXXXXXX",
  • "object_image_url": "http://XXX/XXX.png",
  • "status": 1
}

不法投棄・小動物死骸通報更新API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

通報IDに紐づく道路上の不法投棄・小動物死骸通報情報を更新するAPI

path Parameters
report_id
required
integer

通報ID

Request Body schema: application/json
status
required
integer

ステータス

Responses

Request samples

Content type
application/json
{
  • "status": 0
}

Response samples

Content type
application/json
{ }

不法投棄・小動物死骸通報削除API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

通報IDに紐づく道路上の不法投棄・小動物死骸通報情報を削除するAPI

path Parameters
report_id
required
integer

通報ID

Responses

Response samples

Content type
application/json
{ }

設定

自治体設定詳細取得API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 500: サーバーエラー

自治体IDに紐づく、連絡先情報を取得し返却するAPI

path Parameters
city_id
required
string

自治体ID

Responses

Response samples

Content type
application/json
{
  • "representative_contact_email": "xxxxxxxxx@city.hachinohe.aomori.jp",
  • "oversize_garbage_contact_email": "xxxxxxxxx@city.hachinohe.aomori.jp",
  • "report_contact_email": "xxxxxxxxx@city.hachinohe.aomori.jp"
}

自治体設定更新API

  • 401: 認証エラー（ログインしていない、アクセス権限がない等）
  • 422: バリデーションエラー
  • 500: サーバーエラー

自治体IDに紐づく、連絡先情報を更新するAPI

path Parameters
city_id
required
string

自治体ID

Request Body schema: application/json
representative_contact_email
string <email>

代表連絡先メールアドレス

oversize_garbage_contact_email
string <email>

粗大ごみ回収メールアドレス

report_contact_email
string <email>

通報受付メールアドレス

Responses

Request samples

Content type
application/json
Example
{
  • "representative_contact_email": "user@example.com"
}

Response samples

Content type
application/json
{ }