共通定義
- 測地系
- パラメータ及びレスポンスについて
- 住所コード(address_code)
- 過去地図年度(pastmap_year)
- 子階層フラグ(child_level_flag)
- 建物ZID(zid)
- 属性ZID(zid_attr)
- ステータス(status)
- エラーメッセージ一覧
- WebAPIについて
- パラメータへの配列指定方法について
- ノード・リンクについて
- リクエストパラメータ「word」について
測地系
JavaScript API | 緯度経度の測地系は世界測地系(JGD2000)です。 |
Web API | datumで入出力座標の測地系を指定する際のTOKYO_NAVI 日本測地系(ゼンリン ナビ地図)とは日本測地系にゼンリンの離島補正が入ったものです。 |
座標の指定は度形式で指定してください。
パラメータ及びレスポンスについて
文字コード:unicode
レスポンス:JSON形式
※画像などのバイナリー形式のレスポンスを除く
住所コード(address_code)
"東京都千代田区"など、都道府県から始まる住所を独自の体系でコード化したものです。
地図更新等により変化することがあります。
例:「東京都千代田区丸の内3丁目4-1」の場合
分類 | 桁数 | 解説 | コード例 | 住所例 |
---|---|---|---|---|
都道府県 | 数字2桁 | 01~47:北海道から沖縄までが定義される。 JIS規格 X0401に準拠する。 |
13 | 東京都 |
市区町村 | 数字3桁 | 001~999:市区町村ごとに付与。 JIS規格 X0402に準拠する。 |
13101 | 東京都千代田区 |
大字 | 英数字3桁 | 全国町・字ファイルの字コードとゼンリン独自の住所コードが含まれる。 | 13101055 | 東京都千代田区丸の内 |
字丁目 | 英数字3桁 | 全国町・字ファイルの丁目コードとゼンリン独自の住所コードが含まれる。 | 13101055003 | 東京都千代田区丸の内3丁目 |
街区 | 数字5桁 | 昇順にコードを付与する。 | 1310105500300004 | 東京都千代田区丸の内3丁目4 |
地番 | 数字5桁 | コードを付与する。 | 131010550030000400001 | 東京都千代田区丸の内3丁目4-1 |
過去地図年度(pastmap_year)
1994年~前年度(※)までの過去の住宅地図を指定できます。
※地区によっては指定できる地図の年度にばらつきがあります。
子階層フラグ(child_level_flag)
自身の住所階層より配下の住所データの事を指します。
例)市区町村レベルのデータの場合、大字以下のデータを表示するかどうかのフラグ
建物ZID(zid)
建物等の地物毎にふられるパーマネントのIDです。
属性ZID(zid_attr)
建物や地物内のテナント施設等といった属性情報毎にふられるパーマネントのIDです。
ステータス(status)
WebAPI実行結果を判定するための値です。
HTTPステータスコード | 値 | 原因 |
---|---|---|
200 | 'OK' | 正常 |
400 | 'BAD_REQUEST' 'MissingParameterValue' |
入力パラメータが不正だった場合 |
401 | なし | ヘッダーが不正だった場合 |
403 | 'FORBIDDEN' なし |
制限されたリクエストを行った場合 |
404 | 'InvalidParameterValue' 'MissingParameterValue' |
入力パラメータが不正だった場合 |
405 | なし | 許可されていないHTTPメソッドでリクエストを行った場合 |
413 | なし | リクエストサイズが上限を超えている場合 |
414 | なし | リクエストサイズが上限を超えている場合 |
429 | なし | リクエスト回数が上限を超えている場合 |
494 | なし | リクエストサイズが上限を超えている場合 |
500 | 'INTERNAL_SERVER_ERROR' | 内部異常が発生した場合 |
エラーメッセージ一覧
400エラー
形式:application/json
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
入力パラメータ[パラメータ名]の値が不正な緯度経度指定となっています。 | 入力パラメータ[パラメータ名]の値は正常な緯度経度指定としてください。 |
|
入力パラメータに必須パラメータ[パラメータ名] および値が指定されていません。 | 必須パラメータ[パラメータ名]および値を指定してください。 |
|
入力パラメータ[パラメータ名]の値は数値ではありません。 | 入力パラメータ[パラメータ名]の値を数値で指定してください。 |
|
入力パラメータ[パラメータ名]の値が上限値よりも大きい値で指定されています。 | 入力パラメータ[パラメータ名]の値を上限値よりも小さい値で指定してください。 |
|
入力パラメータ[パラメータ名]の値が下限値よりも小さい値で指定されています。 | 入力パラメータ[パラメータ名]の値を下限値よりも大きい値で指定してください。 |
|
入力パラメータ[パラメータ名]の値が正の整数値で指定されていません。 | 入力パラメータ[パラメータ名]の値は正の整数値で指定してください。 |
|
入力パラメータ[パラメータ名]の値は整数値ではありません。 | 入力パラメータ[パラメータ名]の値を整数値で指定してください。 |
|
入力パラメータ[パラメータ名]の値のフォーマット形式が違います。 | 入力パラメータ[パラメータ名]の値のフォーマット形式を確認して、正しい形式で指定してください。 |
|
入力パラメータ[パラメータ名]の値が負の値で指定されています。 | 入力パラメータ[パラメータ名]の値は正の値で指定してください。 |
|
入力パラメータ[パラメータ名]の値の文字数が上限を超えています。 | 入力パラメータ[パラメータ名1]の値を上限よりも小さい文字数で指定してください。 |
|
入力パラメータ[パラメータ名1]の値が[パラメータ名2]の値よりも大きい値で指定されています。 | 入力パラメータ[パラメータ名1]の値を[パラメータ名2]の値よりも小さい値で指定してください。 |
|
入力パラメータ[パラメータ名]の値が[値]以上で指定されています。 | 入力パラメータ[パラメータ名]の値は[値]未満で指定してください。 |
|
入力パラメータ[パラメータ名1]の値が入力パラメータ[パラメータ名2]値よりも後の日付で指定されています。 | 入力パラメータ[パラメータ名1]の値は入力パラメータ[パラメータ名2]の値よりも前の日付で指定してください。 |
|
入力パラメータ[パラメータ名]の値が[数値]桁数字指定ではありません。 | 入力パラメータ[パラメータ名]の値は[数値]桁数字で指定してください。 |
|
入力パラメータ[パラメータ名]の値の要素数が[値]を超えて指定されています。 | 入力パラメータ[パラメータ名]の値の要素数を[値]よりも小さい数で指定してください。 |
|
入力パラメータ[パラメータ名]値が範囲[値1]から[値2]以外の値で指定されています。 | 入力パラメータ[パラメータ名]の値は範囲[値1]から[値2]内で指定してください。 |
|
入力パラメータ[パラメータ名]の値は[値1]から[値2]の範囲にありません。 | 入力パラメータ[パラメータ名]の値を[値1]から[値2]の範囲で指定してください。 |
|
入力パラメータ[パラメータ名]の値は[値1],..,[値x]のいずれかで指定されていません。 | 入力パラメータ[パラメータ名]の値は[値1],..,[値x]のいずれかで指定してください。 |
|
入力パラメータaddressの値は2桁もしくは5桁の住所コードで指定されていません。 | 入力パラメータaddressの値は2桁もしくは5桁の住所コードで指定してください。 |
|
入力パラメータaddressの値は2桁、5桁、11桁、16桁もしくは21桁の住所コードで指定されていません。 | 入力パラメータaddressの値は2桁、5桁、11桁、16桁もしくは21桁の住所コードで指定してください。 |
|
入力パラメータaddressの値の住所コードが重複しています。 | 入力パラメータaddressの値の住所コードを重複しないように指定してください。 |
|
入力パラメータam_agg_yearの値が単年指定のときに、入力パラメータam_agg_howの値は複数年集計指定はできません。 | 入力パラメータam_agg_yearの値が単年指定のときには、入力パラメータam_agg_howの値は単年集計を指定してください。 |
|
入力パラメータam_agg_howの値と入力パラメータam_agg_yearの値の組み合わせが集計できない組み合わせとなっています。 | 入力パラメータam_agg_howの値と入力パラメータam_agg_yearの値について、正しい組み合わせで指定してください。 |
|
入力パラメータam_agg_yearの値が集計対象年度となっていません。 | 入力パラメータam_agg_yearの値を集計対象年度で指定してください。 |
|
入力パラメータam_agg_yearの値がデータが存在しない年度指定となっています。 | 入力パラメータam_agg_yearの値をデータが存在する年度で指定してください。 |
|
入力パラメータam_agg_yearの値が重複した年度指定となっています。 | 入力パラメータam_agg_yearの値を重複しない年度指定としてください。 |
|
入力パラメータam_comp_valueの値が2つの値で指定されていません。 | 入力パラメータam_comp_valueの値を2つの値で指定してください。 |
|
入力パラメータdatetimeの値が73時間以上先の指定となっています。 | 入力パラメータdatetimeの値は73時間よりも前の時間で指定してください。 |
|
入力パラメータdatumの値がTOKYO,TOKYO_NAVI,JGD以外で指定されています。 | 入力パラメータdatumの値はTOKYO,TOKYO_NAVI,JGDのいずれかで指定してください。 |
|
入力パラメータgenre_patternの値が指定されていません。 | 入力パラメータgenre_patternの値を指定してください。 |
|
入力パラメータin_crsの値がEPSGコードで指定されていません。 | 入力パラメータin_crsの値をEPSGコードで指定してください。 |
|
入力パラメータin_crsの値と入力パラメータout_crsの値が同じEPSGコードとなっています。 | 入力パラメータin_crsの値と入力パラメータout_crsの値は異なるEPSGコードで指定してください。 |
|
入力パラメータlimitの取得開始位置の値が0~20000の範囲で指定されていません。 | 入力パラメータlimitの取得開始位置の値は0~20000の範囲で指定してください。 |
|
入力パラメータlimitの取得件数の値が0~1000の範囲で指定されていません。 | 入力パラメータlimitの取得件数の値は0~1000の範囲で指定されていません。 |
|
入力パラメータlimitの取得開始位置が上限を超えて指定されています。 | 入力パラメータlimitの取得開始位置は上限値以下で指定してください。 |
|
入力パラメータmaptypeの値が不正な値となっています。 | 入力パラメータmaptypeの値を指定された値としてください。 |
|
入力パラメータpositionの値が契約エリア外の緯度経度指定となっています。 | 入力パラメータpositionの値は契約エリア内の緯度経度指定としてください。 |
|
入力パラメータpositionの値の経度が範囲122.0~154.0外の指定となっています。 | 入力パラメータpositionの値の経度は範囲122.0~154.0内の指定としてください。 |
|
入力パラメータpositionの値の緯度が範囲20.0~46.0外の指定となっています。 | 入力パラメータpositionの値の緯度は範囲20.0~46.0内の指定としてください。 |
|
入力パラメータpositionsの値の経度、緯度が数値で指定されていません。 | 入力パラメータpositionsの値の経度、緯度は数値で指定してください。 |
|
入力パラメータpositionsの値のポイントが[数値]点未満で指定されています。 | 入力パラメータpositionsの値のポイントは[数値]点以上で指定してください。 |
|
入力パラメータpositionsの値の要素が偶数個で指定されていません。 | 入力パラメータpositionsの値の要素は偶数個で指定してください。 |
|
入力パラメータpositionsの値のポイントが[数値]点を超えて指定されています。 | 入力パラメータpositionsの値のポイントは[数値]点以下で指定してください。 |
|
入力パラメータsearch_levelの値が3以外のとき、入力パラメータproximityの値および入力proximity_cntの値が指定されています。 | 入力パラメータsearch_levelの値、入力パラメータproximityの値および入力proximity_cntの値の組み合わせを確認してください。 |
|
入力パラメータproximityの各値が上限を超えて指定されています。 | 入力パラメータproximityの各値は上限以下で指定してください。 |
|
入力パラメータpositionの値が指定されていないとき、入力パラメータsearch_typeの値が0もしくは1で指定されています。 | 入力パラメータpositionの値、入力パラメータsearch_typeの値の組み合わせを確認してください。 |
|
入力パラメータzoomの値が範囲3~22外で指定されています。 | 入力パラメータzoomの値は範囲3~22内で指定してください。 |
|
入力パラメータの値の組み合わせが不正となっています。 | 入力パラメータの値の組み合わせを確認してください。 |
|
入力パラメータuser_figureの値が不正となっています。 | 入力パラメータuser_figureの値を正常な値で指定してください。 |
|
入力パラメータpositionの値、zidの値およびidの値がいずれも指定されていません。 | 入力パラメータpositionの値を指定してください。 |
|
入力パラメータpositionの値、address_codeの値がいずれも指定されていません。 | 入力パラメータpositionの値、もしくはaddress_codeの値どちらかを指定してください。 |
|
入力パラメータpositionの値、address_codeの値がどちらも指定されていないか、どちらも指定されています。 | 入力パラメータpositionの値、address_codeの値をどちらかのみ指定してください。 |
|
入力パラメータpositionの値、address_codeの値、areacodeの値が1つも指定されていません。 | 入力パラメータpositionの値、address_codeの値、areacodeの値をいずれか1つ指定してください。 |
|
入力パラメータpositionの値、address_codeの値がどちらも指定されています。 | 入力パラメータpositionの値、address_codeの値はどちらか1つを指定してください。 |
|
入力パラメータboundaryの値、address_codeの値、proximityの値が同時指定されています。 | 入力パラメータboundaryの値、address_codeの値、proximityの値はいずれか1つのみ指定してください。 |
|
入力パラメータam_comp_selectの値、am_comp_valueの値、am_compの値がすべて指定されていません。 | 入力パラメータam_comp_selectの値、am_comp_valueの値、am_compの値をすべて指定してください。 |
|
入力パラメータam_comp_selectの値、am_comp_valueの値、am_compの値の整合性が取れていません。 | 入力パラメータam_comp_selectの値、am_comp_valueの値、am_compの値の組み合わせを確認してください。 |
|
リクエストヘッダのContent-Typeに「application/x-www-form-urlencoded」以外が指定されています。 | リクエストヘッダのContent-Typeには「application/x-www-form-urlencoded」を指定してください。 |
|
パラメータに最小値未満の値が指定されています。 | APIリファレンスを参照し、パラメータに最小値以上の値を指定してください。 |
|
パラメータに最大値より大きい値が指定されています。 | APIリファレンスを参照し、パラメータに最大値以下の値を指定してください。 |
|
パラメータに指定リスト外の値が指定されています。 | APIリファレンスを参照し、パラメータに指定リスト内の値を指定してください。 |
|
パラメータに指定可能な数以上の値が指定されています。 | APIリファレンスを参照し、パラメータに指定可能な数未満の値を指定してください。 |
|
必須パラメータが含まれていません。 | APIリファレンスを参照し、必須パラメータをリクエストに含めてください。 |
|
許可されていないAPIに対してリクエストが行われています。 | 管理者にリクエスト対象APIの許可を求めるか、許可されているチャネルIDを利用してください。 |
|
最小値~最大値を設定しているパラメータに対し、文字列が指定されています。 | パラメータには、最小値~最大値の範囲内の数値を指定してください。 |
|
許可されていないパラメータがリクエストに含まれています。 | リクエストに含めたパラメータが存在するパラメータであること、綴りが正しいことを確認してください。 |
|
指定文字コードと文字列パラメータの文字コードが一致していません。 | 文字列パラメータの文字コードを指定した文字コードにしてください。 |
|
パラメータに指定可能でない値が指定されています。 | APIリファレンスを参照し、指定可能な値を指定してください。 |
|
RestfulのAPIで、パスパラメータをクエリパラメータに含めてリクエストしています。 | 意図せずにリクエストにパスパラメータを設定していないかを確認してください。 |
|
必須パラメータgrant_typeがリクエストに含まれていません。 | grant_typeを指定してください。 |
|
必須パラメータclient_idがリクエストに含まれていません。 | client_idを指定してください。 |
|
必須パラメータclient_secretがリクエストに含まれていません。 | client_secretを指定してください。 |
|
誤った値がgrant_typeに指定されています。 | grant_typeに正しい値を指定してください。client_credentials固定です。 |
|
誤った値がclient_idに指定されています。 | client_idに正しい値を指定してください。 client_idについては、FO チャネル詳細ページのOAuth2.0項目を参照してください。 |
|
誤った値がclient_secretに指定されています。 | client_secretに正しい値を指定してください。 client_secretについては、FO チャネル詳細ページのOAuth2.0項目を参照してください。 |
|
指定した認証キーが存在しません。 | 正しい認証キーを指定してください。 |
|
指定されたパラメータについて、同時指定ができません。 | どちらか一方のパラメータを指定してください。 |
|
入力パラメータ [パラメータ名]の指定範囲が上限を超えています。 | 入力パラメータ [パラメータ名]の指定範囲を上限を超えない値に指定してください。 |
|
入力パラメータbboxの値、centerの値がどちらも指定されています。 | 入力パラメータbboxの値、centerの値をいずれか1つ指定してください。 |
|
入力パラメータzidの値、positionの値、ridの値が同時指定されています。 | 入力パラメータzidの値、positionの値、ridの値はいずれか1つ指定してください。 |
|
入力パラメータbboxの値、proximityの値がどちらも指定されています。 | 入力パラメータbboxの値、proximityの値はいずれか1つ指定してください。 |
|
入力パラメータ[パラメータ名]の文字数が2文字未満で指定されています。 | 入力パラメータ[パラメータ名]の文字数は2文字以上で指定してください。 |
|
入力パラメータbboxで指定した緯度経度矩形範囲が上限を超えています。 | 入力パラメータbboxで指定する緯度経度矩形範囲は上限値以下で指定してください。 |
|
入力パラメータbboxの値、proximityの値、zidの値、wordの値が1つも指定されていません。 | 入力パラメータbboxの値、proximityの値、zidの値、wordの値をいずれか1つ指定してください。 |
形式:plain/text
メッセージ例 | 原因 | 対処方法 |
---|---|---|
クエリパラメータ [パラメータ名] が指定されていません | 入力パラメータ[パラメータ名]の値が指定されていません。 | 入力パラメータ[パラメータ名]の値を指定してください。 |
クエリパラメータ [パラメータ名] の文字列が範囲外です | 入力パラメータ[パラメータ名]の値が不正な値となっています。 | 入力パラメータ[パラメータ名]の値を正常な値で指定してください。 |
クエリパラメータ [パラメータ名] の指定が不正な値です | 入力パラメータ[パラメータ名]の値が不正な値となっています。 | 入力パラメータ[パラメータ名]の値を正常な値で指定してください。 |
APIパスパラメータが指定されていません | 入力APIパス名が不正な値となっています。 | 入力APIパス名を確認してください。 |
パスパラメータで指定されたAPIは無効です | 入力APIパス名が不正な値となっています。 | 入力APIパス名を確認してください。 |
AID認証に失敗しました: [ステータスコード] | AID認証に失敗しています。 | AID認証の値を確認してください。 |
zis_lmtinfの指定が不正な値の為、権限が確認できません: [ステータスコード] | zis_lmtinfの指定に間違いがあります。 | zis_lmtinfの値を確認してください。 |
IP認証に失敗しました: [ステータスコード] | 接続元IPの認証が失敗しています。 | 接続元IPを確認してください。 |
特殊認証に失敗しました: [ステータスコード] | 特殊認証が失敗しています。 | 特殊認証を確認してください。 |
APIを使用する権限がありません | 権限に対してリクエストしたAPIを利用する権限がありません。 | APIへのリクエスト権限を確認してください。 |
利用可能件数(年)が残っていません | 年間利用回数を超えてリクエストがありました。 | 利用回数を確認してください。 |
利用可能件数(月)が残っていません | 月間利用回数を超えてリクエストがありました。 | 利用回数を確認してください。 |
利用可能件数(日)が残っていません | 日間利用回数を超えてリクエストがありました。 | 利用回数を確認してください。 |
許可エリア範囲外です | 入力パラメータが許可エリア範囲外となっています。 | 入力パラメータを許可エリア範囲内で指定してください。 |
テナント利用が許可されていないためクエリパラメータ building_typeに 1 は指定できません | 入力パラメータbuilding_typeの値が利用できない値(1)が指定されています。 | 入力パラメータbuilding_typeの値を1以外で指定してください。 |
入居者利用が許可されていないためクエリパラメータ building_type に2以外を指定してください | 入力パラメータbuilding_typeの値が利用できない値(2)が指定されています。 | 入力パラメータbuilding_typeの値を2以外で指定してください。 |
クエリパラメータ [パラメータ名] に許可されていないマップタイプが指定されています | 入力パラメータ[パラメータ名]の値が利用できないマップタイプ指定となっています。 | 入力パラメータ[パラメータ名]の値を利用可能なマップタイプを指定してください。 |
クエリパラメータ wms_overlay と src_url の同時指定時の上限を超えています | wms_overlayとsrc_urlを同時指定時、wms_overlayを3つ以上またはsrc_urlを3つ以上指定されています。 | wms_overlayとsrc_urlを同時指定時、wms_overlayは2つまでまたはsrc_urlを2つまでで指定してください。 |
地図画像を取得できませんでした。[エラー内容] |
・以下パラメータで指定された位置が地図画像取得範囲外だった場合に返却されます。 lat,lon,scale,format,orientation ・以下パラメータの指定が不正だった場合に返却されます。 maptype,user_figure,include,exclude,copyrights,centermark,basesize,usjson,hicolors |
・以下パラメータで指定された位置を、地図画像取得範囲内に収めてください。 lat,lon,scale,format,orientation ・以下パラメータに適した値を指定してください。 maptype,user_figure,include,exclude,copyrights,centermark,basesize,usjson,hicolors |
重畳するコンテンツを使用する権限がありません | 指定した認証キーでは、wms_overlayを利用する権限を持っていません。 | wms_overlayを利用する権限を持つ認証キーを指定してください。 |
クエリパラメータ word : word_match_type=1 or 3の場合、1文字は入力できません | word_match_typeに1(完全一致)または3(部分一致)をしている場合、入力パラメータ word に1文字の文字列を入力できません。 | 入力パラメータ word の値を2文字以上で指定してください。 |
形式:application/xml
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
入力パラメータに必須パラメータ[パラメータ名]および値が指定されていません。 | 必須パラメータ[パラメータ名]および値を指定してください。 |
|
入力パラメータ[パラメータ名]の値のフォーマット形式が違います。 | 入力パラメータ[パラメータ名]の値のフォーマット形式を確認して、正しい形式で指定してください。 |
|
入力パラメータ[パラメータ名]の値が不正な値となっています。 | 入力パラメータ[パラメータ名]の値は正確な値で指定してください。 |
|
入力パラメータ[パラメータ名]の値が範囲[値1]~[値2]外で指定されています。 | 入力パラメータ[パラメータ名]の値は範囲[値1]~[値2]内で指定してください。 |
|
入力パラメータ[パラメータ名]の値が負の値で指定されています。 | 入力パラメータ[パラメータ名]の値は正の値で設定してください。 |
|
地図、デザインバージョンが取得できませんでした。 | 入力パラメータ、マップタイプ等の値を確認してください。 |
|
入力パラメータ[パラメータ名]の値が範囲外で指定されています。 | 入力パラメータ[パラメータ名]の値は範囲内で指定してください。 |
|
入力パラメータ[パラメータ名]の値が[値]以上で指定されています。 | 入力パラメータ[パラメータ名]の値は[値]未満で指定してください。 |
|
入力パラメータ[パラメータ名]の値が整数値以外で指定されています。 | 入力パラメータ[パラメータ名]の値は整数値で指定してください。 |
401エラー
形式:application/json
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
Authorizationがヘッダに設定されていません。 | Authorizationをヘッダに設定してください。 |
|
x-api-keyがヘッダに設定されていません。 | x-api-keyをヘッダに設定してください。 |
403エラー
形式:application/json
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
存在しないチャネルIDがx-api-keyに指定されています。 | 存在するチャネルIDをx-api-keyに指定してください。 |
|
リクエスト対象APIがライブラリー用APIであり、一般チャネルからリクエストが行われています。 | リクエスト対象APIと紐づくライブラリー用チャネルのチャネルIDを用いてリクエストしてください。 |
|
リクエスト対象APIが一般APIであり、ライブラリー用チャネルからリクエストが行われています。 または、リクエスト対象APIがライブラリー用APIで、紐づかないライブラリー用チャネルからリクエストが行われています。 |
リクエスト対象APIが一般APIである場合、一般チャネルのチャネルIDを用いてリクエストしてください。 リクエスト対象APIがライブラリー用APIである場合、紐づくライブラリー用チャネルのチャネルIDを用いてリクエストしてください。 |
|
どの認証方式も有効になっていません。 | FO チャネル編集ページで、対象チャネルのいずれかの認証方式を有効にしてください。 |
|
期限切れのトークンが、Authorizationヘッダに設定されています。 | 新しいトークンを取得し、Authorizationヘッダに設定してください。 |
|
Authorizationヘッダの先頭に「Bearer」がありません。 または、「Bearer」の綴りが間違っています。 |
Authorizationヘッダの先頭には「Bearer」を付けてください。 「Bearer」を正確に綴ってください。 |
|
無効なトークンが、Authorizationヘッダに設定されています。 | 有効なトークンをAuthorizationヘッダに設定してください。 |
|
チャネルIDに紐づく契約IDが存在していません。 | 有効な契約IDに関連するチャネルIDを使用してください。 |
|
リクエスト元IPが、IP認証有効なIPリストに存在していません。 | FO チャネル編集ページで対象チャネルのIPリストにリクエスト元IPを追加してください。 |
|
リクエストヘッダのRefererが、リファラ認証有効なリファラリストに存在していません。 | FO チャネル編集ページで対象チャネルのリファラリストにリクエストヘッダのRefererを追加してください。 |
{ "message": "Authorization header requires 'Credential' parameter. Authorization header requires 'Signature' parameter. Authorization header requires 'SignedHeaders' parameter. Authorization header requires existence of either a 'X-Amz-Date' or a 'Date' header. Authorization=ip" } |
存在しないAPIへのリクエストが行われています。 | リクエストURLが正しいか、または存在するAPIへのリクエストか確認してください。 |
{ "message": "'Token' not a valid key=value pair (missing equal-sign) in Authorization header: 'Bearer Token'" } |
存在しないAPIへのリクエストが行われています。 | リクエストURLが正しいか、または存在するAPIへのリクエストか確認してください。 |
|
パラメータに契約エリア外の値を指定しています。 | 契約エリアをご確認ください。 |
|
パラメータに契約エリア外の値を指定しています。 | 契約エリアをご確認ください。 |
|
パラメータに契約エリア外の値を指定しています。 | 契約エリアをご確認ください。 |
404エラー
形式:application/xml
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
URLパス[パラメータ名]の値は上限値を超えています。 | URLパス[パラメータ名]の値は上限値以下で指定してください。 |
|
必要なパス情報が指定されていません。 | referenceを確認し、必要なパス情報を指定してください。 |
|
URLパスが異なります。 | 正しいURLパスを指定してください。 |
|
クエリパラメータ[パラメータ名]の値は上限値を超えています。 | クエリパラメータ[パラメータ名]の値は上限値以下で指定してください。 |
|
クエリパラメータ[パラメータ名]の値が不正です。 | referenceを確認し、クエリパラメータ[パラメータ名]の値に正しい値を指定してください。 |
|
指定した拡張子がpngではありません。 | 拡張子にpngを指定してください。 |
405エラー
形式:application/json
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
GET、POSTメソッド以外でリクエストが行われています。 | GETかPOSTメソッドを使用してリクエストしてください。 |
413エラー
形式:application/json
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
POSTメソッドで、10MBを超えるパラメータが指定されています。 | パラメータは10MBを超えないように調整してください。 |
|
リクエストヘッダが10KBを超えた状態でリクエストが行われています。 | リクエストヘッダは10KBを超えないように調整してください。 |
414エラー
形式:application/json
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
GETメソッドで、10KBを超えるパラメータが指定されています。 | パラメータは10KBを超えないように調整してください。 |
形式:text/html
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
GETメソッドで、パラメータに長い文字列(16KB以上)が指定されています。 | パラメータに指定する文字列を短くしてください(16KB未満)。 |
429エラー
形式:application/json
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
1日のリクエスト上限数を超えてリクエストが行われています。 | 日を空けて再度リクエストしてください。 |
|
1秒間のリクエスト数上限を超えてリクエストが行われています。リクエスト制限に関する説明はこちらをご覧ください。 | 時間を空けてから再度リクエストしてください。 |
494エラー
形式:application/json
メッセージ例 | 原因 | 対処方法 |
---|---|---|
|
大量の文字列がclient_idに指定されています。 | 正しい値をclient_idに指定し、リクエストしてください。 FO チャネル詳細ページ OAuth2.0項参照を参照してください。 |
|
大量の文字列がclient_secretに指定されています。 | 正しい値をclient_secretに指定し、リクエストしてください。 FO チャネル詳細ページ OAuth2.0項参照を参照してください。 |
WebAPIについて
複数のパラメータを指定した場合、AND検索となります。
パラメータ値がマルチバイト時はURLエンコードした値を付与してください。
パラメータへの配列指定方法について
WebAPIでパラメータにArrayが指定されている場合、特記がない場合はカンマ区切りで複数の文字列や数値を並べることで配列として取り扱います。
ノード・リンクについて
ネットワークは道路をなす線とその交わりないし分岐として表象できますが、交わる点あるいは分岐する点及び線の終点を結節あるいはノード(node)と呼びます。
線の点と点をつないでいる区間を結鎖あるいはリンク(link)と呼びます。
道路ネットワーク、コンピューターネットワーク等で、良く使われます。
リクエストパラメータ「word」について
①wordの先頭と末尾については、以下の文字列が削除されます
半角/全角の空白、タブ、リターン、改行、NULL、垂直タブ
②以下の文字列が削除されます。
’、'、(、)、(、)、[、]、[、]、「、」、「、」、・、・