Warning

提供を終了しました。 いつか作り直した新バージョンを公開するかもしれません。

以下は、サービス提供当時のドキュメントです。

概要

福島県郡山市が公開しているオープンデータの一部を、JSON 形式で提供する非公式の WebAPI です。

注意事項

  • 本 API は非公式なものであり、郡山市役所とは一切関係ありません。
  • 本 API の利用によって生じたいかなる損害についても、提供者は責任を負いません。
  • データの完全性、正確性、有用性、安全性などを保証するものではありません。
  • 本 API の内容(データを含む)は、予告なく変更、削除、またはサービス全体が停止されることがあります。
  • 提供されるデータは、郡山市のオープンデータを加工したものです。
  • データは CC BY 4.0 ライセンスで提供されます。
  • データの利用にあたっては、郡山市オープンデータ利用規約 を遵守してください。
  • API への過度なリクエストは避けてください。

使い方

レスポンスヘッダーの CONTENT-TYPE について

レスポンスヘッダーの 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": ""
    }
  }
}

API

API の概要

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

エンドポイント

v1/{id}

{id} には、郡山市のオープンデータサイトで公開されているファイル名が入ります。

ID 早見表

IDデータ
1603「市民提案制度」提案等と対応状況(平成 29 年度分)
1604「市民提案制度」提案等と対応状況(平成 28 年度分)
1605「ココナビこおりやま」年度別月別件数
1606鯉の生産量
1607鯉料理提供店舗数
1705市の行政サービス
1706ふれあいセンター・コミュニティセンター
1707公民館
1708保健所
1709病院
1710福祉・子育て支援施設
1711働く人のための施設
1712上下水道局
1713衛生
1714霊園
1715火葬場
1716消防
1717郡山水防センター
1718保育所(認可保育所)
1719その他の私立保育園
1720幼稚園(私立幼稚園)
1721小学校
1722中学校
1723文化・教育・社会施設
1724スポーツ施設
1725観光・産業施設
1726市営住宅
1727AED 設置施設
1728Wi-Fi 設置施設
1729オストメイト対応トイレ設置施設

JSON レスポンス形式

返される JSON は以下のフォーマットに基づいています。

{
  "last_updated": "{time}",
  "name": "{name}",
  "id": "{id}",
  "original_url": "{url}",
  "data": []
}
  • last_updated: 内容の最終更新日時
  • name: オープンデータ上の分類名
  • id: 公開されている CSV のファイル名
  • original_url: 元データの取得元 URL
  • data: CSV から生成された配列(元データが整形されている場合は返されません)