Source Attribution in Route Response Example

If copyright information is available, the response contains a sourceAttribution element. The response element contains a ready-to-display string in the attribution attribute, as well as data supplier information in structured form. For more information, see SourceAttributionType and SourceSupplierType.

In addition to generic attribution string expressed by SourceAttributionType::Attribution, the response can contain additional information about a data supplier that must be exposed in the client application. This information is included in SourceSupplierType::Note in the form of note objects. Each note has a specific type so that the client can distinguish between different kinds of notes. For more information, see SourceSupplierNoteType and RouteNoteType for details.

The code block below shows an example of attribution information:

"response": {
  "metaInfo": { ... },
  "route": [
  {
    "mode": { ... }
  }
  ],
  "language": "en-us",
  "sourceAttribution": {
    "attribution": "With the support of <span class=\"company\">
      <a href=\"http://example-company-a.com\">Company A</a></span>, <span class=\"company\">
      <a href=\"http://example-company-b.com\">Company B</a></span>. 
    All information is provided without warranty of any kind",
    "supplier": [
      {
        "title": "Company A",
        "href": "http://example-company-a.com",
        "note": [
          {
            "type":"ticketPurchase",
            "text":"Buy tickets at <a href="http://example-company-a.com/tickets">
              example-company-a.com</a>",
            "href":"http://example-company-a.com/tickets",
            "hrefText":"example-company-a.com"                      
          }
        ]
      },
      {
        "title": "Company B",
        "href": "http://example-company-b.com"
      }
    ]
  }
}