ｅコミマップ
API リファレンス

Ver. 1.0
2013/05/13

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

目次
1.

e コミマップ基本連係 API .............................................................................................. 3①

リクエストの形式 .................................................................................................... 3

既定のリクエストパラメータ ......................................................................................... 3②

レスポンスの形式 .................................................................................................... 4

レスポンスコード............................................................................................................ 4
既定のパラメータ............................................................................................................ 5
認証方式 .......................................................................................................................... 5③

登録済みの API の概要 ............................................................................................ 7

ユーザー情報登録更新 API ............................................................................................. 7
グループ情報登録更新 API ............................................................................................11
マップ情報登録更新 API .............................................................................................. 15
レイヤ情報登録更新 API .............................................................................................. 19
マップレイヤ情報登録更新 API ................................................................................... 26
登録情報登録更新 API .................................................................................................. 29
コメント登録更新 API .................................................................................................. 322.

情報登録・編集ユーティリティモジュール ................................................................. 34
マップ情報登録・編集フォーム.................................................................................... 34
レイヤー情報登録・編集フォーム ................................................................................ 34
登録情報登録・編集フォーム ....................................................................................... 35
地図埋め込み API ......................................................................................................... 35

1

更新履歴
初稿

2012/03/14

OAuth 認証方式に関する記述を追加

2013/03/11

文言修正 required→「必須入力」 optional→「任意入力」
正確な仕様を反映していない部分を修正発生しうるエラーを記載
レイヤ登録 API の記述でレイヤ種別の説明を追記

2013/03/26

登録情報更新 API の記述で geometry 指定のフォーマットを例示
登録情報更新 API の記述で MULTIPOINT geometry 指定のフォー

2013/03/28

マット例を修正2013/04/19

パラメータ指定の例示
メソッド指定方法についての注記を追加
レイヤ登録 API の誤記載を修正
ドキュメントのバージョンを 1.0 に変更

2013/05/13

レイヤ種別の説明の誤植を修正
ベースレイヤ＝基本地図項目(アプリケーション内用語)を明示

2

1. e コミマップ基本連係 API① リクエストの形式
リクエストは、API リクエストパスに対してメソッドとパラメータを指定して送信する。
メソッドは HTTP メソッドとして指定(POST/PUT/DELETE/GET) する方法のほか、リク
エストのパラメータ_method に同様の文字列を指定する方法がある。HTTP メソッドによる指定はサーバー側の設定によって処理を拒否される可能性があり、また e コミマップの
デフォルトのインストール方法では PUT/DELETE メソッドを拒否する設定となっている
ため、通常は_method パラメータによる指定とするのが無難である。
パラメータを伴うリクエストの形式は、以下のようにする。
GET 送信リクエスト：GET /path/to/process?param1=value1&param2=value2

POST 送信リクエスト：POST /path/to/process

POST データ： param1=value1&param2=value2
既定のリクエストパラメータ
以下のパラメータを指定した場合、全 API へのリクエストで共通した意味を持つ。
_method

PUT, DELETE に対応しないクライアントプログラムで、リクエス
トパラメータによりメソッドを指定する。_method で指定されたメ
ソッドは HTTP ヘッダのメソッドよりも優先される。

_timestamp

PUT メソッドを送信する際に、このパラメータか_force のどちらかを必ず設定する必要がある。情報更新のもととなる情報の取得時刻を設定する。timestamp のフォーマットには Unix 時間を用いる
が、これは仕様として規定しない。GET による情報取得で必ず取得されるパラメータ timestamp を変更せずに指定するべきである。

_force

PUT メソッドを送信する際に指定することができる。_timestampを無視して情報を更新する。このパラメータを設定した状態でPUT メソッドを使用すると変更の衝突が検知できないため、ふつうは用いるべきではない。

appkey連携グループウェアから、任意のユーザーとしての API の実行を許可するための API キー

authIdAPI を実行するユーザーを特定するための ID

page

GET メソッドで複数の処理結果を返す場合に、このパラメータか3offset のどちらかの設定が必須となる。 page*pagenum 件目の結果以降を返却する。page*pagenum が全結果数よりも大きくなる場
合はエラーを返す。
pagenum

GET メソッドで複数の処理結果を返す場合に、このパラメータか
num のどちらかの設定が必須となる。この値の件数以下の結果を返却する。最大値は 60 でそれ以上の値を設定するとエラーを返す。
GET メソッドで複数の処理結果を返す場合に、このパラメータか

offsetpage のどちらかの設定が必須となる。 offset 件目の結果以降を返却する。この値が全結果数よりも大きくなる場合はエラーを返す。
pagenum とまったく同じ意味のパラメータである。

num② レスポンスの形式

