Sorry, you need to enable JavaScript to visit this website.

DDS Direct ™ (legacy)


For advanced users who want access to all of the underlying DDS (core platform) functionality, we have exposed a special end point for direct communication. 

The process is that you POST a structured DDS JSON request and get the raw output in JSON format from DDS.

This feature is disabled by default for all apps, contact us for more information regarding the use of this feature. The full 900 page DDS manual is available on request.

Request

Format

 

POST https://<baseURL>/dds/<versionNumber>/dds​.<ext>?key=<apiKey>&rawResponse=<rawResponse>

Parameters

The table below describes all of the parameters that can be used in a request. Required parameters must be used or the call will fail. Optional parameters may be used. If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table. The order of request parameters is not important.

Parameter Description Req'd? Type / Values Default Value Max Value
baseURL Base URL for calling the API. Yes api.tomtom.com
versionNumber Service version number. The current value is 1. Yes 1
ext Valid response formats are JSON, JSONP, JS or XML. Yes String
apiKey Authorization key for access to the API. Yes String
rawResponse Option to include the raw output of the DDS engine. Yes Boolean false

Headers for POST requests

The Content-Type header must be set to "application/json".

Header Description Req'd? Values Default Value
Content-Type Specifies the MIME type of the body of the request. Yes
  • application/json
 

Parameters in POST Body

Parameter Description Req'd? Type / Values Example
DDSQuery Base URL The DDS Query formatted as a json object. Yes JSON Object
{
  "DDSQuery" : {
  "queryType":"S2LN",   //DDS Query Type
  "inputGroup":{        //Input Parameters required for the DDS Query
    "LL": "37,-122",
    "RAD":"M1000",
    "CUST":"map-sample-app"
  },
  "controlGroups":[     //Control parameters for the DDS Query
      {
        "LL": false,      //a false value will encode to a parameter without a value in the DDS query
        "SN": false,      //for example, this query will contain: %LL%SN%ADDR
        "ADDR": false,
        "CAT":7,
        "GZ":false,
        "PC":false,
        "AC":false,
        "S1": false,
        "M":10,
        "SPEEDLIMIT":"M",
        "ADDRPT":false,
        "INTERPADDR":false,
        "EXTIME":false,
        "DS":"tomtom-world",
        "DATAVENDOR":false,
        "CHARACTERENCODING":"utf-8"
      }
    ]
  }
}
 

Response

Format

Response will be a json encoding of the DDS Response. For example:

{
queryToken:'RMAN',
   status:{               //Status group
      ExecutionTime:'160',
      ROUTEIDHEX:'470000007856341200000000470000005F1A8CCFA952C800ED60A7205D2DD9F600B59245CA2AD2BC0AC5D2DD9C00D050994AFEF8FDA5B092AB01B5C546FF291B0BAC00E18FB6A855213A00',
      Number:'5',
      Status:'OK',
      TDIST:'R1.3205',
      VR:'58,3733599,-12188901,-6,4,-111,85,-51,-108,-25,-53,-44,-96,-39,-80,-49,-101,-5,-11,-44,-91,-7,-14,-43,-94,-8,-17,-12,-25,-14,-31,-4,-10,-4,-20,-8,-17,-5,-12,-4,-10,-7,-14,-2,-5,-9,-18,-3,-6,-7,-15,-5,-12,-8,-15,-13,-16,-35,-73,-14,-32,-14,-30,-18,-36,-11,-22,-22,-50,-26,-55,-1,-21,-1,-23,-3,-60,-99,7,-41,3,-19,2,-51,6,-26,1,-17,1,-23,0,-46,0,-34,-1,-21,0,-3,0,-16,2,-18,5,-12,6,-11,6,-16,12,-10,8,7,15,33,53,31,56',
      TTIME:'213.31 sec',
      LLMIN:'37.32454,-121.90105',
      LLMAX:'37.33599,-121.88812',
      OTIME:'2013,5,7,8,56,,-8',
      DTIME:'2013,5,7,8,59,,-8',
      DataVendor:'TOMTOM'
   },
   output:[           //Output groups
      {
         DHED:'Southeast',
         DANG:'149.0',
         DSTR:'S 2nd St',
         TURN:'Proceed',
         LL:'37.33599,-121.88901',
         VR:'3,3733599,-12188901,-6,4,-111,85',
         TEXT:'Proceed Southeast on S 2nd St'
      },
      {
         ROADUSE:'3',
         SN:'S 2nd St',
         DIST:'R0.0945',
         TIME:'13.61 sec',
         VR:'3,3733599,-12188901,-6,4,-111,85',
         OHED:'Southeast',
         OANG:'148.7',
         LL:'37.33482,-121.88812',
         TURN:'Turn Right',
         TANG:'90.6',
         FTANG:'90.6',
         TX:'S 2nd St,E San Fernando St',
         DHED:'Southwest',
         DANG:'239.2',
         DSTR:'E San Fernando St',
         TEXT:'Turn right onto E San Fernando St.'
      },
      {
         ROADUSE:'3',
         SN:'W San Fernando St',
         DIST:'R0.8169',
         TIME:'117.62 sec',
         VR:'36,3733482,-12188812,-51,-108,-25,-53,-44,-96,-39,-80,-49,-101,-5,-11,-44,-91,-7,-14,-43,-94,-8,-17,-12,-25,-14,-31,-4,-10,-4,-20,-8,-17,-5,-12,-4,-10,-7,-14,-2,-5,-9,-18,-3,-6,-7,-15,-5,-12,-8,-15,-13,-16,-35,-73,-14,-32,-14,-30,-18,-36,-11,-22,-22,-50,-26,-55,-1,-21,-1,-23,-3,-60',
         OHED:'West',
         OANG:'266.5',
         LL:'37.32917,-121.90105',
         TURN:'Turn Left',
         TANG:'-89.7',
         FTANG:'-89.7',
         TX:'W San Fernando St,S Montgomery St\\:RN:NS/CA-82//S/USA3',
         DHED:'South',
         DANG:'176.8',
         DSTR:'S Montgomery St\\:RN:NS/CA-82//S/USA3',
         TEXT:'Turn left onto S Montgomery St/CA-82 S.'
      },
      {
         ROADUSE:'2',
         SN:'S Montgomery St\\:RN:NS/CA-82//S/USA3',
         DIST:'R0.3166',
         TIME:'32.57 sec',
         VR:'17,3732917,-12190105,-99,7,-41,3,-19,2,-51,6,-26,1,-17,1,-23,0,-46,0,-34,-1,-21,0,-3,0,-16,2,-18,5,-12,6,-11,6,-16,12',
         OHED:'Southeast',
         OANG:'149.0',
         LL:'37.32464,-121.90055',
         LANECON:'M0.0:28.5,3732464,-12190055,-3,23,4:2,1,dd:bb',
         TURN:'Turn Left',
         TANG:'-97.0',
         FTANG:'-1.4',
         TX:'W San Carlos St,Bird Ave',
         DHED:'Northeast',
         DANG:'52.0',
         DSTR:'W San Carlos St\\:RN:NS/CA-82//S/USA3',
         TEXT:'Turn sharp left onto W San Carlos St/CA-82 S.'
      },
      {
         ROADUSE:'2',
         SN:'W San Carlos St\\:RN:NS/CA-82//S/USA3',
         DIST:'R0.0925',
         TIME:'9.52 sec',
         VR:'5,3732464,-12190055,-10,8,7,15,33,53,31,56',
         OHED:'Northeast',
         OANG:'54.9',
         LL:'37.32525,-121.89923',
         DLL:'37.32525,-121.89923',
         SIDE:'R',
         TEXT:'Arrive at destination'
      }
   ]
}