災害アーカイブデータベースシステム

API 仕様書

Ver.1.5.0
2016/03/25

国立研究開発法人 防災科学技術研究所

改訂履歴訂番

日付頁

1.0.0

2014/02/28

-

1.1.0

2014/11/07

変更内容
新規作成

表紙 タイトルを修正
修正前：東日本大震災アーカイブデータベースシステム
修正後：災害アーカイブデータベースシステム

作成

承認--

武藤佐藤（辰）武藤佐藤（辰）改訂履 改訂履歴を追加
歴1

概要
・API によって取得できるコンテンツの範囲に、限定公開を追加。
・限定公開コンテンツでは値出力を行わない対象を明記。

4791214

限定公開コンテンツ追加対応
・識別用として「公開レベル」を、コンテンツ検索を行うAPI（検索 API、詳細 API、シリーズ API、ハーベストAPI）に追加。
・限定公開コンテンツでは値出力を行わない項目については【限定×】と明記。

7-10 詳細ＡＰＩの出力項目の追加対応
・出力項目とデータベースの取得カラムがわかる資料を別紙参照で追加。
・出力項目を追加

1.2.0

2015/05/22

3481214３１１震災特有項目の削除・検索 API
入力：quakeFlag 地震の後(true/false)
出力：QuakeFlag 震災前後(true:前/false:後)・詳細 API、シリーズ API、ハーベスト API
出力：QuakeFlag 震災前後

3

動作していない入力値（フリーキーワード辞書）を削除

481214

動作していない出力値（youtube 連携）について、【未実装のため値出力されません】と明記

481214

文言誤り訂正・コンテンツ事態⇒コンテンツ自体
・Adress⇒Address

3
4
71214

災害情報の追加
・検索 API の入力パラメータに以下を追加
disasterFlag 災害前後
・検索 API、詳細情報 API、シリーズ API、ハーベスト
API、地図情報 API の出力に以下を追加

16

disaster

災害名称

1.4.0

2015/07/15-

パッケージングに伴い版数を更新

武藤佐藤（辰）1.5.0

2016/03/25-

パッケージングに伴い版数を更新

武藤佐藤（辰）内容概要 .................................................................................................................... 1
1.検索 API .......................................................................................................... 2概要................................................................................................................. 2URL .................................................................................................................. 2入力................................................................................................................. 2出力................................................................................................................. 42.タグ API .......................................................................................................... 5
概要................................................................................................................. 5URL .................................................................................................................. 5出力................................................................................................................. 53.コンテンツホルダーAPI .................................................................................. 6
概要................................................................................................................. 6URL .................................................................................................................. 6出力................................................................................................................. 64. 詳細情報 API ................................................................................................. 7
概要................................................................................................................. 7URL .................................................................................................................. 7出力................................................................................................................. 7
5. シリーズ API ............................................................................................... 11
概要............................................................................................................... 11URL ................................................................................................................ 11出力............................................................................................................... 11
6. ハーベスト API ............................................................................................ 13
概要............................................................................................................... 13URL ................................................................................................................ 13入力............................................................................................................... 13出力............................................................................................................... 14
7. 地図情報 API (準備中) ............................................................................... 15
概要............................................................................................................... 15
URL ................................................................................................................ 15
入力............................................................................................................... 15

概要
災害アーカイブデータベースシステムに登録されたコンテンツを検索し、検索結果のコンテンツの詳細情報を取得する API を定義する。
以下のような API を備える。
 検索 API タグ API コンテンツホルダーAPI

詳細情報 APIシリーズ API
ハーベスト API
地図情報 API(WMS,WFS)

全ての API の入力・出力は UTF-8 である。また入力は URL エンコードされなければならない。出力は<>&’”を HTML エンコードする。
API によって取得できるコンテンツは、コンテンツホルダーの状態が一般公開であり、コンテンツが一般公開および限定公開、作業完了、承認済みのものに限る。
ただし以下の情報については、限定公開コンテンツでは、値出力を行わない（json 形式では null、xml 形式では空要素）。対象項目は、出力項目表中に【限定×】と記す。
・視聴に運営主体管理者の許可が必要となる（画面で非表示にしている）コ
ンテンツ自体への参照情報
・証言者情報（証言者の生年月日、住所、職業等が含まれるため）