出力形式は HTTP レスポンスとして取得される。まず実行結果を示すレスポンスコードを含む HTTP ヘッダが出力され、さらに API から何らかの出力結果が得られる場合、HTTP
ヘッダに続き出力が得られる。
処理が正常に成功しレスポンスコード 200 が返された場合は、出力結果はかならず JSON
形式で出力される。処理がエラーで終了しレスポンスコード 200 以外が返されている場合にも処理が失敗した理由を判断するための情報が返されるが、この出力の用途は開発者のためのものなので、出力形式は仕様として規定しない。ただし、レスポンスコード 409 が返された場合は出力として同リソースに対して GET メソッドを行った場合と同様の内容が得られることを保証する。
レスポンスコードAPI リクエスト処理の可否は HTTP レスポンスコードにより通知される。
200 OK

成功

400 Bad Request

リクエストパラメータが不正である

403 Forbidden

権限がない API を実行しようとした

404 Not Found

存在しない API を実行しようとした、または指定したリソースが発見できない409 Conflict

PUT メソッドを利用しようとした際に、前回情報を取得した時間よりも後でサーバーの情報に対して変更が加えられていた場合。出
力内容として GET メソッドの内容と同じものが得られる。

500 Internal Server

そのほかの理由で処理が失敗した

Error

4

既定のパラメータ
以下のパラメータは全 API の出力で共通した意味を持つ。
timestamp

GET メソッドによる情報取得が成功した場合、出力結果の JSONのメンバとしてかならず情報取得時刻が得られる。このとき取得した情報をもとに更新を行い、その内容を PUT メソッドで送信する
際にはリクエストパラメータ_timestamp としてこの値を設定するべきである。
複数の結果が取得される GET メソッドの結果では、この名前のパ

results

ラメータに結果の配列が格納される複数の結果が取得される GET メソッドの結果では、検索の条件にnumマッチした件数の総数がこのパラメータとして返される。実際に返される件数はリクエスト時に num または pagenum パラメータで指定した数である。
認証方式
API 処理を任意のユーザーの権限で実行するために、以下のユーザー認証方式に対応する。
(なお、下記方式による認証パラメーターを付加しない場合はゲストユーザーとしての権限で動作する)
appkey による認証
連携グループウェアから、任意のユーザーとしての API の実行を許可するための API
キーと、任意ユーザーの認証キーをリクエストに含めて送信することで、任意ユーザ
ー権限下で処理を行うことが可能である。
e コミマップサーバーに登録された baseURL からのアクセスで、かつこの API キーと
autuId をクエリ引数に加えた API リクエストは任意ユーザーの操作として実行することが出来る。
API キーは「サイト設定」画面から「API アプリケーションキーを再作成」を選択すると自動で乱数文字列が生成される。



OAuth 認証方式による認証
OAuth1.0 に準拠した認証に対応しており、一般的な OAuth 認証ライブラリを使って認証を行うことができる。
OAuth 認証に使用する URL は以下のものである。
Request token URL

oauth/request_token

Authorization URL

oauth/authenticate

Access token URL

oauth/access_token
5Consumer Key と Consumer Secret Key の取得
OAuth 認証に必要なキーは、サーバーの「サイト設定」画面の「アプリケーション
OAuth キーの設定」のセクションで生成することができる。
このキー(とくに Consumer
Secret Key)は認証連携を行うアプリケーション開発者が保管し、外部に漏れないよう配慮する必要がある。

6

③ 登録済みの API の概要
ユーザー情報登録更新 API
POST

api/user/[cid]ユーザーの新規作成を行う。
入力パラメータ
authid

必須入力

ユーザーアカウント名

name

必須入力

ユーザー表示名

level

必須入力

サイト内でのユーザー権限レベル
100：システム管理者（エラーが発生する）
80：スーパーユーザー（エラーが発生する）
60：管理者
50：グループ管理者
30：編集者
20：利用者
10：ゲスト
0：権限なし

email

任意入力

e-mail アドレス

mobile

任意入力

携帯用メールアドレス

結果
新規作成されたユーザーの ID

new_idエラー

同名のアカウント名(authid)が既に登録されていた場合



操作ユーザーよりも高いユーザーレベル(level)を設定しようとした場合



スーパーユーザーよりも高い権限のユーザーを作成しようとした場合



email, mobile のパラメータが xxx@xxx.xxx というメールアドレスの形式になっていない場合エラーが発生する、ただし任意入力のため空文字列は許可される

POST

api/user/[cid]/[userid]

既存ユーザーを指定サイトに参加させる。
入力パラメータ
level

必須入力

サイト内での権限レベル

7

結果
なし
エラー


指定したユーザーID (userid) のユーザーが存在しなかった場合エラーが発生する



操作ユーザーよりも高いユーザーレベル(level)を設定しようとした場合



スーパーユーザーよりも高い権限のユーザーを作成しようとした場合

