八幡小学校区情報APIです。

リクエスト

リクエストURL

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

送信電文例

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

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

リクエストパラメータ

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

• 八幡小学校区エンティティパラメータ
          エンティティタイプ    "SchoolMap"
          エンティティ ID            [URI].[エンティティタイプ].[識別子].[連番]
                                                          URI        "jp.opendata-api-kakogawa"
                                                          識別子    "Yahata" （八幡小学校）
   

レスポンス

{
    "contextResponses": [
        {
            "contextElement": {
                "attributes": [
                    {
                        "name": "名称",
                        "type": "xsd:string",
                        "value": "八幡小学校"
                        "metadatas": [
                             {
                                "name": "dbf",
                                "type": "xsd:anyURI",
                                "value": "https://shape.str.cloudn-service.com/SchoolMap%2FYahata%2FYahata.dbf"
                            },
                            {
                                "name": "shp",
                                "type": "xsd:anyURI",
                                "value": "https://shape.str.cloudn-service.com/SchoolMap%2FYahata%2FYahata.shp"
                            },
                            {
                                 "name": "shx",
                                "type": "xsd:anyURI",
                                "value": "https://shape.str.cloudn-service.com/SchoolMap%2FYahata%2FYahata.shx"
                            }
                                             },

                    （省略）

                ],
                "id": "jp.opendata-api-kakogawa.SchoolMap.Yahata.1",
                "isPattern": "false",
                "type": "SchoolMap"
            },
                "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                          小学校区の名称
          更新日時                             xsd:dateTime                    データ更新日時（形式：iso8601 日本時間）
   

• "名称"メタデータパラメータ
          name                type                説明
          dbf                     xsd:anyURI     八幡小学校区に関するdbfファイルのURI
          shp                    xsd:anyURI     八幡小学校区に関するshpファイルのURI
          shx                     xsd:anyURI     八幡小学校区に関するshxファイルのURI