Administration

Lookups

The lookups operations of the Core API.

Base URL: https://api.miridia.io. Read Authentication and Conventions before you call these operations.

Method	Path	Operation
GET	`/api/lookups/license-types`	Get license types

Get license types

GET/api/lookups/license-types

Returns every license type. Filters to one country when countryCode is supplied.

Access. Send a bearer token or an API key. The caller needs the Vehicles view permission.

Parameters

Name	In	Type	Required	Description
`countryCode`	query	`enum CountryCode`	No	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.

Response

200. Returns a JSON array. Each item is LicenseTypeResponse.

Request

curl -X GET "https://api.miridia.io/api/lookups/license-types" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

[
  {
    "id": 0,
    "name": "string",
    "countryCodeId": "Global"
  }
]

Models

The operations on this page use these object types. Select a type to see its fields.

LicenseTypeResponse

Field	Type	Description
`id`	`integer (int32)`
`name`	`string`
`countryCodeId`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.

Files

The files operations of the Core API.

Addresses

The addresses operations of the Core API.