PUT

api/user/[cid]/[userid]

ユーザー情報の更新を行う。 指定したパラメータのみ更新が行われる。
入力パラメータ
authid

任意入力

ユーザーアカウント名

name

任意入力

ユーザー表示名

level

任意入力

サイト内でのユーザー権限レベル
100：システム管理者（全体）80：スーパーユーザー（全体）60：管理者
30：編集者
20：利用者
10：ゲスト
0：権限なし

email

任意入力

e-mail アドレス

mobile

任意入力

携帯用メールアドレス

結果
なし
エラー


指定したユーザーID (userid) のユーザーが存在しなかった場合エラーが発生する



同名のアカウント名(authid)が既に登録されていた場合エラーを発生する



操作ユーザーよりも高いユーザーレベル(level)を設定しようとした場合



スーパーユーザーよりも高い権限のユーザーを作成しようとした場合



操作対象のユーザーがまだサイトに未登録の場合

8

DELETE

api/user/[cid]/[userid]

指定サイトからユーザーを脱退させる。
入力パラメータ
なし
結果
なし
エラー


指定したユーザーID (userid) のユーザーが存在しなかった場合



指定したユーザーID (userid) のユーザーがサイトに所属していなかった場合

GET

api/user/[cid]/[userid]

ユーザー情報の取得を行う。
入力パラメータなし
結果
user

ユーザー情報オブジェクト
name

ユーザー表示名level

サイト内でのユーザー権限レベル
100：システム管理者（全体）80：スーパーユーザー（全体）60：管理者
30：編集者
20：利用者
10：ゲスト
0：権限なしemail

e-mail アドレス

mobile携帯用メールアドレス

user_id

ユーザーID(数字)auth_id

ユーザーアカウント名

エラー
9



指定したユーザーID (userid) のユーザーが存在しなかった場合

GET

api/user/[cid]ユーザー情報の複数取得を行う。
入力パラメータなし
結果
results

単体情報取得時に得られるものと同様のオブジェクトの配列

num条件にマッチした件数の総数

エラー
このリクエストに特有のエラーは発生しない
GET

api/user/me

認証ユーザーの情報取得を行う。未認証の状態でリクエストすると Permission Denied エ
ラーを発生する。通常は認証済みかどうかを確認する際に使用する。OAuth 認証で認証したユーザー情報のみが取得可能。
入力パラメータ
なし
結果
ユーザーid を指定した場合に得られるものと同様のオブジェクト
エラー
このリクエストに特有のエラーは発生しない

10

グループ情報登録更新 API
POST

api/group/[cid]グループの新規作成を行う。
入力パラメータ
name

必須入力

グループ名

description

任意入力

グループの説明結果
新規作成されたグループの ID

new_idエラー

このリクエストに特有のエラーは発生しない
PUT

api/group/[cid]/[groupid]

グループ情報の更新を行う。 指定したパラメータのみ更新が行われる。
入力パラメータ
name

任意入力

グループ名

description

任意入力

グループの説明

結果
なし
エラー


指定されたグループが存在しない場合

DELETE

api/group/[cid]/[groupid]

グループ情報の削除を行う。
入力パラメータ
なし
結果
なし

11

エラー


指定されたグループが存在しない場合



地図を所有しているグループは削除できず、これを削除しようとした場合

GET

api/group/[cid]/[groupid]

グループ情報の取得を行う。
入力パラメータ
なし
結果
group

グループ情報オブジェクト
name

グループ名

description

グループの説明文

statusグループの状態
1：グループ状態 通常-10：グループ状態 停止中-100：グループ状態 削除済み
グループ ID

id
エラー

指定されたグループが存在しない場合

GET

api/group/[cid]グループ情報の複数取得を行う。
入力パラメータなし
結果
results

単体情報取得時に得られるものと同様のオブジェクトの配列

num条件にマッチした件数の総数

エラー
このリクエストに特有のエラーは発生しない

12

POST

api/group/[cid]/[groupid]/user/[userid]

グループにユーザーを参加させる。
入力パラメータ
level

必須入力

グループ内権限レベル
50：グループ管理者
30：編集者
20：利用者
10：ゲスト
0：権限なし

結果
なし
エラー


指定したグループが存在しない場合



グループ管理者以上の権限レベルを設定しようとした場合

指定したユーザーが指定したグループに既に所属していた場合

PUT

api/group/[cid]/[groupid]/user/[userid]

グループ内権限レベルの変更を行う
入力パラメータ
level

任意入力

グループ内権限レベル
50：グループ管理者
30：編集者
20：利用者
10：ゲスト
0：権限なし

結果
なし
エラー


指定したグループが存在しない場合



グループ管理者以上の権限レベルを設定しようとした場合
13

指定したユーザーが指定したグループに所属していない場合

