河川情報

河川情報情報APIです。

リクエスト

リクエストURL

https://api.opendata-api-kakogawa/orion/v1.0/queryContext

送信電文例

HTTPメソッド： POST
HTTPヘッダ：    Content-Type: application/json
                           Accept: application/json
                           Authorization: Bearer ＜トークン＞
HTTPボディ：

{

    "entities": [
        {
            "type": "RiverInfo"
            "isPattern": "true",
            "id": "jp[.]opendata-api-kakogawa[.]RiverInfo[.]"
        }
    ],
    "attributes": [
    ]
}

リクエストパラメータ

    entities           取得対象エンティティリスト
        type            エンティティタイプ
        isPattern    idに正規表現を使用するか否かを”true”か”false”で指定
        id                エンティティID。正規表現も可。
    attributes       属性名称リスト。複数指定可。省略時、すべての属性が返却される。

河川情報エンティティパラメータ
        エンティティタイプ    "RiverInfo"
        エンティティID            [URI].[エンティティタイプ].[識別子].[連番]
                         URI        "jp.opendata-api-kakogawa"

レスポンス

{
    "contextResponses": [
        {
            "contextElement": {
                "attributes": [                     {
                        "name": "都道府県コード又は市区町村コード"
                        "type": "xsd:string"
                        "value": "28210"
                    },

                    （省略）

                ],
                "id": "jp.opendata-api-kakogawa.RiverInfo.1",
                "isPattern": "false",
                "type": "RiverInfo"
            },
                "statusCode": {
                "code": "200",
                "reasonPhrase": "OK"
            }
        },

        （省略）

    ]
}

レスポンスパラメータ

    contextResponses        コンテキストレスポンスリスト
        contextElement         コンテキストエレメント
        attributes                    属性リスト
            name                       属性名称
            type                         属性タイプ
            value                       属性値
            metadatas              メタデータリスト
                name                  メタデータ名称
                type                    メタデータタイプ
                value                  メタデータ値
        id                                 エンティティタイプ
        isPattern                    false
        type                            エンティティID
    statusCode                   ステータス情報
        code                           HTTPステータスコード
        details                        ステータス詳細。必要に応じて返却される
        reasonPhrase           メッセージ

属性パラメータ
        name                type                       説明
        都道府県コード又は市区町村コード    xsd:string      都道府県コード又は市区町村コード
        NO                        xsd:string              データのNOを設定し、記載
        都道府県名           xsd:string               都道府県名称
        市区町村名            xsd:string               市区町村名称 ※都道府県のみの場合は不要。
        町丁目名称（小地域名称）                       xsd:string               町丁目名称
        名称                xsd:string               河川情報の名称
        郵便番号                       xsd:string               河川情報の郵便番号
        住所               xsd:string        河川情報の住所
        方書                xsd:string        河川情報の住所の方書
        地理座標                geo:point        河川情報の位置情報形式：緯度,経度
        電話番号         xsd:string        河川情報の電話番号
        FAX番号                xsd:string        河川情報のFAX番号
        利用可能曜日                xsd:string        河川情報の利用可能な曜日
        開始時間    xsd:string   河川情報の開始時間
        終了時間                       xsd:string        河川情報の終了時間
        利用可能日時特記事項                       xsd:string        利用可能曜日、開始・終了時間についての特記事項や例外（祝日、年末年始の変更点）
        種別                       xsd:string        河川情報の種類
        説明               xsd:string        河川情報の説明
        画像                      xsd:string        河川情報の画像格納先URL
        設置位置                  xsd:string        河川情報の詳細位置
        定員                      xsd:string        河川情報の定員数
        管理者       xsd:string        河川情報を管理している組織や人の名称
        小学校区名称                      xsd:string        設置箇所の小学校区名称
        小学校区コード                xsd:string        設置箇所の小学校区コード
        料金                  xsd:string        河川情報の利用料金
        所轄部署                      xsd:string        データの所轄部署
        更新日時    ;        xsd:dateTime        プラットフォームへのデータの更新日時を記載。形式：iso8601 日本時間
"名称"メタデータパラメータ
name type 説明
町丁目コード（小地域コード） xsd:string 市区町村コード（都道府県コード+市区群町村コード+大字・通称コード+字・丁目コード）
"小学校区名称"メタデータパラメータ
name type 説明
設備 xsd:string 備わっている設備名称

フィールド	値
最終更新日	2018年3月5日
メタデータ最終更新日時	2023年8月31日
作成日	2018年3月5日
データ形式	ngsi10
ライセンス	Creative Commons Attribution
Datastore active	False
Has views	False
Id	8a6e204e-9011-4c75-84a9-68f8ae529495
Oauth req	true
Package id	8f7a3355-5f33-49b4-8071-3560d153e653
Payload	{ "entities": [ { "type": "RiverInfo", "isPattern": "true", "id": "jp[.]opendata-api-kakogawa[.]RiverInfo[.]" } ] }
Position	0
State	active