ジャンルコード一覧取得
API名:
概要:
ジャンルコード一覧を返却します。
※多言語情報の出力には別途契約が必要です。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecodelist
<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecodelist?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&genrecode=0014000240;0014000250
リクエストパラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||||
---|---|---|---|---|---|---|---|
genrecode | - |
絞込みジャンルコード 検索範囲を指定のジャンルコードに限定します。 5桁または10桁のコードで指定します。 複数値指定するとOR検索で絞込みされます。 ジャンルコードの取得は基本的にジャンルコード一覧取得APIを使用してください。 ジャンルコード一覧は下記よりダウンロードできます。 ・ジャンルコード一覧(Excel) |
|||||
notmultilanguage | F |
多言語情報出力 検索結果に多言語情報を含まないかを真偽値で指定します。 本パラメータはオプション機能で多言語機能を選択されているクライアントIDのみ有効です。
|
出力データ
出力フォーマット
{"status":{"code":"0000", "text":"OK"}, "genrelist":{"genre1":[{"code":"00110", "text":"車・交通", "count":101157, "text-multi":null, "genre2":[{"code":"00260", "text":"駅", "count":10516, "text-multi":null},..]}}
キー名 | データ型 | 説明 | |||||||
---|---|---|---|---|---|---|---|---|---|
status | object | ステータス情報を返却します。 | |||||||
code | string |
ステータスコードを返却します。
|
|||||||
text | string | ステータス内容に関するテキスト情報を返却します。 | |||||||
genrecodelist | object |
ジャンル情報を返却します。 検索結果が0件の場合はNULLとなります。 |
|||||||
genre1 | object | 大ジャンル情報を返却します。 | |||||||
code | string | 大ジャンルコードを返却します。 | |||||||
text | string | 大ジャンル名称を返却します。 | |||||||
count | number | 大ジャンル件数を返却します。 | |||||||
text-multi | object | 言語別大ジャンル名称を返却します。 | |||||||
genre2 | object | 中ジャンル情報を返却します。 | |||||||
code | string | 中ジャンルコードを返却します。 | |||||||
text | string | 中ジャンル名称を返却します。 | |||||||
count | number | 中ジャンル件数を返却します。 | |||||||
text-multi | object | 言語別中ジャンル名称を返却します。 |
出力例
[通常出力例(多言語情報出力契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecodelist?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&genrecode=0014000240;0014000250
{ "status": { "code": "0000", "text": "OK" }, "genrelist": { "genre1": [ { "code": "00140", "text": "買い物", "count": 2157, "text-multi": { "zh-cn": "购物", "zh-tw": "購物", "en": "Shopping", "ko": "쇼핑" }, "genre2": [ { "code": "00250", "text": "ビデオ・CD", "count": 2157, "text-multi": { "zh-cn": "视频CD", "zh-tw": "視頻CD", "en": "Video/CD", "ko": "Video/CD"}}]}]}}
[通常出力例(多言語情報出力未契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecodelist?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&genrecode=0014000240;0014000250
{ "status": { "code": "0000", "text": "OK" }, "genrelist": { "genre1": [ { "code": "00140", "text": "買い物", "count": 9562, "text-multi": null, "genre2": [ { "code": "00240", "text": "本屋", "count": 7385, "text-multi": null }, { "code": "00250", "text": "ビデオ・CD", "count": 2177, "text-multi": null}]}]}}
[検索結果が0件の場合]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecode?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&genrecode=0099999999
{"status":{"code":"0000", "text":"OK"}, "genrelist":null}