DELETE api/group/[cid]/[groupid]/user/[userid]
グループからユーザーを脱退させる。
入力パラメータ
なし
結果
なし
エラー


指定したグループが存在しない場合



指定したユーザーが指定したグループに所属していない場合

GET

api/group/[cid]/[groupid]/user

グループに所属するユーザー情報の複数取得を行う。
入力パラメータなし
結果
results

単体ユーザー情報取得時に得られるものと同様のオブジェクトの配列

num条件にマッチした件数の総数

エラー

指定したグループが存在しない場合

14マップ情報登録更新 API
POST

api/map/[cid]マップ情報の新規作成を行う。
入力パラメータarea[]

必須入力

top, right, bottom, left 地図範囲(緯度経度)を表す数値
配列ではなく、top, right, bottom, left のパラメータ名で指定することもできる

resolution

任意入力

地図解像度

title

必須入力

地図タイトルdescription

任意入力

地図説明

submap

任意入力

初期２画面表示するかどうか

submaps[]

任意入力

２画面表示で選択可能なマップ

status

任意入力

0：地図状態 地図作成途中
1：地図状態 編集中
10：地図状態 公開中
100：地図状態 確定
110：地図状態 公開中-100：地図状態 削除済み

type

任意入力

0：地図種別 通常
10：地図種別テンプレートレイヤ格納用

結果
new_id

新規作成されたマップの ID

エラー
このリクエストに特有のエラーは発生しない

PUT

api/map/[cid]/[mapid]

マップ情報の更新を行う。 指定したパラメータのみ更新が行われる。
入力パラメータarea[]

任意入力

top, right, bottom, left 地図範囲(緯度経度)を表す数値
配列ではなく、top, right, bottom, left のパラメータ名で指定することもできる
15

resolution

任意入力

地図解像度

title

任意入力

地図タイトルdescription

任意入力

地図説明

submap

任意入力

初期２画面表示するかどうか

submaps[]

任意入力

２画面表示で選択可能なマップ

status

任意入力

0：地図状態 地図作成途中
1：地図状態 編集中
10：地図状態 公開中
100：地図状態 確定
110：地図状態 公開中-100：地図状態 削除済み

type

任意入力

0：地図種別 通常
10：地図種別テンプレートレイヤ格納用

tag

任意入力

タグ

結果
なし
エラー


指定したマップが存在しない場合

DELETE api/map/[cid]/[mapid]
マップ情報の削除を行う。
入力パラメータ
なし
結果
なし
エラー


指定したマップが存在しない場合

GET

api/map/[cid]/[mapid]

マップ情報の取得を行う。
16

入力パラメータなし
結果
map

マップ情報オブジェクト
map_id

マップ ID

community_id

コミュニティ ID

group_id

グループ ID、所属グループがない場合は 0

user_id

所有者ユーザーID

title

タイトル

description

概要説明文

type

0：地図種別 通常
10：地図種別テンプレートレイヤ格納用

status0：地図状態 地図作成途中
1：地図状態 編集中
10：地図状態 公開中
100：地図状態 確定
110：地図状態 公開中-100：地図状態 削除済み

layout

レイアウト情報オブジェクト
left

地図範囲西

bottom

地図範囲南

right

地図範囲東

top

地図範囲北

submapデ フ ォ ル ト で 2 画 面 表 示 す る マ ッ プ ID ま た は "g"(GoogleMap)

submaps

2 画面表示に選択可能なマップ ID または "g" (GoogleMap)

layouttags

タグ文字列の配列エラー

指定したマップが存在しない場合

GET

api/map/[cid]17マップ情報の複数取得を行う。
入力パラメータgroup_id

任意入力

指定したグループに所属するマップを返却する

結果
results

単体情報取得時に得られるものと同様のオブジェクトの配列

num条件にマッチした件数の総数

エラー
このリクエストに特有のエラーは発生しない

18

レイヤ情報登録更新 API
POST

api/layer/[cid]レイヤ情報の新規作成を行う。
入力パラメータ
すべてのレイヤ種別に共通
name

必須入力

レイヤ名称

description

任意入力

レイヤ説明

type

必須入力

レイヤ種別
登録情報レイヤ
1:登録情報レイヤ
オーバーレイ型レイヤ
51:外部 WMS の参照用コンテンツレイヤ
59: 外部参照地図の WMS のレイヤを子に持つレイヤ
100:WMS レイヤ
101:WMS レイヤ SingleTile でレイヤ表示
130:KML レイヤ
150: タイル化された WMS レイヤ
151:タイルキャッシュレイヤ
152:OpenStreetMap レイヤ
153:WMTS レイヤ
ベースレイヤ(基本地図項目)
1100:WMS ベースレイヤ
1150: タイル化された WMS レイヤのベースレイヤ
1151:KaMapCache ベースレイヤ
1152:タイルキャッシュベースレイヤ
1153:OpenStreetMap ベースレイヤ
1154:WMTS ベースレイヤ
1155:GOOGLE ベースレイヤ
1160:WEBTIS
グループ型レイヤ
1910: グループ化用レイヤ
55: オーバーレレイヤグループ化用レイヤ
190: オーバーレイをまとめるためのグループ
1190: ベースレイヤとオーバーレイをまとめるためのグループ
登録情報レイヤのパラメータ
geomtype