11.検索 API
概要
コンテンツの時期や場所、タグなどを指定して検索を行い、該当するコンテンツ一覧を取得する。

URL
災害アーカイブデータベースシステムの URL がhttp://marugoto.domain/marugoto/ であるとき、API は、以下の URL に POST
又は GET メソッドによりアクセスする。
a. 結果を JSON/JSONP により取得する場合
http://marugoto.domain/marugoto/API/search/json
ただし、JSONP による場合は、入力にパラメータ名”callback”としてコールバック関数名を指定する
b. 結果を XML により取得する場合
http://marugoto.domain/marugoto/API/search/xml

入力
入力はいずれも省略可能である。
省略するときは特記する場合を除き絞り込み条件に使わない。
例：addressKen の入力を省略した場合、住所の県がいかなる値のレコードもヒットする。
addressKen

住所の県

addressSikucyoson

住所の市区町村addressCyoaza

住所の字部分addressBanchi

住所の番地以降

fileType1

写真を検索対象とするか(true/false)

fileType2

動画を検索対象とするか(true/false)

fileType3

音声を検索対象とするか(true/false)2

fileType4

文書を検索対象とするか(true/false)

fileType5

地図を検索対象とするか(true/false)

fileType6

手記・証言を検索対象とするか(true/false)

freewordData

フリーワードで検索する場合の文字列

tags

タグの ID のリストを”\,”区切りでholderid

コンテンツホルダーの ID

landmark

付近の目標物

latMax緯度の最大値

latMin

緯度の最小値

lonMax経度の最大値

lonMin経度の最小値

disasterFlag

災害前後(0:災害前, 1:災害後, null:災害前後不明をカンマ区切りで指定)contentYear1

コンテンツ取得年の最小

contentYear2

コンテンツ取得年の最大

contentMonth1

コンテンツ取得月の最小(contentYear1 指定時必須)

contentMonth2

コンテンツ取得月の最大(contetnYear2 指定時必須)

contentDay1

コンテンツ取得日の最小(contentYear1 指定時必須)

contentDay2

コンテンツ取得日の最大(contetnYear2 指定時必須)

contentHour1

コンテンツ取得時の最小(contentYear1 指定時必須)

contentHour2

コンテンツ取得時の最大(contetnYear2 指定時必須)

contentMin1

コンテンツ取得分の最小(contentYear1 指定時必須)

contentMin2

コンテンツ取得分の最大(contentYear2 指定時必須)

contentSec1

コンテンツ取得秒の最小(contentYear1 指定時必須)

contentSec2

コンテンツ取得秒の最大(contentYear2 指定時必須)

sortKey

並べ替えのキーregistDate:登録日時 (省略時)
date:コンテンツの取得日時
address:住所
title:タイトル

sortOrder

0:昇順(省略時)/1:降順

start

結果取得時のオフセット(省略時 0)

limit

結果取得件数(省略時 1000、0 指定時無制限)

3

出力totalcount start および limit を除く入力にマッチするレコードの総数
contents

以下のデータの配列
Identifier

識別子

OpenLevel

公開レベル（1:限定公開、2:一般公開）

Holderid

コンテンツホルダーの ID

Holdername

コンテンツホルダーの名称

Disaster

災害名称

ContentType

コンテンツの種類 1:写真 2:動画 3:
音声 4:文書 5:地図 6:手記・証言

Title

タイトル

Description

概要

Date

コンテンツの取得日時 YYYYMMDD
HH:MM:SS 不明の箇所は-1

Address

住所

Copyrighter

著作者

MapThumbnailUrl

地図の場合、サムネイル URL

YtThumbnailurl【未実装のため値出力されません】

