Traffic API 開発者ガイド(交通情報)

インシデント 6.2.

このリソースは、または地理空間エリアの交通事故情報に対するリクエストを処理する役割を果たします。 配信形式は、 XML または JSON のいずれかです。 以下のリクエストパラメータは、すべてのインシデントエンドポイント (6.0 、 6.1 、 6.2)* で有効です。

( * パラメータは例外 type です。 詳細については、このパラメータの説明を参照してください)。

一般的な使用例のパラメータの組み合わせ

表 1. Localization を使用して交通事故データをリクエストします
必須です オプションです
  • quadkeyproxbbox、または corridor (Z / X / Y アドレスを除く )
  • c lg ペアとして、またはと組み合わせて使用できます i18n
  • criticality
  • endTime
  • inc22
  • jsoncallback
  • localtime
  • maxresults
  • profile
  • sort
  • startTime
  • status
  • tables
  • type
  • verified
  • units
表 2. 交通事故データのサブセットをリクエストします
必須です オプションです
  • quadkeyproxbbox、または corridor (Z / X / Y アドレスを除く )
  • 次の 1 つ以上のフィルタパラメータ。
    • criticality
    • endTime
    • maxresults
    • profile
    • startTime
    • status
    • tables
    • type
    • verified
  • c lg ペアとして、またはと組み合わせて使用できます i18n
  • inc22
  • jsoncallback
  • localtime
  • sort
  • units

応答データの形式

このリソースは、アドレス指定方式に応じて、 JSON の XML で応答データを配信できます。

  • [Z]/[X]/[Y] アドレス指定 - URL 変数を使用するか xmljson、またはなどのリソース名の直後にある 変数を使用します .../flow/xml/... .../incidents/json/...
  • それ以外の場合は 、リソース拡張子 .xml を使用するか .json.../flow.json/...、またはなどを使用します。 .../incidents.xml/...

応答構造は、 TML 正式仕様に基づいています。 TML 仕様の詳細については、 TCS (テクニカル カスタマー サポート) にお問い合わせください。

作業 URL の詳細については、も参照してください。

リソースパラメーター

表 3. インシデントリクエストのパラメータ
パラメーター 説明
app_code

xs:string

クライアント アプリケーションの認証に使用される 20 バイトの Base64 URL セーフエンコード文字列。

app_id すべて app_code のリクエストに AND を含める必要があります。 認証の詳細について は、『 Identity & Access Management 開発者ガイド』を参照してください。

app_id

xs:string

クライアント アプリケーションの認証に使用される 20 バイトの Base64 URL セーフエンコード文字列。

app_id すべて app_code のリクエストに AND を含める必要があります。  認証の詳細については、『 Identity & Access Management 開発者ガイド』を参照してください。

apiKey

xs:string

A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged in user, you can generate it at https://here-tech.skawa.fun/projects. API Keys never expire but you can invalidate your API Keys at any time. You cannot have more than two API Keys for one app at the same time.

apiKey すべてのリクエストにを含める必要があります。 認証の詳細については、『 Identity & Access Management 開発者ガイド』を参照してください。

bbox

GeoBoundingBoxType: lat 、 lon ; lat 、 lon

空間フィルタのタイプ。 空間フィルタは、要求の対象となる領域 ( データまたはマップ タイルを取得する領域 ) を定義します。  バウンディング ボックスは、 2 つの緯度と経度のペアで指定された長方形の領域を表します。 1 つ目のペアは、バウンディング ボックスの左上隅、 2 つ目の右下隅を定義します。

注 : バウンディング ボックスの最大許容サイズ ( 幅および高さ ) は 10 度に制限されています。
c

xs:string

国のインジケータ ( インシデント対応のロケール ) 。 使用できる値は、特定の ISO 国コード (2 バイト、 ISO 3166-1-alpha-2) です。 パラメータ lg は、パラメータと組み合わせて使用する必要があります。 デフォルトでは(パラメータが指定されていない場合)、応答の時間と形式はインシデントの場所に基づいています。

corridor

GeoCorridorType: lat 、 lon 、 lat 、 lon 、 lat 、 lon 、 lat 、 lon 、 [etc.]; width

空間フィルタのタイプ。 空間フィルタは、要求の対象となる領域 ( データまたはマップ タイルを取得する領域 ) を定義します。 廊下からのリクエストに対する応答には、廊下のエリア内にある結果が含まれます。 経路と幅によって経路が定義されます。 経路は、一連の緯度と経度のペアで表される、回廊の中央に沿った線です。 廊下の幅はメートル単位で指定します。

criticality

xs:string

重要度に応じてインシデントレポートを選択するフィルタ。大文字と小文字は区別されません。 このパラメータには、次のリストから選択した複数のカンマ区切り値を含めることができます。

  • critical または 0
  • major または 1
  • minor または 2
  • lowImpact または 3

このパラメータが指定されていない場合、重要度に関係なく、すべてのインシデントレポートが応答に含まれます ( デフォルトの動作 ) 。

endTime

xs:dateTime

結果に含めるインシデントと一致する必要がある最大終了時間( GMT 形式)。
YYYY-MM-DDThh:mm:ss.s+zzzz
時間値をフィルタリングするときに使用する形式については、 xs:dateTime を参照してください。
i18n

xs:boolean