必須入力

登録情報のジオメトリ種類
POINT:単一地点
LINESTRING:単一線
POLYGON:単一平面
MULTIPOINT:複数地点
MULTILINESTRING:複数線
MULTIPOLYGON:複数平面

map_id

任意入力

レイヤが所属するマップ ID
このパラメータを指定するとレイヤ作成と同時に指定のマップに挿入される。

attribution

任意入力

クレジットとして表示する著作者情報

featuretype

任意入力

WFS,WMS 用レイヤ ID

wfs_capabilities_url

任意入力

WFS GetCapabilities 用 URL

wfs_url

任意入力

WFS 検索用 URL

wms_capabilities_url

任意入力

WMS GetCapabilities 用 URL

wms_url

任意入力

地図画像取得 URL GetFeatureInfo 用の外部 WMSの URL

wms_format

任意入力

WMS GetMap で取得する画像のフォーマット

wms_legend_url

任意入力

凡例画像取得 URL GetFeatureInfo 用の外部 WMSの URL

wms_feature_url

任意入力

地図情報取得 URL GetFeatureInfo 用の外部 WMSの URL

wcs_capabilities_url

任意入力

WCS GetCapabilities 用 URL

wcs_url

任意入力

WCS 検索用 URL

metadata_url

任意入力

MetadataURL

scale

必須入力

標準表示縮尺max_scale

必須入力

最大表示縮尺group_id

任意入力

グループ ID20

visible

任意入力

レイヤ初期表示状態

parent任意入力

親レイヤ. 親がないルート階層のレイヤなら null

オーバーレイ型レイヤのパラメータ
map_id

必須入力

レイヤが所属するマップ ID

attribution

任意入力

クレジットとして表示する著作者情報

featuretype

任意入力

WFS,WMS 用レイヤ ID

wfs_capabilities_url

任意入力

WFS GetCapabilities 用 URL

wfs_url

任意入力

WFS 検索用 URL

wms_capabilities_url

任意入力

WMS GetCapabilities 用 URL

wms_url

任意入力

地図画像取得 URL GetFeatureInfo 用の外部 WMSの URL

wms_format

任意入力

WMS GetMap で取得する画像のフォーマット

wms_legend_url

任意入力

凡例画像取得 URL GetFeatureInfo 用の外部 WMSの URL

wms_feature_url

任意入力

地図情報取得 URL GetFeatureInfo 用の外部 WMSの URL

wcs_capabilities_url

任意入力

WCS GetCapabilities 用 URL

wcs_url

任意入力

WCS 検索用 URL

metadata_url

任意入力

MetadataURL

scale

必須入力

標準表示縮尺max_scale

必須入力

最大表示縮尺group_id

任意入力

グループ ID

visible

任意入力

レイヤ初期表示状態

opacity

任意入力

レイヤ初期不透明度

parent任意入力

親レイヤ. 親がないルート階層のレイヤなら null

オーバーレイ型レイヤのパラメータ
map_id

必須入力

レイヤが所属するマップ ID

結果
new_id

新規作成されたレイヤの ID

エラー

21

このリクエストに特有のエラーは発生しない

PUT

api/layer/[cid]/[layerid]

レイヤ情報の更新を行う。
入力パラメータ
すべてのレイヤ種別に共通
name

任意入力

レイヤ名称

description

任意入力

レイヤ説明

登録情報レイヤのパラメータ
map_id

任意入力

レイヤが所属するマップ ID
このパラメータを指定するとレイヤ作成と同時に指定のマップに挿入される。

attribution

任意入力

クレジットとして表示する著作者情報

featuretype

任意入力

WFS,WMS 用レイヤ ID

wfs_capabilities_url

任意入力

WFS GetCapabilities 用 URL

wfs_url

任意入力

WFS 検索用 URL

wms_capabilities_url

任意入力

WMS GetCapabilities 用 URL

wms_url

任意入力

地図画像取得 URL GetFeatureInfo 用の外部 WMSの URL

wms_format

任意入力

WMS GetMap で取得する画像のフォーマット

wms_legend_url

任意入力

凡例画像取得 URL GetFeatureInfo 用の外部 WMSの URL

wms_feature_url

任意入力

地図情報取得 URL GetFeatureInfo 用の外部 WMSの URL

wcs_capabilities_url

