資料検索APIについて


検索条件に合致する資料データを取得するAPIです。


リクエスト


query のフィールドに指定可能なパラメータ

パラメータ名 説明
author 文字列 作者
category 文字列 分類名称
created_at 日時 登録日時
created_begin_on 日付 年代(始期)
created_end_on 日付 年代(終期)
description 文字列 説明
location 文字列 場所
note 文字列 備考
name 文字列 名称
owner 文字列 所有者
tag 文字列 タグ名
updated_at 日時 更新日時

sort に指定可能なパラメータ

パラメータ名 説明
author 文字列 作者
created_at 日時 登録日時
created_begin_on 日付 年代(始期)
created_end_on 日付 年代(終期)
description 文字列 説明
location 文字列 場所
note 文字列 備考
name 文字列 名称
owner 文字列 所有者
updated_at 日時 更新日時

↑ページトップに戻る

レスポンス


資料検索APIは、以下のレスポンスを返します。

{
  # 資料一覧
  data:[
    {
        # 資料のID
        id: {type: "ic:識別値",label: "ID",value: "..."},

        # 資料の分類
        category: {
            type: "ic:コード",
            label: "分類コード",
            properties: :[
                {type: "ic:識別子",label: "分類コード",value: 1},
                {type: "ic:表記",label: "分類名",value: "文献"}
            ]
        },

        # 資料の名称
        name :{
            type: "ic:名称",
            label: "名称",
            properties: :[
                {type: "ic:表記",label: "名称(日本語)",value: "..."}
            ]
        },

        # 資料の説明
        description: {
            type: "ic:説明",
            label: "説明",
            value: "..."
        },

        # 資料の位置情報
        coordinate:{
            type: "ic:座標",
            label: "位置情報",
            properties: :[
                {
                    type: "ic:座標参照系",
                    label: "座標参照系",
                    properties: :[
                        {type: "ic:識別子",label: "コード",value: "4326"}
                    ]
                },
                {type: "ic:緯度",label: "緯度",value: 35.465555556},
                {type: "ic:経度",label: "経度",value: 133.0533333}
            ]
        },

        # 年代(始期)
        created_begin_on:{
            type: "mr:年代始期",
            label: "年代(始期)",
            properties: :[
                {type: "ic:年",label: "年",value: 1907},
                {type: "ic:月",label: "月",value: 0},
                {type: "ic:日",label: "日",value: 0}
            ]
        },

        # サムネイル画像
        represent_image:{
            type: "ic:サムネイル画像",
            label: "サムネイル画像",
            value: "画像URL"
        },

        # 画像
        images:[
            {type: "ic:画像",label: "画像",value: "画像URL"}
        ],

        # 資料の作者
        author:{
            type: "mr:作者",
            label: "作者",
            properties: :[
                {type: "ic:表記",label: "作者(日本語)",value: "..."}
            ]
        },

        # 資料の所有者
        owner:{
            type: "mr:所有者",
            label: "名称",
            properties: :[
                {type: "ic:表記",label: "所有者(日本語)",value: "..."}
            ]
        },

        # 資料の備考
        note: {type: "ic:備考",label: "備考",value: ""},

        # 資料のライセンス
        license:{type: "mr:ライセンス",label: "ライセンス",value: "ライセンス表記URL"},

        # 登録日時
        created_at:{
            type: "ic:登録日時",
            label: "登録日時","
            properties:[{
                type: "ic:標準型日時",
                label: "標準型日時",
                value: "2017-04-21T17:26:01"
            }]
        },

        # 更新日時
        updated_at:{
            type: "ic:更新日時",
            label: "更新日時",
            properties: :[{
                type: "ic:標準型日時",
                label: "標準型日時",
                value: "2017-04-21T17:45:12"
            }]
         }
      }
      ,
      ...
  ],

  # IMI 共通語彙の仕様を記載したページのURLです。
  namespace:{
    ic: http://imi.go.jp/ns/core/2,
    mr: http://g-museum.matsu-reki.jp/docs/imi/
  },

  # データのページネーション情報(資料検索、タグ検索APIのみ)
  pagination:{
    count       : 20,  # データ数
    current_page: 1,   # ページ番号
    per_page    : 20,  # 1ページ当たりのデータ数
    total_count : 64,  # データ総数
    total_page  : 4,   # ページ総数
  }
}
                

↑ページトップに戻る