動画の場合、YouTube のサムネイル
URL

ThumbnailFilename

サムネイルのファイル名

ThumbnailWidth

サムネイルの幅

ThumbnailHeight

サムネイルの高さ

RegistDate

登録日時 YYYYMMDD HH:MM:SS

Latitude

緯度Longitude

経度

UpdateDate

最終変更日時 YYYYMMDD HH:MM:SS4

2.タグ API
概要
システム全体及び特定のコンテンツホルダーで定義されたタグの一覧を取得する。タグには 2 階層あり、検索に使用できるのは Level2 のタグのみである。

URL
災害アーカイブデータベースシステムの URL が
http://marugoto.domain/marugoto/ であるとき、API は、以下の URL に GET メ
ソッドによりアクセスする。ただし、{holderid}はコンテンツホルダーID であり、省略した場合はシステム共通タグのみを取得する。
a. 結果を JSON/JSONP により取得する場合
http://marugoto.domain/marugoto/API/tag/json/{holderid}
ただし、JSONP による場合は、入力にパラメータ名”callback”としてコールバック関数名を指定する
b. 結果を XML により取得する場合
http://marugoto.domain/marugoto/API/tag/xml/{holderid}

出力GlobalTags

以下のデータの配列
ID

タグの ID

LEVEL

タグの階層 1 または 2

PARENT

レベル 2 のタグについて、親タグの ID

TEXT
LocalTags

タグの文字列以下のデータの配列
ID

タグの ID

LEVEL

タグの階層 1 または 2

PARENT

レベル 2 のタグについて、親タグの ID

TEXT

タグの文字列5ただし、holderid を省略した場合は、LocalTags は長さ 0 の配列となる。

3.コンテンツホルダーAPI
概要
コンテンツホルダーの一覧を取得する。

URL
災害アーカイブデータベースシステムの URL がhttp://marugoto.domain/marugoto/ であるとき、API は、以下の URL に GET メ
ソッドによりアクセスする。
c. 結果を JSON/JSONP により取得する場合
http://marugoto.domain/marugoto/API/holder /json
ただし、JSONP による場合は、入力にパラメータ名”callback”としてコールバック関数名を指定する
d. 結果を XML により取得する場合
http://marugoto.domain/marugoto/API/holder /xml

出力Holders

以下のデータの配列
ID

コンテンツホルダーの ID

Name

コンテンツホルダーの名称

Address

代表的な活動地域

64. 詳細情報 API
概要
コンテンツの識別子を指定してそのコンテンツの詳細情報を取得する。
出力項目とデータベースの取得カラムの関連については、別紙「詳細情報ＡＰＩ データベースと項目の関連表」を参照のこと。

URL
災害アーカイブデータベースシステムの URL がhttp://marugoto.domain/marugoto/ であり、識別子が{identifier}であると
き、API は、以下の URL に GET メソッドによりアクセスする。
a. 結果を JSON/JSONP により取得する場合
http://marugoto.domain/marugoto/API/detail/json/{identifier}
ただし、JSONP による場合は、入力にパラメータ名”callback”としてコー
ルバック関数名を指定する
b. 結果を XML により取得する場合
http://marugoto.domain/marugoto/API/detail/xml/{identifier}

出力Id

コンテンツ ID

Identifier

識別子

OpenLevel

公開レベル（1:限定公開、2:一般公開）

OpenLevelNotice

OpenLevel が 1 の場合の非公開理由

Holderid

運営主体の識別子

Holdername

運営主体の名称

Disaster

災害名称

EditFlag

編集フラグ

AcknowledgeFlag

承認フラグ

ContentType

コンテンツの種類（1:写真 2:動画 3:音声 4:文書 5:地図 6:手記・証言）
7

Title

タイトル

Description

概要

Title2

著作者・提供者によるタイトル

Title2Flag

著作者・提供者によるタイトルの検索・表示フラグ

Description2

著作者・提供者による説明

Register2