任意入力

WCS GetCapabilities 用 URL

wcs_url

任意入力

WCS 検索用 URL

metadata_url

任意入力

MetadataURL

scale

任意入力

標準表示縮尺max_scale

任意入力

最大表示縮尺group_id

任意入力

グループ ID

visible

任意入力

レイヤ初期表示状態

parent任意入力

親レイヤ. 親がないルート階層のレイヤなら null

22

オーバーレイ型レイヤのパラメータ
map_id

任意入力

レイヤが所属するマップ ID

attribution

任意入力

クレジットとして表示する著作者情報

featuretype

任意入力

WFS,WMS 用レイヤ ID

wfs_capabilities_url

任意入力

WFS GetCapabilities 用 URL

wfs_url

任意入力

WFS 検索用 URL

wms_capabilities_url

任意入力

WMS GetCapabilities 用 URL

wms_url

任意入力

地図画像取得 URL GetFeatureInfo 用の外部 WMSの URL

wms_format

任意入力

WMS GetMap で取得する画像のフォーマット

wms_legend_url

任意入力

凡例画像取得 URL GetFeatureInfo 用の外部 WMSの URL

wms_feature_url

任意入力

地図情報取得 URL GetFeatureInfo 用の外部 WMSの URL

wcs_capabilities_url

任意入力

WCS GetCapabilities 用 URL

wcs_url

任意入力

WCS 検索用 URL

metadata_url

任意入力

MetadataURL

scale

任意入力

標準表示縮尺max_scale

任意入力

最大表示縮尺group_id

任意入力

グループ ID

visible

任意入力

レイヤ初期表示状態

opacity

任意入力

レイヤ初期不透明度

parent任意入力

親レイヤ. 親がないルート階層のレイヤなら null

オーバーレイ型レイヤのパラメータ
map_id

任意入力

レイヤが所属するマップ ID

結果
なし
エラー


指定したレイヤーが存在しない場合

DELETE api/layer/[cid]/[layerid]
レイヤ情報の削除を行う。
23

入力パラメータ
なし
結果
なし
エラー


指定したレイヤーが存在しない場合

GET

api/layer/[cid]/[layerid]

レイヤ情報の取得を行う。
入力パラメータなし
結果layer_id

レイヤ ID

name

レイヤ名称

description

レイヤ説明

statusレイヤ編集状態

type

レイヤ種別

owner_id

このレイヤの作成者

owner_map_id

最初に作成された地図 ID

attribution

クレジットとして表示する著作者情報

feature_type_id

WFS,WMS 用レイヤ ID

wfs_capabilities_url

WFS GetCapabilities 用 UR

wfs_url

WFS 検索用 URL

wms_capabilities_url

WMS GetCapabilities 用 URL

wms_url

地図画像取得 URL GetFeatureInfo 用の外部 WMS の URL

wms_format

WMS GetMap で取得する画像のフォーマット

wms_legend_url

凡例画像取得 URL GetFeatureInfo 用の外部 WMS の URL

wms_feature_url

地図情報取得 URL GetFeatureInfo 用の外部 WMS の URL

wcs_capabilities_url

WCS GetCapabilities 用 URL

wcs_url

WCS 検索用 URL
24

metadata_url

MetadataURL

time_from

レイヤの期間開始

time_toレイヤの期間終了

scale

標準表示縮尺max_scale

最大表示縮尺geometry_type

登録情報レイヤのみ、登録情報のジオメトリ種類

エラー

指定したレイヤが存在しない場合

GET

api/layer/[cid]レイヤ情報の一覧取得を行う。
入力パラメータなし
結果
results

単体情報取得時に得られるものと同様のオブジェクトの配列

num条件にマッチした件数の総数

エラー
このリクエストに特有のエラーは発生しない

25

マップレイヤ情報登録更新 API
POST

api/map/[cid]/[mid]/layer/[layerid]

レイヤのマップ関連情報の新規作成を行う (マップへのレイヤ挿入操作)。
入力パラメータ
name

任意入力

マップ上でのレイヤ名称文字列

visible

任意入力

レイヤの可視状態 “true”/”false”

opacity

任意入力

レイヤ表示透明度 数値文字列

parent任意入力

親レイヤの ID

scale

任意入力

デフォルトのスケール値 数値文字列

max_scale

任意入力

最大スケール値 数値文字列

結果
なし
エラー


指定したマップと指定したレイヤが存在しない場合



指定したレイヤがすでに指定したマップに所属していた場合

PUT

api/map/[cid]/[mid]/layer/[layerid]

レイヤのマップ関連情報の更新を行う。
入力パラメータ
name

任意入力

マップ上でのレイヤ名称文字列

visible

任意入力

レイヤの可視状態 “true”/”false”

opacity

任意入力

レイヤ表示透明度 数値文字列

