郡山市オープンデータ非公式WebAPI

概要

福島県郡山市が公開するオープンデータの一部をjson形式で返すWebAPIです。


API Endpoint	https://koriyama.api.alflag.org/
SSL	Support
Available HTTP Method	GET
Response format	json

レスポンスヘッダーのContent-Typeは application/json; charset=UTF-8 となっています。エラー発生時も同様です。

本APIのエラーはエラーメッセージとサーバが受け取ったリクエスト内容で表現されています。

Bad Request

リクエストされた内容が正しくないときに発生します。レスポンスヘッダーのステータスは 200 OK です。

{
  "error": {
    "message": "Bad Request",
    "request": {
      "method":"GET",
      "id": "",
      "url":""
    }
  }
}

Not Found

指定されたURLに該当するAPIが存在しないときに発生します。レスポンスヘッダーのステータスは 200 OK です。

{
  "error": {
    "message": "Not Found",
    "request": {
      "method":"GET",
      "url":""
    }
  }
}

郡山市役所ウェブサイトの「オープンデータの公共施設等情報」「オープンデータのその他の情報」で公開されているファイルの内容をjson形式で取得できます。

v1/{id} で全てを取得できます。 {id} には「オープンデータの公共施設等情報」「オープンデータのその他の情報」上で公開されているファイル名が入ります。以下は、idの早見表です。

APIから返される全てのjsonは、以下のフォーマットに基づいています。

{
    "last_updated": {time},
    "name": {name},
    "id": {id},
    "original_url": {url},
    "data": []
}

last_updated には内容が最後に更新された日時が入っています。

name には「オープンデータの公共施設等情報」上の分類名が入っています。

id には「オープンデータの公共施設等情報」で公開されているcsvのファイル名が入っています。

original_url には元データの取得元URLが入っています。

data には、取得されたcsvに基づいて生成された配列が入っています。元データが整形されている場合、data は返されません。