ガイドAPIリファレンス
ガイド

IDでインシデントをリクエストする

単一のインシデントに関する詳細情報は、インシデントの元のIDと返される位置の参照タイプを指定することでリクエストできます(locationReferencing)。

名前空間の前にoriginalIdを付けることができます。名前空間が指定されていない場合、デフォルトの名前空間はhere:traffic:incidentになります。

locationReferencingにはtmcolrshapeから1つ以上を指定できます。位置のタイプには解釈できるものを指定し、処理できないデータを取得しないようにします。

📘

インシデント情報の位置に興味がない場合はnoneを指定してください。レスポンスに位置参照が含まれなくなります。

位置の参照タイプの詳細については、「位置の参照」を参照してください。

返されるデータは単一のインシデントアイテムであり、locationincidentDetails要素があります。各locationには、メートル単位のlengthと、その場所で利用可能な位置の参照 (locationReferencingパラメーターでリクエストされたタイプに応じる) が含まれます。

インシデントアイテムのincidentDetails要素には、開始時刻と終了時刻、AlertCコード、インシデントの説明などの詳細情報が含まれます。 次のようにGETリクエストを送信します。

curl -H "Authorization: Bearer $TOKEN" "https://data.traffic.hereapi.com/v7/incidents/here:traffic:incident:3879526487457467809?locationReferencing=tmc,shape,olr"

または、次のようにPOSTリクエストを送信します。

curl -X POST \
   "https://data.traffic.hereapi.com/v7/incidents/here:traffic:incident:3879526487457467809" \
   -H "Authorization: Bearer $TOKEN" \
   -H "Content-Type: application/json" \
   -d "{
       "locationReferencing": [
           "tmc",
           "olr",
           "shape"
       ],
       "lang": "GB",
       "units": "imperial"
   }" 
{
    "location": {
        "length": 376.0,
        "tmc": {
            "extendedCountryCode": "E0",
            "ebuCountryCode": "D",
            "tableId": "1",
            "locationId": "38219",
            "queuingDirection": "-",
            "extent": 1,
            "primaryOffset": 0.0,
            "affectedLength": 367.0
        },
        "shape": {
            "links": [
                {
                    "points": [
                        {
                            "lat": 53.90607001259923,
                            "lng": 13.0477100238204
                        },
                        {
                            "lat": 53.90607001259923,
                            "lng": 13.047900041565299
                        }
                    ],
                    "length": 13.0,
                    "functionalClass": 0
                },
                {
                    "points": [
                        {
                            "lat": 53.90607001259923,
                            "lng": 13.047900041565299
                        },
                        {
                            "lat": 53.906060038134456,
                            "lng": 13.048100033774972
                        },
                        {
                            "lat": 53.90604997985065,
                            "lng": 13.048319974914193
                        }
                    ],
                    "length": 28.0,
                    "functionalClass": 0
                },
                ...
            ]
        }
    },
    "incidentDetails": {
        "id": "3879526487457467809",
        "originalId": "3879526487457467809",
        "startTime": "2020-12-30T06:00:00Z",
        "endTime": "2021-10-31T15:00:00Z",
        "entryTime": "2021-06-11T12:15:20Z",
        "roadClosed": true,
        "criticality": "critical",
        "type": "construction",
        "typeDescription": {
            "value": "Straßenarbeiten",
            "language": "de-DE"
        },
        "codes": [
            1527
        ],
        "description":{
            "value":"Veranstaltung; Straße gesperrt."
        },
        "summary":{
            "value":"Veranstaltung; Straße gesperrt."
        }
    }
}

上のレスポンスは、読みやすいように省略されています。

descriptionおよびsummaryが使用する言語は、インシデントが所属する国の標準語です。

別の言語で情報を取得するには、langパラメーターを使用します (たとえば米国英語ならlang=en-US)。

インシデントIDが見つからない場合、「404 Not Found」エラーが返されます。