エリアLマスタ取得API


URL:https://api.gnavi.co.jp/master/GAreaLargeSearchAPI/v3/

リクエストパラメータ

パラメータ名 必須 説明 備考
keyid string アクセスキー ぐるなびより提供されたアクセスキー
lang   string 返却データの言語 ja: 日本語, zh_cn: 中国語 (簡体字), zh_tw: 中国語 (繁体時), ko: 韓国語, en: 英語

レスポンス

パラメータ名
(タグ名、@付きは属性名)
出現回数 説明 備考
response 1 complexType レスポンスルートノード  
@api_version - string APIのバージョン  
  garea_large 複数回 complexType エリアL情報  
  areacode_l 1 string エリアLコード  
areaname_l 1 string エリアL名称  
pref 複数回 complexType 都道府県情報  
  pref_code 1 string 都道府県コード  
pref_name 1 string 都道府県名  

エラー仕様

パラメータ名
(タグ名)
出現回数 説明
gnavi 1 complexType ルートノード
@api_version - string APIのバージョン
  error 1 complexType エラー
  code 1 integer エラーコード(詳細は「エラーコード一覧」をご覧ください)
message 1 string エラーメッセージ

エラーコード一覧

エラーコード エラー内容
400 不正なパラメータが指定された
401 不正なアクセス(認証エラー)
404 指定された店舗の情報が存在しない
405 不正なアクセス
429 リクエスト回数上限超過
500 処理中にエラーが発生した

サンプルエラーレスポンス

{
    "@attributes":{
        "api_version":"v3"
    },
    "error":{
        "code":"400",
        "message":"指定されたパラメーターは存在しません"
    }
}
              

データを正しく返却できない際は、上記のようなエラーデータを返却します。

さっそく「ぐるなび API」を使ってみる