Mount Management API (1.0.0)

API for managing mounts and associated entities

Download OpenAPI description
Languages
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

NfcTags

Operations

Get NFC tags

Request

This operation will return a list of all NFC tags.

Query
currentPageinteger

Page number of the NFC tags listing. Starts at 1.

Default 1
pageSizeinteger

Number of NFC tags per page

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

Responses

List of all NFC tags with pagination

Bodyapplication/json
tagsArray of objects(NfcTag)
paginationobject
Response
application/json
{ "tags": [ {} ], "pagination": { "currentPage": 0, "pageSize": 0, "totalItems": 0, "totalPages": 0 } }

Synchronize NFC tags

Request

This operation will synchronize NFC tags with the given mount.

Bodyapplication/jsonrequired
tagUidsArray of stringsrequired
mountUidstringrequired
curl -i -X POST \
  https://docs.obh-mobility.com/_mock/api-definitions/obh-mobility/nfc-tags \
  -H 'Access-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tagUids": [
      "string"
    ],
    "mountUid": "string"
  }'

Responses

NFC tags synchronized successfully

Update an NFC tag

Request

This operation will update the details of the NFC tag with the given UID.

Path
uidstringrequired
Bodyapplication/jsonrequired
namestring

Human readable name of the NFC tag

colorstring

color of the NFC tag

iconNamestring

Icon name of the NFC tag

curl -i -X PATCH \
  'https://docs.obh-mobility.com/_mock/api-definitions/obh-mobility/nfc-tags/{uid}' \
  -H 'Access-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "color": "string",
    "iconName": "string"
  }'

Responses

NFC tag updated successfully