API docs by Redocly

Mobidrom API (1.1.0)

Download OpenAPI specification:

Provides car park IDs, detailed car park data and paginated records within the configured Nordrhein-Westfalen scope. Production requests require the supplied mTLS client certificate.

Use GET /carpark-publicids to discover persistent public UUIDs, then GET /carpark-data?publicID=f09aa708-c5f8-4c47-829c-963746e58cda to retrieve details. UUIDs in this documentation are fictional examples; use authenticated discovery for actual values. Recommend publicID.value for publication and new external integrations.

Each detail and paginated record includes id (internal Global ID, public: false) and publicID (UUIDv4, public: true). Global IDs must not be published. Existing consumers can call carpark-data with their stored globalId to read the corresponding publicID.value. Global ID discovery and lookup remain supported permanently and are not deprecated.

Supply exactly one of globalId or publicID for detail lookup. Missing, both or malformed parameters return 400; unknown or ineligible identifiers return 404.

For pages, explicitly request GET /carparks?offset=0&limit=150 and follow pagination.nextOffset until null. The server default and maximum are 250; time and payload budgets may shorten a page. The dataset is live and changes can shift offsets between requests.

Get permanent public car park IDs

Returns the permanent UUIDv4 public IDs of all eligible car parks, ordered by their internal Global IDs. Public IDs are assigned centrally, remain unchanged across updates, and are safe to publish. Use public IDs for public-facing integrations and GET /carpark-data?publicID=; internal Global IDs must not be published. No query parameters are required.

Authorizations:
clientCertificate

Responses

Response samples

Content type
application/json
Example
[
  • "123e4567-e89b-42d3-a456-426614174000",
  • "6ba7b810-9dad-41d1-80b4-00c04fd430c8"
]

Get car park IDs

Returns the internal Global IDs of eligible car parks in the configured scope. This endpoint remains supported permanently, with its existing JSON array format. Global IDs must not be published; use carpark-publicids for public integrations. No query parameters are required.

Authorizations:
clientCertificate

Responses

Response samples

Content type
application/json
Example
[
  • "de-example-001",
  • "de-example-002",
  • "de-example-003"
]

Get paginated car park data

Returns complete details for eligible car parks, sorted by Global ID. Clients should explicitly request limit=150 to leave more execution-time headroom. Omitting limit still defaults to up to 250 items. Time and payload budgets can shorten a page: always continue using nextOffset, never offset + limit. The dataset is live, not a snapshot; insertions or deletions between requests can shift offsets. Every record includes id (internal Global ID, public: false) and publicID (persistent public UUIDv4, public: true). Recommend publicID.value for publication and external integrations. Global IDs remain supported permanently, are internal and must not be published.

Authorizations:
clientCertificate
query Parameters
offset
integer [ 0 .. 9007199254740991 ]
Default: 0
limit
integer [ 1 .. 250 ]
Default: 250
Example: limit=150

Recommended client page size: 150. The server default and maximum remain 250. Pages may still be shortened by time or payload budgets.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get car park data

Returns comprehensive data for a specific car park, including basic information, gates, dimensions, operations, opening hours, parking spots, charging stations, tags, and consumer management details. Supply exactly one of globalId or publicID. Missing, both, malformed or unknown parameters return 400. An unknown or ineligible identifier returns 404. Both lookup methods return identical data containing id (internal Global ID, public: false) and publicID (persistent UUIDv4, public: true). Existing consumers can use globalId lookup to map their stored IDs to publicID.value. Global ID remains supported permanently.

Authorizations:
clientCertificate
query Parameters
globalId
string [ 1 .. 128 ] characters
Example: globalId=de-example-001

Internal Global ID. Supply exactly one of globalId or publicID. Global ID lookup remains supported permanently; do not publish this identifier.

publicID
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3...
Example: publicID=f09aa708-c5f8-4c47-829c-963746e58cda

Persistent public UUIDv4 from carpark-publicids, recommended for new integrations and publication. Supply exactly one of publicID or globalId.

Responses

Response samples

Content type
application/json
{
  • "id": {
    },
  • "publicID": {
    },
  • "type": {
    },
  • "namePublicDE": {
    },
  • "namePublicEN": {
    },
  • "gates": [
    ],
  • "dimensions": {
    },
  • "operations": {
    },
  • "generalInformation": {
    },
  • "station": {
    },
  • "bahnPark": {
    },
  • "openingHours": {
    },
  • "parkingSpots": {
    },
  • "chargingStations": {
    },
  • "tags": {
    },
  • "consumerManagement": {
    }
}