premiumvics/traffic_info_geojsom
VICS地図重畳データ取得(GeoJSON)
指定された2次メッシュコードに含まれる渋滞情報および事象・規制情報の座標情報をGeoJSON形式で返却します。
レイヤ単位での返却となるため、「渋滞情報」「事象・規制情報(線)」「事象・規制情報(点)」のいずれかを返却します。
渋滞形状に適用する色が決まっているため、返却値の「渋滞度」から判断して形状の色を使い分けてください。
「渋滞」:赤
「混雑」:橙
「渋滞なし」:「渋滞」「混雑」「不明」と識別できる色であれば、どの色でも可。
「不明」:「渋滞」「混雑」「渋滞なし」と識別できる色であれば、どの色でも可。
カンマ区切りを許容するパラメータについては、無効値が含まれていた場合、エラーとして返却します。
このAPIを利用するには基盤認証側でauthkeyに対して設定をする必要があります。
HTTP request method
POST/GET
ContentType
application/x-www-form-urlencoded
Parameters
*requiredは必須
| 名前 | 説明 |
|---|---|
|
mesh_code*required number |
メッシュコード 情報を取得する対象の地域メッシュの2次メッシュコードを指定します。 6桁の数字のみ入力可能。 |
|
info_type string default traffic |
情報種別 取得する情報種別を指定します。単一指定のみ。複数指定した場合、エラーを返却します。
|
|
traffic_type string default intercity,city ※カンマ区切り |
渋滞情報取得道路種別 取得する道路種別を指定します。複数指定する場合は「,」区切りで指定します。 パラメータ「情報種別」に「渋滞情報」が指定されている場合有効です(事象・規制情報に影響しません)。
|
|
traffic_level string default medium,high ※カンマ区切り |
渋滞度 取得する渋滞度を指定します。複数指定する場合は「,」区切りで指定します。 パラメータ「情報種別」に「渋滞情報」が指定されている場合有効です(事象・規制情報に影響しません)。
|
|
regulation_type string default intercity,city ※カンマ区切り |
事象・規制情報取得道路種別 取得する道路種別を指定します。複数指定する場合は「,」区切りで指定します。 パラメータ「情報種別」に「事象・規制情報」が指定されている場合有効です(渋滞情報に影響しません)。
|
Responses
エラーについては「エラーメッセージ一覧」を参照してください。
Media type:application/json
| キー名 | 説明 | ||
|---|---|---|---|
| status string |
ステータス('OK'固定) | ||
| type string |
種別('FeatureCollection'固定) | ||
| name string |
レイヤ名称 レイヤ名称を出力します。
|
||
| mesh_code number |
メッシュコード リクエストされたメッシュコードを返却します。 |
||
| crs object |
空間参照系 | ||
| type string |
種別('name'固定) | ||
| properties object |
属性 | ||
| name string |
名称('urn:ogc:def:crs:EPSG::4326'固定) | ||
| features object |
空間参照系 | ||
| type string |
種別('Feature'固定) | ||
| properties object |
属性 ※リクエストパラメータ:info_typeの値によりレスポンス内容が異なるため、下部に別途記載 |
||
| geometry object |
図形 | ||
| type string |
種別 GeoJSONの構造に準拠します。 |
||
| coordinate array[number] |
座標列 GeoJSONの構造に準拠します。 |
||
レスポンスパラメータproperties(info_type=traffic の場合)
| キー名 | 説明 |
|---|---|
| id string |
ID 渋滞テーブルのIDが入ります。 |
| link_type_val string |
リンク区分名称 JARTICが提供しているリンク区分名称が入ります。 「高速/都市高速/一般道/その他」 のいずれかが入ります。 |
| jam_level_val string |
渋滞度名称 JARTICが提供している渋滞度名称が入ります。 「渋滞/混雑/渋滞なし/不明」 のいずれかが入ります。 |
レスポンスパラメータproperties(info_type=regulation_line または regulation_point の場合)
| キー名 | 説明 |
|---|---|
| id string |
ID 渋滞テーブルのIDが入ります。 |
| link_type_val string |
リンク区分名称 JARTICが提供しているリンク区分名称が入ります。 「高速/都市高速/一般道/その他」 のいずれかが入ります。 |
| cause_val string |
原因事象名称 JARTICが提供している渋滞度名称が入ります。 |
| regulation_val string |
規制内容名称 JARTICが提供している渋滞度名称が入ります。 |
| regulation_detail_val string |
規制内容詳細名称 JARTICが提供している規制内容詳細名称が入ります。 |
| regulation_time_zone string |
時間帯指定コード 時間帯指定コードが入ります。
|
| regulation_start_datetime string |
開始予定日時 開始予定日時が入ります。 「MM-DD hh:mm」形式で記述されます。 開始予定日時が不明の場合は空文字が入ります。 |
| regulation_end_datetime string |
終了予定日時 終了予定日時が入ります。 「MM-DD hh:mm」形式で記述されます。 終了予定日時が不明の場合は空文字が入ります。 |
Media type:application/json
| キー名 | 説明 |
|---|---|
| status string |
ステータス |
| message object |
エラーメッセージ エラー内容が分かるメッセージを出力します。 |
Example
https://[domain]/route/vics/traffic_info_geojson?mesh_code=533935&info_type=regulation_line&traffic_type=intercity,city&traffic_level=high,medium,low,unknown®ulation_type=intercity,city,local,other
{
"status": "OK",
"type": "FeatureCollection",
"name": "事象・規制(線)",
"mesh_code": 533935,
"crs": {
"type": "name",
"properties": {
"name": "urn:ogc:def:crs:EPSG::4326"
}
},
"features": [
{
"type": "Feature",
"properties": {
"id": 2879,
"link_type_val": "一般道",
"cause_val": "工事",
"regulation_val": "片側規制",
"cause_detail_val": "詳細なし",
"regulation_detail_val": "片側交互通行",
"regulation_time_zone": "0",
"regulation_start_datetime": "08-07 09:00",
"regulation_end_datetime": "08-07 12:00"
},
"geometry": {
"type": "LineString",
"coordinates": [
[
139.7298874519995,
35.643881041757766
],
[
139.72994113131105,
35.643876967629254
],
[
139.7299671127671,
35.64387404836447
],
[
139.72998207565104,
35.64387151228268
],
[
139.7302323172165,
35.643856633050774
],
[
139.73038259436987,
35.643836377114944
],
[
139.73054851351537,
35.64381516738703
],
[
139.73086037734467,
35.64380029048037
],
[
139.73087643229894,
35.64379411549819
],
[
139.73088642329287,
35.64379048240953
],
[
139.73098323328313,
35.64378120188735
]
]
}
},
{
"type": "Feature",
"properties": {
"id": 2884,
"link_type_val": "一般道",
"cause_val": "事故",
"regulation_val": "車線規制",
"cause_detail_val": "人身事故",
"regulation_detail_val": "詳細なし",
"regulation_time_zone": "0",
"regulation_start_datetime": "08-07 08:53",
"regulation_end_datetime": ""
},
"geometry": {
"type": "LineString",
"coordinates": [
[
139.6313783094618,
35.621088867187495
],
[
139.63156467013889,
35.620957302517375
],
[
139.6316691080729,
35.62089029947917
],
[
139.63174424913194,
35.62084879557291
],
[
139.63187174479168,
35.620780436197926
],
[
139.63225124782988,
35.62055230034723
],
[
139.63226481119793,
35.62054416232639
],
[
139.6322781032986,
35.620537651909714
],
[
139.6325249565972,
35.62038872612849
],
[
139.63261610243055,
35.620330946180566
],
[
139.63274739583332,
35.62024793836805
],
[
139.63280653211805,
35.62021430121528
],
[
139.6328347439236,
35.620196940104165
],
[
139.6328412543403,
35.620192871093735
],
[
139.6329847349406,
35.6201071233251
]
]
}
},
{
"type": "Feature",
"properties": {
"id": 2883,
"link_type_val": "一般道",
"cause_val": "工事",
"regulation_val": "右左折規制",
"cause_detail_val": "架橋工事",
"regulation_detail_val": "右折禁止",
"regulation_time_zone": "0",
"regulation_start_datetime": "06-01 09:00",
"regulation_end_datetime": ""
},
"geometry": {
"type": "LineString",
"coordinates": [
[
139.74535661701412,
35.632258527102536
],
[
139.74533311631944,
35.63202826605903
],
[
139.7453076171875,
35.63180962456598
]
]
}
},
{
"type": "Feature",
"properties": {
"id": 2882,
"link_type_val": "一般道",
"cause_val": "工事",
"regulation_val": "右左折規制",
"cause_detail_val": "架橋工事",
"regulation_detail_val": "直進禁止",
"regulation_time_zone": "0",
"regulation_start_datetime": "06-01 09:00",
"regulation_end_datetime": ""
},
"geometry": {
"type": "LineString",
"coordinates": [
[
139.74584816218263,
35.631693724417175
],
[
139.74584147135417,
35.63169433593751
],
[
139.74548611111112,
35.6317249891493
],
[
139.74529975043401,
35.63174506293403
]
]
}
},
{
"type": "Feature",
"properties": {
"id": 2880,
"link_type_val": "一般道",
"cause_val": "工事",
"regulation_val": "右左折規制",
"cause_detail_val": "架橋工事",
"regulation_detail_val": "左折禁止",
"regulation_time_zone": "0",
"regulation_start_datetime": "06-01 09:00",
"regulation_end_datetime": ""
},
"geometry": {
"type": "LineString",
"coordinates": [
[
139.74512382593633,
35.63114817435092
],
[
139.74516547309028,
35.63156819661459
],
[
139.74517474861688,
35.63168738726423
]
]
}
},
{
"type": "Feature",
"properties": {
"id": 2881,
"link_type_val": "一般道",
"cause_val": "工事",
"regulation_val": "片側規制",
"cause_detail_val": "詳細なし",
"regulation_detail_val": "詳細なし",
"regulation_time_zone": "0",
"regulation_start_datetime": "08-07 09:00",
"regulation_end_datetime": "08-07 12:00"
},
"geometry": {
"type": "LineString",
"coordinates": [
[
139.73176573398325,
35.64364392899741
],
[
139.7313765867287,
35.64368895912385
],
[
139.73134158203044,
35.64369167266616
],
[
139.73130622396903,
35.643695784068846
],
[
139.73086867653933,
35.643737729395276
],
[
139.7308488281261,
35.643744947000165
],
[
139.73084372422332,
35.643746910039766
],
[
139.73054143874393,
35.64376133000858
],
[
139.7303720714323,
35.64378298052362
],
[
139.7302244970222,
35.64380287215735
],
[
139.7299728939701,
35.64381783233513
],
[
139.72995584730603,
35.643820721600434
],
[
139.7299335431707,
35.64382322768303
],
[
139.72957607512296,
35.643850358171484
]
]
}
}
]
}