Title2, Description2 の記入者

Date

コンテンツの取得日時

Addresses

住所以下のデータの配列

Id

アドレスの IdAddress

コンテンツの取得場所

Latitude緯度Longitude

経度

Landmark

ランドマークCameraAddress

コンテンツの撮影場所

CameraLatitude

撮影場所の緯度

CameraLongitude

撮影場所の経度

CameraLandmark

撮影場所のランドマーク

ExifDateFlag

EXIF 日時フラグ

ExifXyFlag

EXIF 座標フラグ

Copyrighter

著作者

CopyrighterOpenFlag

著作者公開フラグ

Copyright

著作権の処理状況

CopyrightRemarks

著作権処理状況が「処理不要」の場合の理由

Imageright

肖像権の処理状況

ImagerightRemarks

肖像権処理状況が「処理不要」の場合の理由

Publisher

提供者

PublisherOpenFlag

提供者公開フラグ

PublisherRemarks

提供者備考

Authority

出典TermsOfUse

利用制限

IsbnISBN

MapUrl

地図の場合、URL

MapThumbnailUrl

地図の場合、サムネイル URL8YtThumbnailurl【未実装 動画の場合、YouTube のサムネイル URLのため値出力されません】
YtEmbeddedurl【未実装のため値出力されませ動画の場合、YouTube の埋め込み URLん】
NewFilename

コンテンツファイルの URL

OldlFilename

アップロード時のファイル名

ThumbnailFilename

サムネイルファイルの URL

ThumbnailWidth

サムネイルの幅

ThumbnailHeight

サムネイルの高さ

RegistDate

登録日時

RegistUser

登録者

UpdateDate

最終変更日時 YYYYMMDD HH:MM:SS

UpdateUser

最終更新者

Tags

タグ 以下のデータの配列

Speakers【限定×】SeriesId

タグの ID

Text

タグの文字列Type

タグ種別

HolderId

運営主体 ID

Level

タグの階層レベル

Parent親タグの ID

TagNo

タグ No

手記・証言の場合、証言者

以下のデータの配列

Name

氏名

Age年代

Sex

性別Role

被災時の役割

RoleNow

現在の役割

Job

被災時の職業

JobNow

現在の職業

Address

被災時の住所

AddressNow

現在の住所

SpeakerOpenFlag

証言者公開フラグシリーズ

以下のデータの配列
9

ID

シリーズの ID

コンテンツ自体の取得は、以下の URL により行う。
http://marugoto.domain /marugoto/contents/data/{識別子}105. シリーズ API
概要
コンテンツホルダーを指定して、そのシリーズ一覧を取得する。また、シリーズを指定してそこに属するコンテンツ一覧を取得する。

URL
災害アーカイブデータベースシステムの URL がhttp://marugoto.domain/marugoto/ であるとき、API は、以下の URL に GET メ
ソッドによりアクセスする。ただし、{holderid}はコンテンツホルダーID であり、{seriesid}はシリーズの ID である。
a. シリーズ一覧を JSON/JSONP により取得する場合
http://marugoto.domain/marugoto/API/series/list/json/{holderid}
ただし、JSONP による場合は、入力にパラメータ名”callback”としてコールバック関数名を指定する
b. シリーズ一覧を XML により取得する場合
http://marugoto.domain/marugoto/API/series/list/xml/{holderid}c. コンテンツ一覧を JSON/JSONP により取得する場合
http://marugoto.domain/marugoto/API/series/contents/json/{seriesid}
ただし、JSONP による場合は、入力にパラメータ名”callback”としてコールバック関数名を指定する
d. コンテンツ一覧を XML により取得する場合
http://marugoto.domain/marugoto//API/series/contents/xml/{seriesid}

出力1.シリーズ一覧の出力
Series以下のデータの配列
ID

シリーズ ID

Type

種別（時系列/マルチアングル/イベント/その他）
11

TypeOther

種別その他内容

SeriesNameText

シリーズ名SeriesDescription

