Traffic API Developer's Guide

Flowavailability

This resource is responsible for handling requests for information about the availability of traffic flow information.

Response Data Format

This resource can deliver response data either in XML or JSON. To select the format use resource extensions .xml or .json, for example .../flow.json/..., .../incidents.xml/...

The response structure is based on the TML Formal Specification. For more information on TML specification, contact Technical Customer Support.

See also Examples for complete working URLs.

Request Parameters

Table 1. Availability Request Parameters
Parameter	Description
`app_code`	`xs:string` A 20-byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` and `app_code` with every request. For more information on authentication, see the Identity & Access Management Developer Guide.
`app_id`	`xs:string` A 20-byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` and `app_code` with every request. For more information on authentication, see the Identity & Access Management Developer Guide.
`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://developer.here.com/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. You must include an `apiKey` with every request. For more information on authentication, see the Identity & Access Management Developer Guide.
`id`	`xs:int` A user-defined incident identifier. The response contains the specific incident requested. Any integer is allowed.
`mapview`	`GeoBoundingBoxType`: lat,lon; lat,lon A type of spatial filter. A spatial filter defines the area targeted by the request (the area for which to retrieve data or a map tile). `mapview` defines the area to check for traffic coverage in the same way as `bbox`, following the same pattern and rules. If this parameter is not specified, the response returns all countries supported by the specified profile.
`profile`	`xs:string` Profile defines such attributes as geographic coverage (TMC tables available for use) and custom color mapping for tile overlays.
`zoom`	`xs:string` An indicator of the map zoom level. It dictates the visibility rules to be taken in account when selecting traffic data items. By default, if this parameter is not specified in a traffic flow data or traffic incident request, the response includes all incident reports, regardless of type.