Documentation Powered by ReDoc

Web API (0.0.3)

Download OpenAPI specification:Download

総務省データ連携基盤構築プロジェクト 都市OSインターフェース

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Facility

村民が利用できる施設関連の操作

村民が利用できる施設一覧取得

村民が利用できる施設の一覧を取得します。

query Parameters
offset
integer <int64> >= 0

開始番号(0～)

limit
integer [ 1 .. 1000 ]

最大取得数(1～)

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "results": [
    ]
}

村民が利用できる施設情報の単体登録

村民が利用できる施設情報を単体登録します。

Request Body schema: application/json

Request Body

id
string

ID

name
string

施設の名前

longitude
number

経度

latitude
number

緯度

object

郵便番号及び住所

contents
Array of any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "postalAddress": {
    },
  • "contents": [
    ]
}

指定された村民が利用できる施設情報の取得

指定された村民が利用できる施設情報を取得します。

path Parameters
facilityID
required
string

FacilityエンティティID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "postalAddress": {
    },
  • "contents": [
    ]
}

指定された村民が利用できる施設情報の更新

指定された村民が利用できる施設情報を更新します。

path Parameters
facilityID
required
string

FacilityエンティティID

Request Body schema: application/json

Request Body

id
string

ID

name
string

施設の名前

longitude
number

経度

latitude
number

緯度

object

郵便番号及び住所

contents
Array of any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "postalAddress": {
    },
  • "contents": [
    ]
}

指定された村民が利用できる施設情報の削除

指定された村民が利用できる施設の情報を削除します。

path Parameters
facilityID
required
string

FacilityエンティティID

Responses

Response samples

Content type
application/json
{
  • "description": "NotFound",
  • "message": "NotFound"
}

村民が利用できる施設情報の一括登録

村民が利用できる施設情報を一括登録します。

Request Body schema: multipart/form-data
file
string <binary>

アップロードするファイル

Responses