シリーズ説明2.コンテンツ一覧の出力
Contents

以下のデータの配列
Identifier

識別子

OpenLevel

公開レベル（1:限定公開、2:一般公開）

Holderid

コンテンツホルダーの ID

Holdername

コンテンツホルダーの名称

Disaster

災害名称

ContentType

コンテンツの種類（1:写真 2:動画 3:音声 4:文書 5:地
図 6:手記・証言）

Title

タイトル

Description

概要

Date

コンテンツの取得日時

Address

住所

Copyrighter

著作者

MapThumbnailUrl

地図の場合、サムネイル URL

YtThumbnailurl【未実装のため値出力されません】

動画の場合、YouTube のサムネイル URL

ThumbnailFilename

サムネイルのファイル名

ThumbnailWidth

サムネイルの幅

ThumbnailHeight

サムネイルの高さ

RgistDate

登録日時

UpdateDate

最終変更日時 YYYYMMDD HH:MM:SS

Latitude

緯度Longitude

経度126. ハーベスト API
概要
コンテンツを一括して取得し、利用側システムに蓄積して使用するための APIである。現在登録されているコンテンツの一覧と過去登録されていたが削除されたコンテンツの一覧を取得することができる。また、日時を指定してそれ以降に登録・編集・削除されたコンテンツの一覧を取得することができる。

URL
災害アーカイブデータベースシステムの URL がhttp://marugoto.domain/marugoto/ であるとき、API は、以下の URL に POST又は GET メソッドによりアクセスする。
a. コンテンツ一覧を JSON/JSONP により取得する場合
http://marugoto.domain/marugoto/API/harvest/list/json
ただし、JSONP による場合は、入力にパラメータ名”callback”としてコールバック関数名を指定する
b. コンテンツ一覧を XML により取得する場合
http://marugoto.domain/marugoto/API/harvest/list/xml
c. 削除されたコンテンツ一覧を JSON/JSONP により取得する場合
http://marugoto.domain/marugoto/API/harvest/deleted/json
ただし、JSONP による場合は、入力にパラメータ名”callback”としてコー
ルバック関数名を指定する
d. 削除されたコンテンツ一覧を XML により取得する場合
http://marugoto.domain/marugoto/API/harvest/deleted/xml

入力
holderid

対象とするコンテンツホルダの ID(省略時 指定なし)

date

更新日時が指定された日時以降のものを対象とする(省略時 指定なし)

start

結果取得時のオフセット(省略時 0)

limit

結果取得件数(省略時 1000)
13出力1.現在登録されているコンテンツ一覧の出力
totalcount 指定された holderid および date にマッチするレコードの総数
contents

以下のデータの配列
Identifier

識別子

OpenLevel

公開レベル（1:限定公開、2:一般公開）

Holderid

コンテンツホルダーの ID

Holdername

コンテンツホルダーの名称

Disaster

災害名称

ContentType

コンテンツの種類 1:写真 2:動画 3:
音声 4:文書 5:地図 6:手記・証言

Title

タイトル

Description

概要

Date

コンテンツの取得日時 YYYYMMDD
HH:MM:SS 不明の箇所は-1

Address

住所

Copyrighter

著作者

MapThumbnailUrl【限定×】

地図の場合、サムネイル URL

YtThumbnailurl【未実装のため値出力されま動画の場合、YouTube のサムネイル
URLせん】
ThumbnailFilename

サムネイルのファイル名

ThumbnailWidth

サムネイルの幅

ThumbnailHeight

サムネイルの高さ

RgistDate

登録日時 YYYYMMDD HH:MM:SS

Latitude【限定×】

緯度Longitude【限定×】経度

UpdateDate【限定×】

最終変更日時 YYYYMMDD HH:MM:SS

2.削除されたコンテンツ一覧の出力
totalcount 指定された holderid および date にマッチするレコードの総数
deleted

以下のデータの配列
14

Identifier

削除されたコンテンツの識別子

