Skip to main content
API docs by Redocly

Global DCC API (1.0.0)

Download OpenAPI specification:Download

Authentication

This API uses Basic authentication. Available users are gdcc and sdm.

Rate limiting

There are currently no limits on how many requests and you can send to this API, but it can change later.

Version 0 endpoints

Binary

Calculate whatever native DCC understands

Authorizations:
Basic
query Parameters
roadNetId
required
string or null
Default: "DK"
Request Body schema: application/json
required
data
string or null <byte>

The raw binary representation of a request

messageVersion
integer <int32>

The spc message version of the data in the request

Responses

Request samples

Content type
application/json
{
  • "data": "string",
  • "messageVersion": 0
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "messageVersion": 0
}

Binary2

Calculate whatever native DCC understands, sending and receiving raw binary data. The version of the reply isstored in an integer in the first four bytes of the reply stream

Authorizations:
Basic
query Parameters
roadNetId
required
string or null
Default: "DK"
version
integer <int32>
Request Body schema: multipart/form-data
data
string or null <binary>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Distance

Calculate distance

Authorizations:
Basic
query Parameters
roadNetId
required
string or null
Default: "DK"
Request Body schema: application/json
required
(Coordinate (object or null))

A required source for the calculation

Array of objects or null (Coordinate)

The destinations for the calculation

(Circumstance (object or null))

The circumstances of the calculations, optional

(CacheConfig (object or null))

Configure cache handling

Responses

Request samples

Content type
application/json
{
  • "source": {
    },
  • "destinations": [
    ],
  • "circumstance": {
    },
  • "cache": {
    }
}

Response samples

Content type
application/json
{
  • "backendRoadNetVersion": "string",
  • "apiRoadNetVersion": "string",
  • "source": {
    },
  • "circumstance": {
    },
  • "answers": [
    ]
}

Trace

Calculate trace

Authorizations:
Basic
query Parameters
roadNetId
required
string or null
Default: "DK"
Request Body schema: application/json
required
(Coordinate (object or null))

A required source for the calculation

(Coordinate (object or null))

The destination for the calculation

(Circumstance (object or null))

The circumstances of the calculations, optional

(CacheConfig (object or null))

Configure cache handling

Responses

Request samples

Content type
application/json
{
  • "source": {
    },
  • "destination": {
    },
  • "circumstance": {
    },
  • "cache": {
    }
}

Response samples

Content type
application/json
{
  • "backendRoadNetVersion": "string",
  • "apiRoadNetVersion": "string",
  • "source": {
    },
  • "circumstance": {
    },
  • "answer": {
    }
}

Traces

Calculate multiple traces

Authorizations:
Basic
query Parameters
roadNetId
required
string or null
Default: "DK"
Request Body schema: application/json
required
Array of objects or null (CoordinatePair)

A required source for the calculation

(Circumstance (object or null))

The circumstances of the calculations, optional

(CacheConfig (object or null))

Configure cache handling

Responses

Request samples

Content type
application/json
{
  • "coordinatePairs": [
    ],
  • "circumstance": {
    },
  • "cache": {
    }
}

Response samples

Content type
application/json
{
  • "traces": [
    ],
  • "circumstance": {
    },
  • "apiRoadNetVersion": "string"
}

Available roadNets

Returns a list of all available roadNets. Returned roadNetId can be passed to other endpoints, like trace, distance, binary.

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]