parent任意入力

親レイヤの ID

scale

任意入力

デフォルトのスケール値 数値文字列

max_scale

任意入力

最大スケール値 数値文字列

結果
なし
エラー


指定したマップと指定したレイヤが存在しない場合
26



指定したレイヤがすでに指定したマップに所属していない場合

DELETE api/map/[cid]/[mid]/layer/[layerid]
レイヤのマップ関連情報の削除を行う (マップからのレイヤ除去操作)。
入力パラメータ
なし
結果
なし
エラー


指定したマップと指定したレイヤが存在しない場合



指定したレイヤがすでに指定したマップに所属していない場合

GET

api/map/[cid]/[mid]/layer/[layerid]

レイヤのマップ関連情報の取得を行う。
入力パラメータなし
結果maplayer

layer

name

マップ上でのレイヤ名称文字列

visibleレイヤの可視状態 “true”/”false”

opacity

レイヤ表示透明度 数値文字列

parent親レイヤの ID

scale

デフォルトのスケール値 数値文字列

max_scale

最大スケール値 数値文字列

closedレイヤ初期展開状態 “true”/”false”

attr_name_id

名前として使用する属性の ID

filterFilter タグ文字列 （未使用）

original_id

Clone のもとになったレイヤの ID

reload

リロード情報 文字列で 数値(秒)api/layer GET メソッドで得られるオブジェクトの layer メンバと同一
27

レイヤの閲覧権限がない場合はこのメンバは出力に含まれない
エラー

指定したマップと指定したレイヤが存在しない場合



指定したレイヤがすでに指定したマップに所属していない場合

GET

api/map/[cid]/[mid]/layer/

マップに関連付けられたレイヤの情報一覧を取得する。
入力パラメータなし
結果
results

単体情報取得時に得られるものと同様のオブジェクトの配列

num条件にマッチした件数の総数

エラー

指定したマップが存在しない場合

28

登録情報登録更新 API
POST

api/feature/[cid]/[layerid]

登録地点情報の新規作成を行う。
入力パラメータgeometry

必須入力

経度、緯度の値の配列 (POINT 登録)、あるいはその配列(LINE, POLYNON) の JSON 文字列
例)
POINT: [140,40]
LINESTRING: [[140,40], [135,45]]
POLYGON: [[140,40], [135,45],[135,40], [140,40]]
MULTIPOINT: [[[140,40]], [[135,45]]]
MULTILINESTRING:[[[140,40],[135,45]],[[135,40],[140,40]]]
MULTIPOLYGON:[[[140,40],[135,45],[135,40],[140,40]],[[140,40], [135,45],[135,40], [140,40]]]
attr*

任意入力

属性値、キー名は attr0, attr1…などのように指定

結果
new_id

追加した地点情報の ID

エラー
このリクエストに特有のエラーは発生しない
PUT

api/feature/[cid]/[layerid]/[featureid]

登録地点情報の更新を行う。
入力パラメータgeometry

必須入力

経度、緯度の値の配列 (POINT 登録)、あるいはその配列(LINE, POLYNON) の JSON 文字列
例)
POINT:[140,40]
LINE: [[140,40], [135,45]]
POLYGON: [[140,40], [135,45],[135,40], [140,40]]
MULTIPOINT: [[[140,40]], [[135,45]]]
MULTILINE: [[[140,40], [135,45]],[[135,40], [140,40]]]
29

MULTIPOLYGON:[[[140,40],[135,45],[135,40],[140,40]],[[140,40], [135,45],[135,40], [140,40]]]
attr*

任意入力

属性値、キー名は attr0, attr1…などのように指定

結果
なし
エラー


指定された登録情報が存在しない場合

DELETE api/feature/[cid]/[layerid]/[featureid]
登録地点情報の削除を行う。
入力パラメータ
なし
結果
なし
エラー


指定された登録情報が存在しない場合

GET

api/feature/[cid]/[layerid]/[featureid]

登録地点情報の取得を行う。
入力パラメータなし
結果feature_id

地点情報の ID

layer_id

地点が所属するレイヤの ID

distance

検索中心地店からの距離

geometry

地点座標を示す WKT 文字列

mid

未定義

status未定義

user_id

地点情報の登録者のユーザーID
30

moduserid

地点情報の最終更新者のユーザーID

created

地点情報の登録日時

modified

地点情報の更新日時

attrs

地点情報に付属する属性値

files

地点情報に付属するファイルまたは URL

エラー

指定された登録情報が存在しない場合

GET

api/feature/[cid]/[layerid]

登録地点情報の一覧更新を行う。
入力パラメータlayers

任意入力

検索するレイヤ ID のカンマ区切り文字列

keywords

任意入力

単語検索してマッチした地点情報を返す

sort

任意入力

結果のソート順 “asc”または”desc

