JSON Response Patterns

Optional Properties

If there is no value for an attribute of an object, that attribute is omitted altogether. For example, in the reviewobject, the id, language, and via attributes are not necessarily present:

{
  "reviewId": "ugc-bdc277eb-de94-48f0-bcb8-9e53034ee0d7",
  "date": "2012-03-12T17:36:56Z",
  "title": "some review",
  "rating": 5,
  "description": "some review description",
  "user": {
    "name": "anonymous"
  },
  "language": "en",
  "supplier": {
    "id": "here",
    "title": "HERE User",
    "href": "http://...",
    "type": "urn:nlp-types:supplier",
    "icon": "http://..."
  },
  "attribution": "Provided by HERE User"
}

Check the reference documentation for each specific response object for information on which properties are guaranteed to be present. Most objects, or their attributes, are listed as required or optional.

Rich Text Properties

Properties that are designed to be displayed to the user contain rich text. For example, the text attribute of the address object. The default format is HTML, but you can switch to plain text for the entire response and/or selected fields.

Rendered Representations Of Complex Properties

Some response attributes, for example the address of a place, have complex data structures. A client can process this data and make use of each field or a selection of the fields. However, if a client only needs to display an address to the user, the client can use the text field in address for that purpose, without additional processing as text is a rich text field.

{
  "address": {
    "street": "22 Rue du Grenier Saint-Lazare",
    "postalCode": "75003",
    "city": "Paris",
    "countryCode": "FRA",
    "country": "France",
    "text": "22 Rue du Grenier Saint-Lazare\n75003 Paris\nFrance"
  }
}