7. 地図情報 API
概要
コンテンツの時期や場所、タグなどを指定して検索を行い、該当するコンテンツを地理データとして取得する。結果の取得は WMS および WFS による。
検索条件を一切指定せず、登録されているコンテンツ全てを表示することも可能である。
WMS 1.1.1、1.3.0 および WFS1.0.0、1.1.0、2.0.0.に準拠し、WMS のGetCapabilities、GetMap、GetFeatureInfo および WFS の GetCapabilities、GetFeature に対応する。WMS の GetMap リクエストおよび WFS の GetFeature リ
クエストにおいては、表示するコンテンツの絞り込みを行うために拡張されたパラメーターを使用することができる。詳細は「⑥地図 API 配信のためのGeoServer セットアップマニュアル」を参照のこと。

URL
http://marugoto.domain/marugoto/ であるとき、API は、以下の URL に GET メ
ソッドによりアクセスする。
a. WMS
http://marugoto.domain/marugoto_geo/wms
ただし、JSONP による場合は、入力にパラメータ名”callback”としてコールバック関数名を指定する
b. WFS
http://marugoto.domain/marugoto_geo/wfs

入力
WMS の GetMap リクエストおよび WFS の GetFeature リクエストの標準のパラメータに追加して、”viewparams”に検索条件を指定する。viewparams には、コ
ロンで”検索パラメータ名:値”のように区切ったパラメータ名と値の組をセミコロンで区切って複数指定する。すなわち、以下のようなパラメータが WMSおよび WFS の標準パラメータに追加されることになる。
15

&viewparams=p1:v1;p2:v2,p3:v3;p4:v4,….
ただし、p1,p2,p3,p4…は検索パラメータ名であり、v1,v2,v3,v4…は値である。
検索パラメータにセミコロンおよびコロンが含まれる場合は、バックスラッシ
ュによりエスケープする（例：”\;”,”\:”）。
検索パラメータは、以下のとおりである。省略するときは特記する場合を除き絞り込み条件に使わない。
例：addressKen の入力を省略した場合、住所の県がいかなる値のレコードもヒットする。
addressKen

住所の県

addressSikucyoson

住所の市区町村addressCyoaza

住所の字部分addressBanchi

住所の番地以降

fileType1

写真を検索対象とするか(true/false)

fileType2

動画を検索対象とするか(true/false)

fileType3

音声を検索対象とするか(true/false)

fileType4

文書を検索対象とするか(true/false)

fileType5

地図を検索対象とするか(true/false)

fileType6

手記・証言を検索対象とするか(true/false)

freewordData1

フリーワードで検索する場合の文字列

freewordData2

フリーワードで検索する場合の文字列

freewordData3

フリーワードで検索する場合の文字列

tags

タグの ID をカンマ区切りでholderid

コンテンツホルダーの ID

disasterFlag

災害前後（0:災害前、1:災害後、null:災害前後不明
をカンマ(\,)区切りで指定）

landmark

付近の目標物

latMax緯度の最大値

latMin

緯度の最小値

lonMax経度の最大値

lonMin経度の最小値

contentYear1

コンテンツ取得年の最小

contentYear2

コンテンツ取得年の最大

contentMonth1

コンテンツ取得月の最小
16

contentMonth2

コンテンツ取得月の最大

contentDay1

コンテンツ取得日の最小

contentDay2

コンテンツ取得日の最大

contentHour1

コンテンツ取得時の最小

contentHour2

コンテンツ取得時の最大

contentMin1

コンテンツ取得分の最小

contentMin2

コンテンツ取得分の最大

contentSec1

コンテンツ取得秒の最小

contentSec2

コンテンツ取得秒の最大

sortKey

並べ替えのキーregistDate:登録日時 (省略時)
date:コンテンツの取得日時
address:住所
title:タイトル

sortOrder

ASC:昇順(省略時)/DESC:降順

start

結果取得時のオフセット(省略時 0)

limit

結果取得件数(省略時 1000)17