bbox

任意入力

範囲検索してマッチした地点情報を返す

lat

任意入力

lat と lon で表される地点から近い順に地点情報を返す

lon

任意入力

lat と lon で表される地点から近い順に地点情報を返す

結果
num

条件にマッチした件数の総数

results

単体情報取得で得られるものと同じ構造体の配列

エラー

このリクエストに特有のエラーは存在しない31

コメント登録更新 API
POST api/comment/[cid]/[layerid]/[featureid]
コメント情報の新規作成を行う。
入力パラメータ
title

必須入力

コメントのタイトル

body

必須入力

コメントの本文

結果
new_id

新規作成されたコメントの ID

エラー

指定したレイヤ、登録情報、コメントが存在しない場合

PUT

api/comment/[cid]/[layerid]/[featureid]/[commentid]

コメント情報の更新を行う。 指定したパラメータのみ更新が行われる。
入力パラメータ
Title

任意入力

top, right, bottom, left 地図範囲(緯度経度)を表す数値

Body

任意入力

地図解像度

approve

任意入力

true を指定すると、コメントを承認状態にする

unapprove

任意入力

true を指定すると、コメントを未承認状態にする

結果
なし
エラー


指定したレイヤ、登録情報、コメントが存在しない場合

DELETE api/comment/[cid]/[layerid]/[featureid]/[commentid]
コメント情報の削除を行う。
入力パラメータ
なし
結果
32

なし
エラー


指定したレイヤ、登録情報、コメントが存在しない場合

GET

api/comment/[cid]/[layerid]/[featureid]

コメント情報の複数取得を行う。
入力パラメータなし
結果
resultsnum

コメント情報のオブジェクト
comment_id

コメント ID

parent_id

親のコメント ID

layered

コメントが所属する登録情報のレイヤ ID

fid

登録情報の ID

type

未定義

state

かならず 0user_id

コメント投稿者のユーザーID

user_name

コメント投稿者のユーザー名

title

コメントのタイトル

description

コメントの本文

url

未定義

条件にマッチした件数の総数

エラー

指定したレイヤ、登録情報が存在しない場合

33

2. 情報登録・編集ユーティリティモジュール
外部アプリケーションからの情報登録・編集ウィンドウの表示、情報登録処理を行うユー
ティリティを提供する。
マップ情報登録・編集フォーム
ecom/admin/map-edit.jsp?cid={cid}[&mid={mapId}] GET
mapid の指定の有無によって情報の編集 /登録フォームに切り替わる。編集フォームの場合は保存済みの情報が入力されたフォームが出力される。
Parameter
ref

任意入力

情報登録後に遷移するページ URL

結果
登録フォームを含む完全な HTML ページを出力する。
Parameter
API に与えることができるパラメータと同一である (API の共通パラメータは除く)
レイヤー情報登録・編集フォーム
ecom/admin/featuretype.jsp?cid={cid}&gid={groupId} GET
cid で指定されたサイトおよび gid で指定されたグループに所属するレイヤの一覧と、レイ
ヤ情報登録のためのフォームが出力される。
レイヤ一覧にはレイヤ情報編集のためのフォームを表示する「項目設定」リンクを表示し、リンクでの iframe 内の画面遷移によってレイヤ情報編集フォームが表示される。
レイヤ一覧にはレイヤの属性一覧を表示するための「属性設定」リンクを表示し、リンク
での iframe 内の画面遷移によって属性一覧が表示される。
属性一覧には属性情報編集のためのフォームを表示する「設定」リンクを表示し、リンク
での iframe 内の画面遷移によって属性情報編集フォームが表示される。
Parameter
ref

任意入力

「閉じる」ボタンを押したときに表示するページ URL

結果
レイヤ一覧、レイヤ情報登録フォーム、レイヤ情報編集フォーム、属性一覧、属性情報編
集フォーム、を含む完全な HTML ページを出力する。
34

登録情報登録・編集フォーム
app/feature/edit/{cid}/{layered}[/{featureid}] POST
featureid の指定の有無によって情報の編集 /登録フォームに切り替わる。編集フォームの場合は保存済みの情報が入力されたフォームが出力される。
WKT を iframe に渡す場合は POST でパラメータを送信する。
Parameter
wkt

任意入力

登録情報の形状の WKT
情報登録時は必須。情報更新時に形状を更新する場合に設定

ref

任意入力

情報登録後に遷移するページ URL

結果
登録フォームを含む完全な HTML ページを出力する。
地図埋め込み API
map/eMapEmbed.jsp?cid=[cid]&gid=[gid]&mid=[mapId]
e コミマップサーバーから取得できる地図を、iframe 内で閲覧できる形で提供する。iframe
内では拡大縮小、ポイントクリックで情報取得などの閲覧操作が可能とする。

35