インシデントメッセージを lg パラメータで指定した言語に変換するかどうかを示すフラグ。 このパラメータは、と組み合わせて使用する必要 lgがあります。

このパラメータで使用できる値は次のとおりです。

  • true
  • false
inc22

xs:boolean

応答をバージョンと一致するように書式設定するかどうかを示すフラグ。 インシデントのうち 2.2 つの XSD ()true。 XSD のバージョン 2.2 には、デフォルトのバージョン 2.1(5.0) に含まれていないフィールドと情報が含まれています

使用できる値は次のとおりです。

  • true または 1
  • false または 0
jsoncallback

xs:string

JSON 応答のラップに使用するユーザー定義関数の名前を指定するパラメータ。

lg

xs:string

インシデント応答のロケール言語の指定子。 パラメータ c は、パラメータと組み合わせて使用する必要があります。 既定 lg では ( が提供されていない場合 ) 、応答の言語はインシデントの場所に基づいています。

使用できる値については、「サポートされている翻訳言語」を参照

localtime

xs:boolean

交通事故データのリクエストに対する応答のすべての時間値がtrue、 GMT+h:mm() ではなく、インシデントのローカル時間に含まれる必要がfalseあるかどうかを示すフラグ。 使用できる値は次のとおりです。

  • true または 1
  • false または 0
maxresults

xs:int

回答に含める最大インシデント数のインジケータ。 正の数の値は 0 以外にすることができます。

profile

xs:string

プロファイルでは、地理的カバレッジ (TMC テーブルを使用可能 ) やタイルオーバーレイのカスタムカラーマッピングなどの属性を定義します。

prox

GeoProximityType: lat 、 long 、 distance

空間フィルタのタイプ。 空間フィルタは、要求の対象となる領域 ( データまたはマップ タイルを取得する領域 ) を定義します。 近傍を使用した要求に対する応答には、 A 緯度とその中心および半径の経度によって定義された円の範囲内にある結果が含まれます(メートル単位で指定)。

quadkey

QuadkeyType

地球全体に及ぶタイルのグリッド内のマップ タイルの識別子。 quadkey は、 0 ~ 21 桁の 1 つの数値文字列です。 quadkey が参照するグリッドのマップズーム レベルは、 quadkey 文字列の桁数と同じです。 quadkey アドレッシング方式のエンドポイントでのみ使用します。 Quadkeys も参照してください。

sort

xs:string

重要度に基づいて、交通事故リクエストに対する応答データを並べ替える方法を指定するインジケータ。 使用できる値は次のとおりです。

  • criticalityDesc
  • criticalityAsc
startTime

xs:dateTime

結果に含まれるインシデントと一致する最小開始時間( GMT 形式)。
YYYY-MM-DDThh:mm:ss.s+zzzzzz
時間値をフィルタリングするときに使用する形式については、 xs:dateTime を参照してください。
status

xs:string

ステータスに応じてインシデントの選択をトリガーするステータスインジケータ。大文字と小文字は区別されません。 パラメータ値は、複数の値をコンマで区切って指定できます。 受け入れられるステータス値は、 activeinactivedeleted、および expiredです。 デフォルトでは(パラメータが指定されていない場合)、ステータスに関係なく、すべてのインシデントレポートが応答に含まれます。

tables

TMCCodeType

プロファイル内の TMC テーブルを指定して、応答に含めるか、または応答から除外するかを指定するパラメータ。 値に複数のテーブルが指定されている場合、テーブル ID はカンマで区切ります。 正の値が含まれ、負の値は除外されます。
注 : 正の値と負の値の組み合わせはサポートされていません。その結果、エラー応答が発生します。
デフォルトでは ( パラメータがリクエストで使用されていない場合 ) 、応答にはプロファイル内のすべてのテーブルが含まれます。 利用可能なテーブルの一覧については、 TMCCodeType の TMC テーブルまたは顧客プロファイルの一覧を参照してください。
type

xs:string

応答に含めるアイテムのタイプを指定するインジケータ。大文字と小文字は区別されません。 値には、複数のタイプ識別子をコンマで区切って含めることができます。 この値で使用できるトラフィック項目タイプの識別子は次のとおりです。

  • Accident
  • Congestion
  • DisabledVehicle
  • RoadHazard
  • Construction
  • PlannedEvent
  • MassTransit
  • OtherNews
  • Weather
  • Misc
  • RoadClosure *
  • LaneRestriction *

デフォルトでは(リクエストでパラメータが指定されていない場合)、タイプに関係なく、すべてのインシデントレポートが応答に含まれます。

*- このタイプは、インシデントバージョン 2.3 (traffic/6.2/incidents.endpoint) をリクエストする場合にのみサポートされます<format>

verified

xs:boolean

確認済みのインシデントレポートを応答に含めるか、または除外するかを示すフラグ。 使用できる値は次のとおりです。

  • true または 1
  • false または 0

デフォルトでは、リクエストでこのパラメータが指定されていない場合、タイプに関係なく、すべてのインシデントレポートが応答に含まれます。

units

xs:string

このパラメータは、応答のすべての値が必要な単位系に変換されることを保証するために使用されます。

次の値を受け入れます。

  • メートル法
  • 英単位系

既定では、このパラメータを指定しない場合、値はコンテンツフィードから受信したものと同じ単位系で返されます。