Link Object Structure

A link object is used to refer to other resources. This object contains the following attributes:

A label nodeis an object containing a set of fields with translations required for the UI. The label node contains the following attributes: This object contains the following attributes:

A link to a collection. Additional information is included that can be displayed to the user to help them to decide if this is the collection they are interested in.

A link to a favourite place.

A link to a place. Additional information is included that can be displayed to the user to help them to decide if this is the place they are interested in. It has the following attributes:

{
  "position": [48.8582557, 2.2947905],
  "distance": 881631,
  "title": "Eiffel Tower",
  "averageRating": 5.0,
  "category": {
    "id": "landmark-attraction",
    "title": "Landmark/Attraction",
    "href": "http://...",
    "type": "urn:nlp-types:category"
  },
  "icon": "http://...",
  "vicinity": "5 avenue Anatole France\n75007 Paris\nFrance",
  "type": "urn:nlp-types:place",
  "href": "http://...",
  "id": "250u09tu-4561b8da952f4fd79c4e1998c3fcf032"
}

A third-party identifier for a place or a place's location

{
  
  "references": {
    "pvid": {
      "id": "36704368"
    }
  }

}

Transit Lines Extended Attribute is associated with public transport stop/station and contains information about the lines and destinations:

Public transport line.

Category information for the public transport line.

Styling for the public transport line. All colors are in hex format.

Destination served from station/stop.

Access point for the location. Purpose of the access point is to provide location that can be used e.g. for navigation.

The opening hours object contains opening hours information for a place. The following properties may be available:

Structure for holding opening hours based on the iCalendar specification.

This structure is defined so that it can describe more complex recurrence pattern like "Every 2nd Saturday of the month from 10am to 10pm".

Unlike the iCalendar specification, the start value in our case does not contain a date part. We omit the date part and immediately start with the T that is time section marker. For example, instead of 19700101T132000 you should expect a simpler T132000 equivalent.

Each extended attribute object has at least the following properties:

A structure for holding phonetic information about the place in the NT-SAMPA format.

For each field there might be multiple phonetic transcriptions provided. If there are multiple phonetic transcriptions the ones which match the user's stated language preference best are returned first.

  {
    "title": [
      {
        "value": "pru|*\"dEn|tS@l \"sEn|t@r",
        "language": "en"
      },
      {
        "value": "pru|Den|\"tjal \"sen|ter",
        "language": "es-003"
      }
    ],
    "address": {
      "street": [
        {
          "value": "*\"bOIl|st@n \"strit",
          "language": "en"
        },
        {
          "value": "\"boils|ton \"e|se \"te",
          "language": "es-003"
        }
      ],
      "city": [
        {
          "value": "*\"bO|st@n",
          "language": "en"
        },
        {
          "value": "\"bos|ton",
          "language": "es-003"
        }
      ],
      "state": [
        {
          "value": "%m{|s@|*\"tSu|s@ts",
          "language": "en"
        },
        {
          "value": "ma|sa|\"tSu|sets",
          "language": "es-003"
        },
        {
          "value": "ma|sa|Su|\"sEts",
          "language": "fr-CA"
        }
      ]
    }
  }
    

A phonetic transcription of a name in a particular language.

A structure to hold phonetic information for an address.

Each alternative name is an object providing the alternative name as well as information on the language of that name, which may be different than the language requested by the user.

A link to a further search query based on the current search query. It may contain, for example, results restricted to a certain category or results for a suggested alternative search term.

This is an example of a result item representing a further search within a specified category:

{
  "title": "Sights & Museums",
  "type": "urn:nlp-types:search",
  "href": "http://...",
  "icon": "http://..."
}

This is an example of a result item representing an alternative suggestion for a search term:

{
  "title": "Hotel Adlon",
  "icon": "http://...",
  "type": "urn:nlp-types:search",
  "href": "http://.../discover/search?at=52.53044,13.41112&q=Hotel+Adlon",
  "vicinity": "Berlin<br/>Germany",
  "modified": true
}