Mount Management API (1.0.0)

API for managing mounts and associated entities

Download OpenAPI description

obh-mobility.json

obh-mobility.yaml

Servers

Mock server

https://docs.obh-mobility.com/_mock/api-definitions/obh-mobility/

http://localhost:3000/dev/api/v1/

https://api.dev.obh-mobility.com:3000/dev/api/v1/

https://api.staging.obh-mobility.com:3000/dev/api/v1/

Accounts

Operations

Mounts

Operations

Firmware

Operations

Get all available firmware versions

Request

This operation will return a list of all firmware versions available. Versions are sorted by the availableSince date in descending order.

Query

currentPageinteger

Page number. Starts at 1.

Default 1

pageSizeinteger

Number of elements per page

Default 10

curl -i -X GET \
  'https://docs.obh-mobility.com/_mock/api-definitions/obh-mobility/firmware/versions?currentPage=1&pageSize=10' \
  -H 'Access-Key: YOUR_API_KEY_HERE'

Responses

List of all firmware versions

Bodyapplication/json

versionsArray of objects(FirmwareVersion)

Example: [[{"softwareRevision":"0.99.3","modelNumber":"52832-OP","availableSince":"2023-12-12T17:24:43.000Z","deprecated":false},{"softwareRevision":"0.99.2","modelNumber":"52832-OP","availableSince":"2021-06-12T17:24:43.000Z","deprecated":true},{"softwareRevision":"0.99.5","modelNumber":"53840-CO","availableSince":"2021-06-12T17:24:43.000Z","deprecated":false}]]

paginationobject

Response

application/json

{
  "versions": [
    [ … ]
  ],
  "pagination": {
    "currentPage": 0,
    "pageSize": 0,
    "totalItems": 0,
    "totalPages": 0
  }
}

Check if a firmware update is available

Request

This operation will check if a firmware update is available for the given version.

Query

softwareRevisionstring

modelNumberstringrequired

curl -i -X GET \
  'https://docs.obh-mobility.com/_mock/api-definitions/obh-mobility/firmware/check-update?modelNumber=string&softwareRevision=string' \
  -H 'Access-Key: YOUR_API_KEY_HERE'

Responses

Firmware update check successful

Bodyapplication/json

codestring

Result code of the firmware update check

Enum"UP_TO_DATE""UPDATE_AVAILABLE""MANDATORY_UPDATE"

versionobject(FirmwareVersion)

Example: [{"softwareRevision":"0.99.3","modelNumber":"52832-OP","availableSince":"2023-12-12T17:24:43.000Z","deprecated":false},{"softwareRevision":"0.99.2","modelNumber":"52832-OP","availableSince":"2021-06-12T17:24:43.000Z","deprecated":true},{"softwareRevision":"0.99.5","modelNumber":"53840-CO","availableSince":"2021-06-12T17:24:43.000Z","deprecated":false}]

Response

application/json

[
  {
    "code": "UP_TO_DATE"
  },
  {
    "code": "UPDATE_AVAILABLE",
    "version": { … }
  },
  {
    "code": "MANDATORY_UPDATE",
    "version": { … }
  }
]

Download a specific firmware version

Request

This operation will return a binary file of the specified firmware version. If no version is given, the latest version will be downloaded.

Query

softwareRevisionstring

modelNumberstringrequired

curl -i -X GET \
  'https://docs.obh-mobility.com/_mock/api-definitions/obh-mobility/firmware/download?modelNumber=string&softwareRevision=string' \
  -H 'Access-Key: YOUR_API_KEY_HERE'

Responses

Firmware download link

Bodyapplication/json

versionobject(FirmwareVersion)

downloadLinkstring

Download link for the firmware

expiresAtstring(date-time)

Expiration date and time for the download link

Response

application/json

[
  {
    "version": { … },
    "downloadLink": "https://someObjectStorage?authKey=temporaryKey",
    "expiresAt": "2023-12-12T17:24:43.000Z"
  }
]

NfcTags

Operations

Mount Management API (1.0.0)

Accounts

Mounts

Firmware

Get all available firmware versions

Request

Responses

Was this helpful?

Check if a firmware update is available

Request

Responses

Was this helpful?

Download a specific firmware version

Request

Responses

Was this helpful?

NfcTags