Introduction

The System API enables users, developers and services to manage System settings and configurations.

It offers a streamlined interface for modifying the details of system, ensuring accurate system configurations

Bitbucket Controller

Bitbucket controller for handling new pull request.

Create new pull request

curl "API_BASE/v1/bitbucket/new_pull_request"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Creates the new pull request by fetching the tasks from the database

HTTP Request

POST /v1/bitbucket/new_pull_request

{
    "repository": {
        "name": ""
    },
    "pullrequest": {
        "id": 0
    }
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
repository	struct { Name string "json:\"name\" desc:\"Name of the repository\"" }	true	Repository
pullrequest	struct { ID int "json:\"id\" desc:\"ID of the pull request\"" }	true	Pull request

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Device Controller

Device controller for listing all the devices, os versions, models, user's devices in use. Updating user of the device in use, lease of the device.

List models

curl "API_BASE/v1/devices/models/list"
    -H "Authorization: Bearer $token"

This endpoint list the models of all the tablets used by the mechanics.

HTTP Request

GET /v1/devices/models/list

{
    "models": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
models	[]string

List OS Versions

curl "API_BASE/v1/devices/os_versions/list"
    -H "Authorization: Bearer $token"

This endpoint list the os versions of all the tables used by the mechanics.

HTTP Request

GET /v1/devices/os_versions/list

{
    "os_versions": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
os_versions	[]string

Update lease status of the tablet

curl "API_BASE/v1/devices/lease/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint can be used to set a tablet as a lease tablet or a non-lease tablet. It sets the status as per the provided values.

HTTP Request

POST /v1/devices/lease/update

{
    "device_id": 0,
    "is_leased": false
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
device_id	DeviceID	true	Device identifier
is_leased	bool	true	If true, it is a leased device else not

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Find tablets by user identifier

curl "API_BASE/v1/devices/find_by_user"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint list all the tablets by the user identifier.

HTTP Request

POST /v1/devices/find_by_user

{
    "user_id": 0
}

{
    "devices": []
}

Request schema

Parameter	Type	Required	Description
user_id	UserID	true	User Identifier

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
devices	[]model.Device

Save the mechanic tablet configuration

curl "API_BASE/v1/devices/save"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint save the model, os versions, brand and free space for a mechanic tablet. If the tablet is new, then it creates the new device in the database.

HTTP Request

POST /v1/devices/save

{
    "mac_address": "",
    "os_version": "",
    "brand": "",
    "model": "",
    "free_space": ""
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
mac_address	string	true	MAC address of the device
os_version	string	true	OS version of the device
brand	string	true	Brand of the device
model	string	true	Model of the device
free_space	string	true	Free space on the device

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Find the tablet

curl "API_BASE/v1/devices/find_by_id"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint provides details of the tablet by the device id.

HTTP Request

POST /v1/devices/find_by_id

{
    "id": 0
}

{
    "created_on": "0001-01-01T00:00:00Z",
    "updated_on": "0001-01-01T00:00:00Z",
    "id": 0,
    "mac_address": "",
    "os_version": "",
    "brand": "",
    "model": "",
    "free_space": "",
    "is_leased": false,
    "last_used": "0001-01-01T00:00:00Z",
    "current_user": {
        "created_on": "0001-01-01T00:00:00Z",
        "updated_on": "0001-01-01T00:00:00Z",
        "id": 0,
        "dms_nr": null,
        "first_name": "",
        "last_name": "",
        "email": "",
        "username": "",
        "mobile": "",
        "phone": "",
        "birthday": null,
        "last_active": null,
        "address1": "",
        "address2": "",
        "channel_token": "",
        "client_id": "",
        "last_password_change": null,
        "google_id": "",
        "status": 0,
        "web_version": "",
        "app_version": "",
        "camera_version": "",
        "location_column_visible": false,
        "multi_device_login_enabled": false,
        "is_combi_user": false,
        "list_appointments_by_scheduled_range": false,
        "csv_download": false,
        "profile_picture": "",
        "language_code": "",
        "dealer_id": 0,
        "dealer_location_id": 0,
        "role_id": 0,
        "zoho_id": "",
        "landing_page_id": 0,
        "is_counter_tablet_user": false,
        "is_keylocker_allowed": false,
        "is_available": false,
        "pin_status_notification_enabled": false,
        "tyre_ordering_enabled": false,
        "shop_status_same_day_filter_enabled": false,
        "shop_status_next_day_filter_enabled": false,
        "shop_status_to_order_filter_enabled": false,
        "shop_status_backorder_filter_enabled": false,
        "shop_status_arrived_parts_filter_enabled": false,
        "working_on": null,
        "my_locations": [],
        "dealers": [],
        "dealers_ids": [],
        "location_ids": [],
        "dealer_location": null,
        "device_id": null,
        "counter_tablet_key": "",
        "role_name": "",
        "dpo": false,
        "acl": [],
        "brands": [],
        "onei_planning_monteur_id": null,
        "planit_planning_mechanic_id": null,
        "notification_element_ids": [],
        "dealer_name": null,
        "location_name": null,
        "appointment_id": 0
    },
    "current_user_id": 0,
    "user_history": [],
    "dealer_location_id": null
}

Request schema

Parameter	Type	Required	Description
id	DeviceID	true	Device identifier

Response schema

This endpoint return an object of type Device, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

List brands

curl "API_BASE/v1/devices/brands/list"
    -H "Authorization: Bearer $token"

This endpoint list the brands of all the tables used by the mechanics.

HTTP Request

GET /v1/devices/brands/list

{
    "brands": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
brands	[]string

List Tablets

curl "API_BASE/v1/devices/list"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint list the mechanic tablets. This list can be filtered based on the brands, os versions, models, dealer locations, dealers or search terms. This list is in paginated form.

HTTP Request

POST /v1/devices/list

{
    "page": 0,
    "page_size": 0,
    "search_term": "",
    "brands": [],
    "dealer_location_ids": [],
    "dealer_ids": [],
    "os_versions": [],
    "models": [],
    "order_by": 0
}

{
    "items": [],
    "nb_pages": 0,
    "nb_items": 0
}

Request schema

Parameter	Type	Required	Description
page	int	true	Page number
page_size	int	true	Amount of items per page
search_term	string	true	Search term
brands	[]string	true	List of brands
dealer_location_ids	[]model.DealerLocationID	true	List of dealer location identifier
dealer_ids	[]model.DealerID	true	List of dealer identifier
os_versions	[]string	true	List of OS versions
models	[]string	true	List of models
order_by	transport.DeviceListOrderBy	true	Order the list by attribute

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
items	[]model.Device
nb_pages	int
nb_items	int

Export the list of tablets

curl "API_BASE/v1/devices/export"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint export the list of the mechanic tablets in CSV file. This exported data can be filtered based on the brands, os versions, models, dealer locations, dealers or search terms. This endpoint returns an url to download the exported csv file.

HTTP Request

POST /v1/devices/export

{
    "page": 0,
    "search_term": "",
    "brands": [],
    "dealer_location_ids": [],
    "dealer_ids": [],
    "os_versions": [],
    "models": [],
    "order_by": 0
}

{
    "url": ""
}

Request schema

Parameter	Type	Required	Description
page	int	true	Page number
search_term	string	true	Search term
brands	[]string	true	List of brands
dealer_location_ids	[]model.DealerLocationID	true	List of dealer location identifier
dealer_ids	[]model.DealerID	true	List of dealer identifier
os_versions	[]string	true	List of OS versions
models	[]string	true	List of models
order_by	transport.DeviceListOrderBy	true	Order the list by attribute

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
url	string

Languages

List available languages

curl "API_BASE/v1/languages/list"
    -H "Authorization: Bearer $token"

Lists the languages that are available in the system

HTTP Request

GET /v1/languages/list

{
    "languages": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
languages	[]model.Language

Settings Controller

Settings controller for handling settings and versions.

Current version

curl "API_BASE/v1/settings/versions/current"
    -H "Authorization: Bearer $token"

Returns Current version of the app

HTTP Request

GET /v1/settings/versions/current

{
    "created_on": "0001-01-01T00:00:00Z",
    "updated_on": "0001-01-01T00:00:00Z",
    "id": 0,
    "label": "",
    "minimum_label": "",
    "remarks": ""
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object of type AppVersion, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Current camera app version

curl "API_BASE/v1/settings/versions/camera/current"
    -H "Authorization: Bearer $token"

Returns the current camera app version

HTTP Request

GET /v1/settings/versions/camera/current

{
    "current_camera_app_version": null
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
current_camera_app_version	model.CameraAppVersion

List settings

curl "API_BASE/v1/settings/find"
    -H "Authorization: Bearer $token"

List all the available settings

HTTP Request

GET /v1/settings/find

{
    "settings": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
settings	[]model.Settings

Create Setting

curl "API_BASE/v1/settings/create"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Create setting from given url, name and locale

HTTP Request

POST /v1/settings/create

{
    "url": "",
    "name": "",
    "locale": ""
}

{
    "settings": null
}

Request schema

Parameter	Type	Required	Description
url	string	true	Url of the setting
name	string	true	Name of the setting
locale	string	true	locale of the setting

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
settings	model.Settings

Current version

curl "API_BASE/v1/settings/current_version"
    -H "Authorization: Bearer $token"

Returns Current version of the app

HTTP Request

GET /v1/settings/current_version

{
    "created_on": "0001-01-01T00:00:00Z",
    "updated_on": "0001-01-01T00:00:00Z",
    "id": 0,
    "label": "",
    "minimum_label": "",
    "remarks": ""
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object of type AppVersion, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Add version

curl "API_BASE/v1/settings/versions/add"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Add new version with the given label

HTTP Request

POST /v1/settings/versions/add

{
    "label": "",
    "remarks": "",
    "minimum_label": ""
}

{
    "app_version": null
}

Request schema

Parameter	Type	Required	Description
label	string	true	Label for the version to add
remarks	string	true	Remarks for the version
minimum_label	string	true	Minimum label of the version

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
app_version	model.AppVersion

List camera app versions

curl "API_BASE/v1/settings/versions/camera/list"
    -H "Authorization: Bearer $token"

List the camera app versions that are available

HTTP Request

GET /v1/settings/versions/camera/list

{
    "camera_app_versions": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
camera_app_versions	[]model.CameraAppVersion

Current camera app version

curl "API_BASE/v1/settings/current_camera_version"
    -H "Authorization: Bearer $token"

Returns the current camera app version

HTTP Request

GET /v1/settings/current_camera_version

{
    "current_camera_app_version": null
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
current_camera_app_version	model.CameraAppVersion

Add camera version

curl "API_BASE/v1/settings/versions/camera/add"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Add new camera version provided label

HTTP Request

POST /v1/settings/versions/camera/add

{
    "label": "",
    "remarks": "",
    "minimum_label": ""
}

{
    "camera_app_version": null
}

Request schema

Parameter	Type	Required	Description
label	string	true	Label of the camera version
remarks	string	true	Remarks of the camera version
minimum_label	string	true	Minimum label of the camera version

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
camera_app_version	model.CameraAppVersion

Update Setting

curl "API_BASE/v1/settings/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Update the setting having provided setting identifier

HTTP Request

POST /v1/settings/update

{
    "id": 0,
    "url": "",
    "name": "",
    "locale": ""
}

{
    "settings": null
}

Request schema

Parameter	Type	Required	Description
id	int64	true	Identifier of the setting
CreateSettingsReq	transport.CreateSettingsReq	true

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
settings	model.Settings

List versions

curl "API_BASE/v1/settings/versions/list"
    -H "Authorization: Bearer $token"

List the app versions that are available

HTTP Request

GET /v1/settings/versions/list

{
    "app_versions": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
app_versions	[]model.AppVersion

Support Controller

Support controller for handling network metrics and location logs.

List the network metrics

curl "API_BASE/v1/support/list"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

List the network metrics for the user using the user_id provided

HTTP Request

POST /v1/support/list

{
    "user_id": null
}

{
    "network_metrics": []
}

Request schema

Parameter	Type	Required	Description
user_id	model.UserID	false	User identifier to get list of network metrics

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
network_metrics	[]model.NetworkMetrics

Add network metrics

curl "API_BASE/v1/support/network_metrics"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Add the network metrics with ping_claire, ping_outside, delay_claire, delay_outside, wifi_strength, wifi_name

HTTP Request

POST /v1/support/network_metrics

{
    "ping_claire": 0,
    "ping_outside": 0,
    "delay_claire": 0,
    "delay_outside": 0,
    "wifi_strength": 0,
    "wifi_name": ""
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
ping_claire	float32	true	Ping for claire
ping_outside	float32	true	Ping for outside
delay_claire	float32	true	Delay from claire
delay_outside	float32	true	Delay from outside
wifi_strength	float32	true	Network strength of wifi
wifi_name	string	true	Name of the wifi network

Response schema

This endpoint do not return anything, only the HTTP status code matters.

List import logs for location

curl "API_BASE/v1/support/import_location_logs"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

List import the logs for the location_id provided

HTTP Request

POST /v1/support/import_location_logs

{
    "location_id": 0
}

{
    "import_logs": []
}

Request schema

Parameter	Type	Required	Description
location_id	DealerLocationID	true	Location id for the dealer

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
import_logs	[]model.LoggedAppointment

Parameter	Type
tags	[]model.Tag

Parameter	Type	Required	Description
color	string	true	Color of the tag
name	string	true	Name of the tag
system	bool	true	Specify it a system tag

Parameter	Type
tag_id	TagID

Parameter	Type	Required	Description
tags	[]model.Tag	true	List of tags to update

Parameter	Type	Required	Description
id	TagID	true	Identifier of the tag to delete

Translations

Update the translations

curl "API_BASE/v1/translations/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Update the translations from the given translations array for every translation in it with key and language

HTTP Request

POST /v1/translations/update

{
    "translations": []
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
translations	[]model.Translation	true	List of translation objects

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Delete the translation

curl "API_BASE/v1/translations/delete"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Delete the translation with the key provided

HTTP Request

POST /v1/translations/delete

{
    "key": ""
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
key	string	true	Language key to delete its translations

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Generate migration

curl "API_BASE/v1/translations/generate_migration"
    -H "Authorization: Bearer $token"

Generate the migration to apply the changes in dev to production

HTTP Request

GET /v1/translations/generate_migration

[
    0
]

Request schema

This request does not accept any parameters.

Response schema

This endpoint returns a binary

Export the missing translations

curl "API_BASE/v1/translations/export_missing_translations"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint export the missing translations for the provided language code

HTTP Request

POST /v1/translations/export_missing_translations

{
    "language_code": ""
}

{
    "url": ""
}

Request schema

Parameter	Type	Required	Description
language_code	LanguageCode	true	Language code to fetch the missing translations

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
url	string

Import the missing translations

curl "API_BASE/v1/translations/import_missing_translations"
    -H "Authorization: Bearer $token"
    -H "Content-Type: multipart/form-data"

This endpoint imports the missing translations from the uploaded file

HTTP MultiPart Request

POST /v1/translations/import_missing_translations

--XXX
Content-Disposition: form-data; name=

...
--XXX
Content-Disposition: form-data; name=

...--XXX--

This endpoint do not return anything, only the HTTP status code matters.

This request must be a multipart/form-data content-type with valid boundary for each part

Request parts schema

Parameter	Type	Required	Description
language_code	LanguageCode	true	Language code of the missing translations
file	http.FormFile	true	File to read the missing translations

Response schema

This endpoint do not return anything, only the HTTP status code matters.

List the translations

curl "API_BASE/v1/translations/list"
    -H "Authorization: Bearer $token"

List the translations with actual text, translated text along with the language in which its translated

HTTP Request

GET /v1/translations/list

{
    "translations": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
translations	[]model.Translation

List the translations of a language code

curl "API_BASE/v1/translations/list_by_language_id"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

List the translations with actual text as key and translated text as value for the provided language code

HTTP Request

POST /v1/translations/list_by_language_id

{
    "language_code": ""
}

{
    "translations": null
}

Request schema

Parameter	Type	Required	Description
language_code	string	true	Lanugage code to fetch the translations specific to the language

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
translations	map[string]map[string]string

Create the translations

curl "API_BASE/v1/translations/create"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Create the translations from the given translations array

HTTP Request

POST /v1/translations/create

{
    "translations": []
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
translations	[]model.Translation	true	List of translation objects

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Users

Create User

curl "API_BASE/v1/users/create"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint creates a user in claire with the details provided.

HTTP Request

POST /v1/users/create

{
    "password": ""
}

{
    "user_id": 0
}

Request schema

Parameter	Type	Required	Description
User	model.User	false
password	string	true	Password of user

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
user_id	UserID

List users by dealer id

curl "API_BASE/v1/users/list"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint returns a list of all the users for the dealer.

HTTP Request

POST /v1/users/list

{
    "dealer_id": null
}

{
    "users": []
}

Request schema

Parameter	Type	Required	Description
dealer_id	model.DealerID	false	Dealer Identifier

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
users	[]model.User

List users by dealer location id

curl "API_BASE/v1/users/list_by_location"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint returns a list of all the users for the provided dealer location id.

HTTP Request

POST /v1/users/list_by_location

{
    "dealer_location_id": 0
}

{
    "users": []
}

Request schema

Parameter	Type	Required	Description
dealer_location_id	DealerLocationID	true	Dealer location identifier

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
users	[]model.User

List PlanIt mechanic

curl "API_BASE/v1/users/pairing/planit/list"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint lists all the planit planning mechanics for a dealer location.

HTTP Request

POST /v1/users/pairing/planit/list

{
    "dealer_location_id": 0
}

{
    "planit_planning_mechanics": []
}

Request schema

Parameter	Type	Required	Description
dealer_location_id	DealerLocationID	true	Dealer location identifier

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
planit_planning_mechanics	[]model.PlanItPlanningMechanic

Update OneI pairing for users

curl "API_BASE/v1/users/pairing/onei/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint pairs the users with onei planning monteur identifiers. The list of monteurs containing user identifier and onei monteur identifier is provided in the request payload.

HTTP Request

POST /v1/users/pairing/onei/update

{
    "onei_planning_monteurs": []
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
onei_planning_monteurs	[]model.OneiPlanningMonteur	true	List of Onei Planning Monteurs

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Upload Profile Picture

curl "API_BASE/v1/users/profile_picture/upload"
    -H "Authorization: Bearer $token"
    -H "Content-Type: multipart/form-data"

This endpoints upload the user profile picture and returns the url.

HTTP MultiPart Request

POST /v1/users/profile_picture/upload

--XXX
Content-Disposition: form-data; name=

...
--XXX
Content-Disposition: form-data; name=

...--XXX--

{
    "url": ""
}

This request must be a multipart/form-data content-type with valid boundary for each part

Request parts schema

Parameter	Type	Required	Description
path	string	true	Path of the profile picture in the cloud storage bucket
file	http.FormFile	true	File to be uploaded

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
url	string

Update Language

curl "API_BASE/v1/users/language/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint updates the default language of the user. It is used by the tablet app. The language code needs to be valid.

HTTP Request

POST /v1/users/language/update

{
    "language_code": ""
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
language_code	LanguageCode	true	The language code that needs to be set as default for the user.

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Search User

curl "API_BASE/v1/users/search"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint returns the list of the users matching the search terms provided in the request payload.

HTTP Request

POST /v1/users/search

{
    "dealer_id": 0,
    "term": "",
    "limit": 0,
    "page": 0,
    "page_size": 0,
    "status": 0,
    "roles": [],
    "web_versions": [],
    "camera_versions": [],
    "mobile_versions": [],
    "active_date_from": null,
    "active_date_to": null,
    "is_combi_user": null
}

{
    "users": []
}

Request schema

Parameter	Type	Required	Description
dealer_id	DealerID	true	Dealer identifier
term	string	true	Search term like first name, last name, email id etc.
limit	int	true	Number of results per page
page	int	true	Page number
page_size	int	true	Amount of items per page
status	UserStatusID	true	Status of user. It can be user is active, inactive, deleted or archived.
roles	[]model.RoleID	true	List of roles e.g. receptionist, mechanic, manufacturer etc.
web_versions	[]string	true	List of web version which user is using
camera_versions	[]string	true	List of the camera app version on the mechanic tablet
mobile_versions	[]string	true	List of the version of the claire app running on the tablet
active_date_from	time.Time	false	Date from which the user is active
active_date_to	time.Time	false	Date to which the user was active
is_combi_user	bool	false	If the users are combi users. It can be true (retrieve only combi users), false (retrieve only non combi users) or nil (retrieve all users)

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
users	[]model.User

Update user

curl "API_BASE/v1/users/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint can be used to update the user attributes.

HTTP Request

POST /v1/users/update

{
    "password": null
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
User	model.User	false
password	string	false	New Password

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Update DMS pairing for users

curl "API_BASE/v1/users/pairing/dms/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint pairs the users with the DMS user identifiers. The list of the dms users containing user identifier and dms user identifier is provided in the request payload.

HTTP Request

POST /v1/users/pairing/dms/update

{
    "dms_users": []
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
dms_users	[]model.DMSUser	true	List of DMS users

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Reinstate User

curl "API_BASE/v1/users/reinstate"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint reinstate the user status from deleted, inactive or archived. Only Admin roles i.e. Super, Claire, Support and Dealer Admins can perform this action.

HTTP Request

POST /v1/users/reinstate

{
    "user_id": 0
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
user_id	UserID	true	Identifier of the user which will be reinstated

Response schema

This endpoint do not return anything, only the HTTP status code matters.

List admins

curl "API_BASE/v1/users/admins/list"
    -H "Authorization: Bearer $token"

This endpoint returns a list of the users who has admin role.

HTTP Request

GET /v1/users/admins/list

{
    "users": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
users	[]model.User

List Onei planning monteur

curl "API_BASE/v1/users/pairing/onei/list"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint lists all the onei planning monteur for a dealer location.

HTTP Request

POST /v1/users/pairing/onei/list

{
    "dealer_location_id": 0
}

{
    "onei_planning_monteurs": []
}

Request schema

Parameter	Type	Required	Description
dealer_location_id	DealerLocationID	true	Dealer location identifier

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
onei_planning_monteurs	[]model.OneiPlanningMonteur

List notification elements

curl "API_BASE/v1/users/notification_elements/list"
    -H "Authorization: Bearer $token"

This endpoint lists all the notification elements.

HTTP Request

GET /v1/users/notification_elements/list

{
    "notification_elements": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
notification_elements	[]model.NotificationElement

List DMS users

curl "API_BASE/v1/users/dms/users/list"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint lists all the DMS users for a dealer location.

HTTP Request

POST /v1/users/dms/users/list

{
    "dealer_location_id": 0
}

{
    "dms_users": []
}

Request schema

Parameter	Type	Required	Description
dealer_location_id	DealerLocationID	true	Dealer location identifier

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
dms_users	[]model.DMSUser

Update PlanIt pairing for users

curl "API_BASE/v1/users/pairing/planit/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint pairs the users with planit planing mechanic identifiers. The list of mechanics containing user identifier and planit mechanic identifier is provided in the request payload.

HTTP Request

POST /v1/users/pairing/planit/update

{
    "planit_planning_mechanics": []
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
planit_planning_mechanics	[]model.PlanItPlanningMechanic	true	List of PlanIt planning mechanics

Response schema

This endpoint do not return anything, only the HTTP status code matters.

List Landing Pages

curl "API_BASE/v1/users/landing_pages"
    -H "Authorization: Bearer $token"

This endpoint provides the list of the landing pages.

HTTP Request

GET /v1/users/landing_pages

{
    "landing_pages": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
landing_pages	[]model.LandingPage

Get details of the user

curl "API_BASE/v1/users/details"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoints provide the details of the user for the given user id.

HTTP Request

POST /v1/users/details

{
    "id": 0
}

{
    "created_on": "0001-01-01T00:00:00Z",
    "updated_on": "0001-01-01T00:00:00Z",
    "id": 0,
    "dms_nr": null,
    "first_name": "",
    "last_name": "",
    "email": "",
    "username": "",
    "mobile": "",
    "phone": "",
    "birthday": null,
    "last_active": null,
    "address1": "",
    "address2": "",
    "channel_token": "",
    "client_id": "",
    "last_password_change": null,
    "google_id": "",
    "status": 0,
    "web_version": "",
    "app_version": "",
    "camera_version": "",
    "location_column_visible": false,
    "multi_device_login_enabled": false,
    "is_combi_user": false,
    "list_appointments_by_scheduled_range": false,
    "csv_download": false,
    "profile_picture": "",
    "language_code": "",
    "dealer_id": 0,
    "dealer_location_id": 0,
    "role_id": 0,
    "zoho_id": "",
    "landing_page_id": 0,
    "is_counter_tablet_user": false,
    "is_keylocker_allowed": false,
    "is_available": false,
    "pin_status_notification_enabled": false,
    "tyre_ordering_enabled": false,
    "shop_status_same_day_filter_enabled": false,
    "shop_status_next_day_filter_enabled": false,
    "shop_status_to_order_filter_enabled": false,
    "shop_status_backorder_filter_enabled": false,
    "shop_status_arrived_parts_filter_enabled": false,
    "working_on": null,
    "my_locations": [],
    "dealers": [],
    "dealers_ids": [],
    "location_ids": [],
    "dealer_location": null,
    "device_id": null,
    "counter_tablet_key": "",
    "role_name": "",
    "dpo": false,
    "acl": [],
    "brands": [],
    "onei_planning_monteur_id": null,
    "planit_planning_mechanic_id": null,
    "notification_element_ids": [],
    "dealer_name": null,
    "location_name": null,
    "appointment_id": 0
}

Request schema

Parameter	Type	Required	Description
id	UserID	true	User identifier

Response schema

This endpoint return an object of type User, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Delete user

curl "API_BASE/v1/users/delete"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint deletes the user from claire.

HTTP Request

POST /v1/users/delete

{
    "id": 0
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
id	UserID	true	User identifier which needs to be deleted

Response schema

This endpoint do not return anything, only the HTTP status code matters.

List versions

curl "API_BASE/v1/users/versions/list"
    -H "Authorization: Bearer $token"

This endpoint list the web, app and camera app versions.

HTTP Request

GET /v1/users/versions/list

{
    "web_versions": [],
    "app_versions": [],
    "camera_versions": []
}

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
web_versions	[]string
app_versions	[]string
camera_versions	[]string

Update Account

curl "API_BASE/v1/users/account/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint can be used to update the user account attributes like mobile, phone, profile picture, is the location column visible setting, default landing page, provide access or revoke it for the counter tablet, options to set appointments by schedule range, language code, notification elements, filter options and locations.

HTTP Request

POST /v1/users/account/update

{}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
User	model.User	false

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Update User Location

curl "API_BASE/v1/users/location/update"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint updates the user's default location, the user needs to have access of the dealer and its location.'

HTTP Request

POST /v1/users/location/update

{
    "location_id": 0
}

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Parameter	Type	Required	Description
location_id	DealerLocationID	true	Dealer Location Identifier

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Get strength of the user password

curl "API_BASE/v1/users/password/strength"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

This endpoint returns the strength of the password, it takes username, firstname, lastname, email and password as input to calculate the strength of the password.

HTTP Request

POST /v1/users/password/strength

{
    "username": null,
    "firstname": null,
    "lastname": null,
    "email": null,
    "password": ""
}

{
    "strength": 0
}

Request schema

Parameter	Type	Required	Description
username	string	false	The username for which the password strength needs to be evaluated.
firstname	string	false	The first name for which the password strength needs to be evaluated.
lastname	string	false	The last name for which the password strength needs to be evaluated.
email	string	false	The email for which the password strength needs to be evaluated.
password	string	true	The password for which the password strength needs to be evaluated.

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Parameter	Type
strength	int

Models and Enumeration

BarCode Enumeration

Value	Description
1	Barcode Type 128
2	Barcode Type 93
3	Barcode Type 39
4	Barcode Type 25
5	Barcode Type 11

ChecklistType Enumeration

Value	Description
0	Regular checklist
1	Initial checklist done by receptionists
2	Quality control checklist
3	Auxilary checklist
4	Extra parts checklist, i.e. fluids list
5	This Checklist Type is deprecated and will be repurposed by a new Checklist Type
6	Test Drive checklist can be started at any time and do no change the appointment status
7	Checklist is of warranty type

DMSID Enumeration

Value	Description
1	Default value for location who do not have a DMS set yet
2	NTCAR
3	EVA
4	WINCAR, import limited information from WINCAR
5	ANONYMOUS EVA, import from EVA without personal data
6	AUTOLINE, import from AUTOLINE
7	AUTOLINE_EF_NEFKENS, import from AUTOLINE for holding Emil Frey, dealer Nefkens
8	TEST_API, import from a Claire test DMS, through scheduler, where data is autogenerated
9	TEST_SOW, import from a Claire test DMS, through sow, where data is autogenerated
10	INCADEA, import from Incadea
11	TRUCK_VISION, import from Truck Vision
12	ICAR_WO, import from ICAR
13	CARIT, import from Car IT from dealers that use a 3rd party planning tool
14	AUTOLINE_OPEL_MENU, import from AUTOLINE with Opel interventions
15	KEYLOOP_MENUS, import from Keyloop, use jobs contents as interventions
16	CUSTOM_QUERIES, dms id for running custom queries only, no import
17	KEYLOOP_JOBS, import from Keyloop, use jobs as interventions
18	AUTOLINE_EF_TERWOLDE, import from autoline for terwolde
19	ICAR_PLANNING, import from ICAR from dealers that use the dms planning
20	AUTOFLEX, import from AUTOFLEX
21	AUTOFLEX_QA_STAGING, import from AUTOFLEX' staging environment
22	NEXTLANE, import from NEXTLANE
23	WINCAR_API, import from WINCAR_API
24	EVA_BE, import from EVA BE

DeviceListOrderBy Enumeration

Value	Description
1	Order by last used in ascending order
2	Order by last used in descending order
3	Order by free space in ascending order
4	Order by free space in descending order

KeyLabel_Types Enumeration

Value	Description
1	This type shows Make, Model, Registration, VIN, WON#, Name of the user who provided the label and First and Last name of the owner, if none, driver then contractor
2	This type shows WO#, Registration, VIN and Owner name

LandingPageID Enumeration

Value	Description
1	Main page
2	Lead Dashboard
3	Warranty Dashboard
4	Manufacturer Dashboard
5	Dayplanner Dashboard

LanguageCode Enumeration

Value	Description
en-GB	English
nl-NL	Dutch
fr-FR	French
de-DE	German
th-FR	Thai-French

NoteTypeID Enumeration

Value	Description
1	Call customer appointment note
2	Remark pin note
3	Warranty pin note
4	Recall pin note
5	Parking note

NotificationEntityTemplateID Enumeration

Value	Description
1
1	check box type of entity template
2	dropdown with multiple type of entity template
2

QuestionElementTemplate Enumeration

Value	Description
dropdown	Dropdown
dropdown_multi	Multiple selection dropdown
solution_element	Solution element
textfield	Text field
number	Number field
textarea	Textarea
spinner	Spinner
datepicker	Date picker
tyre	Tyre element
panic	Panic element
testdrive_mileage	Test drive mileage element

QuestionOptionID Enumeration

Value	Description
1	Price option is enabled on the question
2	Snooze option is enabled on the question
3	Pin option is enabled on the question
4	Disable OK without note option on the question
5	Hide X button option on the question
6	Photo mandatory option on the question
7	Hide customer OK and convert to intervention option on the question

RoleID Enumeration

Value	Description
10	Top level user role (has all permissions)
20	Claire admin role
25	Support admin role, similar to claire admin but without deleting rights
30	Manage dealers attached to it
40	Manage a single dealer
50	Uses the dashboard and does aanname checks
55	Mechanic with access rights similar to receptionist
60	Does car checks
70	Allowed to use multiple locations for one dealer
80	Does quality controls
90	Perform leads, recall and warranty related tasks on allowed locations from one or more dealers
100	User by tablet on the counter of receptionists
110	Manufacturer are allowed to update certain data after their requests to access specific appointments are being granted

SMSGateway Enumeration

Value	Description
1	SMS Gateway is disabled
2	Chatshipper SMS Gateway
3	Twilio SMS Gateway

StatusIdentifier Enumeration

Value	Description
-1	The appointment has been cancelled
1	Initial status for a new appoitment
2	A car check is completed
3	Pricing calculation is done
4	Customer approved pricing
5	The car is ready
6	An car check is required, set by a receptionist
7	Initial check done by a receptionist
8	Receptionists are doing pricing calculations
9	The customer is being contacted to approve pricing
10	A car check has started
11	A quality check is completed
12	The customer answered through online communication
13	The appointment is delayed and is waiting on a back order
50	Not returned by the backend, shown if the receptionist need to handle the Online Check-in answer
51	Not returned by the backend, shown if the Online Check-in is answered and handled
52	Not returned by the backend, shown if the car is in the shop
53	Not returned by the backend, shown if repair overview was sent to customer for car ok status
54	Not returned by the backend, shown if repair overview was sent to customer for quality check status
55	Not returned by the backend, shown if the car is out of the shop

UserStatusID Enumeration

Value	Description
1	Active
2	Inactive

ACL Model

Field	Type	Description
ID	ACLID
Activity	string
Resource	string
Roles	Role

AnswerItem Model

Field	Type	Description
ID	AnswerItemID	Claire Answer Item ID
Encoded	string
Raw	string	Raw answer
Template	QuestionElementTemplate	Question's template answered
Order	int
QuestionResultID	QuestionResultID

AppVersion Model

Field	Type	Description
ID	AppVersionID
Label	string
MinimumLabel	string
Remarks	string

AppointmentStatus Model

Field	Type	Description
ID	AppointmentStatusID
Identifier	StatusIdentifier
Name	string
Icon	string
Color	string
Order	int
DealerLocationID	DealerLocationID

Brand Model

Field	Type	Description
ID	BrandID
Name	string
Color	string
Logo	string
VINPrefix	string
ButtonLabel	string
PonBrandCode	string
ServiceBoxWO	string
ServiceBoxVIN	string
TabletServiceButtonURL	string
DealerLocationID	DealerLocationID
ChecklistID	ChecklistID

CameraAppVersion Model

Field	Type	Description
ID	CameraAppVersionID
Label	string
MinimumLabel	string
Remarks	string

Checklist Model

Field	Type	Description
ID	ChecklistID	Claire Checklist ID
Name	string	Name of the checklist
Active	bool	Is this checklist active
IsActiveForMechanic	bool	Is this checklist active for mechanic
IsLocked	bool	Is this checklist locked
IncludeInReports	bool	Include this checklist in reports
IsCategoryMode	bool	Category mode is active for this checklist
CheckInCustomer	bool	Check-in the customer
RoleID	RoleID
ChecklistType	ChecklistType	Type of checklist
DealerID	DealerID	Dealer Identifier
ChecklistTemplateID	ChecklistTemplateID	Checklist template ID
IsDeleted	bool	Is this checklist deleted
DisplayOrder	int	Display order of checklists
ChecklistTemplate	ChecklistTemplate	Checklist template
QuestionGroups	QuestionGroup	List of question groups of this checklist
TagIDs	TagID	list of tag ids associated with this checklist
Tags	Tag	Tags associated with this checklist
BrandIDs	BrandID	List of brand ids associated with this checklist
Brands	Brand	Brands associated with this checklist
ParentChecklist	Checklist	Parent Checklist associated with this checklist
PausedCheck	PausedCheck	If not nil, contain the paused check for this checklist
UnfinishedCheck	PausedCheck	If not nil, contain the paused check for this checklist
Questions	Question	List of questions associated with this checklist
AttachedTo	string	List of dealer names and dealer location names that are using this checklist

ChecklistTemplate Model

Field	Type	Description
ID	ChecklistTemplateID
Name	string	Name of the template
Description	string	Description of the template
PrimaryColor	string	Primary color of the template
TextColor	string	Text color of the template
IconColor	string	Icon color of the template
PriceEnabled	bool	Price is enabled
CustomerOKEnabled	bool	Customer ok is enabled
ReadyEnabled	bool	Ready is enabled
SnoozeEnabled	bool	Snooze is enabled
PinEnabled	bool	Pin is enabled
MultiUseEnabled	bool	Multi-use is enabled
IncludeInReports	bool	Include this checklist in reports
TotalPDFEnabled	bool	Total in PDF is enabled
DefaultOnly	bool	This is default only template
CCDefaultSelected	bool	CC Default is selected
CCDefaultSelectedNVT	bool	CC Default is selected for NVT
PDFLayoutID	ReportTemplateID	Identifier of the pdf layout
AddPurpose	bool	Purpose is added
ShowMechanicName	bool	Mechanic name is visible
CanSkipKmAndDate	bool	KM and Date is skipped
HideTimestamp	bool	Timestamp is hidden
SkipUpdateAppointmentStatus	bool	Appointment status updates are enabled
IsPreviewable	bool	This ReportTemplate can be previewed before receiving the binary

DMSUser Model

Field	Type	Description
DealerLocationID	DealerLocationID	dealer location id of the dms user
DMSNr	string	dms nr of the user
Name	string	name of the user
UserID	UserID	Claire User ID of the DMS User

DNSRecord Model

Field	Type	Description
RecordType	string

Dealer Model

Field	Type	Description
ID	DealerID
Name	string	Name of the dealer
CountryCode	string	Country code associated with the dealer
Active	bool	Dealer is currently active
CanAddUsers	bool	Dealer can add additional users
AcceptedAPIAgreement	bool	The dealer has accepted Claire's API agreement
DBBEnabled	bool	Dealer has enabled DBB functionality
CustomDomainEnabled	bool	A custom domain is enabled for the dealer
WebsiteURL	string	The URL of the dealer's website
SysAdminName	string	Name of the system administrator
SysAdminEmail	string	Email address of the system administrator
SysAdminPhone	string	Phone number of the system administrator
DMSServerInfo	string	Information related to the dealer's physical machine running the DMS
NetworkInfo	string	Details about the dealer's network configuration
ZohoKey	string	Key related to Zoho integration
City	string	City where the dealer is located
Street	string	Street address of the dealer
Region	string	Region or state where the dealer is situated
PostalCode	string	Postal code or ZIP code of the dealer's location
PhoneNr	string	Phone number of the dealer
DomainName	string	Name of the dealer's domain
EnableCarReady	bool	Car Ready' status feature is enabled
CustomerDataRetentionInYears	int	How long to wait before disposing of a customers information
KeyloopContractCode	string	Keyloop Dealer Identifier
ICARKey	string	ICar Dealer Identifier
ICAREmp	string	ICar EMP
ICARLastUpdate	time.Time	Last time for this dealer that ICar processing occurred
ChatshipperEmail	string	Email address for Chatshipper service
SMSGatewayID	SMSGatewayID	Denotes which SMS Service the dealer is using
TwilioAccountSID	string	Account SID for Twilio integration
TwilioAPIKey	string	API key for Twilio integration
TwilioPhoneNumber	string	Phone number used by Twilio for contacting customers
IsTwilioSubAccountManaged	bool	Twilio sub-account is managed by Claire
IsTwilioPhoneNumberManaged	bool	TwilioPhoneNumber is managed by Claire
IsTwilioAPIKeyManaged	bool	TwilioAPIKey is managed by Claire
TwilioMonthlyDollarLimit	float64	Twilio's monthly limit in dollars'
TwilioMonthlyDollarLimitUsageTriggerSID	string	Twilio Account SID to trigger monthly price limit overuse
TwilioMonthlySMSLimit	int	Twilio's monthly sms limit'
TwilioMonthlySMSLimitUsageTriggerSID	string	Twilio Account SID to trigger monthly sms limit overuse
TwilioDailyDollarLimitUsageTriggerSID	string	Twilio Account SID to trigger daily limit overuse
PlanItPlanningEnabled	bool	Indicates if PlanIt planning is enabled
PlanItPlanningUserName	string	Username for PlanIt planning
OneiPlanningEnabled	bool	Indicates if Onei planning is enabled
OneiPlanningEnvironmentGuid	string	Environment GUID for Onei planning
WebClockURL	string	URL for web clock functionality
AdvisedCriticalHistoryEnabled	bool	Advised critical history is enabled
IsSnoozeTypeNextVisitCustomerEnabled	bool	Next Visit Customer Snooze Type is enabled
IsSnoozeTypeMakeOfferEnabled	bool	Make Offer Snooze Type is enabled
IsSnoozeTypeMakeNewAppointmentEnabled	bool	Make New Appointment Snooze Type is enabled
IsSnoozeTypeRemindCustomerEnabled	bool	Remind Customer Snooze Type is enabled
IsSnoozeStatusEnabled	bool	Snooze Status is enabled
IsSnoozeDepartmentEnabled	bool	Snooze Department is enabled
IsSnoozeAttachmentEnabled	bool	Snooze Attachment is enabled
IsPonOilEnabled	bool	Access to PON Oil API is enabled
PonUsername	string	Username to access PON API
ExactAccountID	AccountID	ID of the linked account in Exact Online
IsExactInvoicingEnabled	bool	Use Exact invoice generation
IsExactDealerStartupCostsInvoiced	bool	Is the startup cost for this dealer already invoiced
IsExactOneiStartupCostsInvoiced	bool	Is the Onei startup cost for this dealer already invoiced
Checklists	Checklist	Checklists created by this dealer
DealerLocations	DealerLocation	Locations created by this dealer
Domain	Domain	Domain configured for this dealer
DMSCapabilityIDs	DMSCapabilityID	DMS Capabilties of this dealer
HasChatshipperPassword	bool	Password for Chatshipper service bas been set
HasTwilioAPISecret	bool	API secret for Twilio integration has been set
HasTwilioAuthToken	bool	Authentication token for Twilio integration has been set
HasPlanItPlanningPassword	bool	Password for PlanIt planning has been set
HasOneiPlanningApiKey	bool	API key for Onei planning has been set
HasPonPassword	bool	Password for Pon has been set
EnabledWarrantyTypes	WarrantyTypeID	List of warranty types enabled for this dealer

DealerLocation Model

Field	Type	Description
ID	DealerLocationID	Claire dealer location ID
NotifierKey	NotifierKey
DMSID	DMSID	DMS ID in Claire
DSN	string	Set if a different DSN per location is necessary at the DMS side, otherwise empty and the dealer DSN is used
DMSWriteBack	bool	Is write back to DMS enabled
UpgradeCarWithRDW	bool	Is updating the car with information from rdw enabled
UpgradeWithRDWAPKDate	bool	Upgrades the APK Date of the car with what is from RDW
WriteBackRDWAPKDate	bool	Writeback the APK Date to the DMS if the RDW APK Date is more recent
DMSLocationSource	string	DMS Datasource for the location
KeepImportingAfterWorkStarted	bool	Interventions will be imported even after work has started on the appointment
Active	bool	Location is active if true
Name	string	Name
CommercialName	string	Commercial name of the Claire Dealer Location
Headline	string	Headline
Footerline	string	Footerline
Logo	string	Logo URL
CompanyStamp	string	Official stamp of approval given by the location
LanguageCode	LanguageCode	Default language for the location
VAT	float64	VAT
IncludeVAT	bool	Include VAT
ImporterVersion	string	Version of the importer
SummerAThreshold	float64	A Threshold for summer tyres
SummerNThreshold	float64	N Threshold for summer tyres
WinterAThreshold	float64	A Threshold for winter tyres
WinterNThreshold	float64	N Threshold for winter tyres
AllSeasonAThreshold	float64	A Threshold for all_season tyres
AllSeasonNThreshold	float64	N Threshold for all_season tyres
TruckTyreAThreshold	float64	A Threshold for truck tyres
TruckTyreNThreshold	float64	N Threshold for truck tyres
CarReadyBtnVisible	bool	Car ready button is visible
APKVisible	bool	APK is visible
HUVisible	bool	HU is visible
DateVisible	bool	Date is visible
AcceptNetworkMetrics	bool	Accept network metrics
LastImportAt	time.Time	Last imported at time stamp
Street	string	Street
PostalCode	string	Postal code
City	string	City
Country	string	Country
PhoneNr	string	Phone number
DealerID	DealerID	Dealer Identifier
ExtraPartsListID	ChecklistID	Extra parts list ID
DefaultCustomer	string	Default customer
DpDriverVisible	bool	DP Driver is visible
DpContractorVisible	bool	DP Contractor is visible
DpOwnerVisible	bool	DP Owner is visible
UnpinAppointmentsOnIsBilled	bool	Unpin appointments automatically when they are considered billed
UnpinAppointmentsOnCarOutOfShop	bool	Unpin appointments automatically when the Car leaves the location
UnpinPastAppointmentsOlderThan	int	Unpin appointments automatically once their date is this many days in the past
UnpinFutureAppointmentsFurtherThan	int	Unpin appointments automatically once their date is this many days in the future
PinVisible	bool	Pin is visible
VideoEnabled	bool	Video is enabled
ScheduleEnabled	bool	Schedule is enabled
FirstNameOptional	bool	First name is optional
MCCButtonVisible	bool	MCC button is visible
IsRobnetEnabled	bool	Robnet is enabled
CustomerCommunicationVisible	bool	Customer Communication is visible
DatastoreKey	string	Datastore key
FleetNrVisible	bool	Fleet number is visible
ServiceBoxVisibleOnCar	bool	Service box visible on car
ServiceBoxVisibleOnWO	bool	Service box visible on wo
DBBEnabled	bool	DBB is enabled
DBBUser	string	DBB user
IPAddressEnabled	bool	IP Address is enabled
IPAddress	string	IP Address
DMSPriceEnabled	bool	DMS Prices is enabled
DMSBillingEnabled	bool	DMS Billing is enabled
DMSWarrantyPin	bool	DMS Warranty Pin is enabled
ThirdPartySendCommunications	bool	Third party can be used for sending communications
OnlineCheckInEnabled	bool	Online check in is enabled
DeskCheckInEnabled	bool	Desk check in is enabled
IsOpenDeskCheckoutOnCarOutOfShopEnabled	bool	Desk Checkout will automatically open when the receptionist sets Car out of Shop
CarOutOfShopAtDeskCheckOutEnabled	bool	At Desk Checkout, car will be set out of shop automatically
DiagnoseOverviewEnabled	bool	Diagnose overview is enabled
RepairOverviewEnabled	bool	Repair overview is enabled
DefaultCustomerOkForDMSLeaseIntervention	bool	Default customer ok for DMS Intervention with lease customer
ZohoID	string	Zoho Identifier
KeyloopBusinessUnit	string	Keyloop business unit
IsKeyloopEventEnabled	bool	Use keyloop webhooks
AutoflexUsername	string	Autoflex username
AppointmentDetailUsersIndicatorEnabled	bool	Appointment detail users indicator enabled
IsEmployeeNameVisible	bool	Employee name is visible
IsCarInShopPrintEnabled	bool	Car in shop print is enabled
IsKeyLockerEnabled	bool	KeyLocker is enabled
KeyLockerCode	KeyLockerPIN	KeyLocker Code
IsTyreTeamEnabled	bool	Tyreteam is enabled
IsTyreTeamAutofillPriceRefOnOrder	bool	When ordering tyres, a ref field will be autofilled with the price
IsTireScannerEnabled	bool	Tyre scanner is enabled
TireScannerPrivateKey	string	Tire scanner private key
IsEditingQuestionVideosEnabled	bool	Question video editing is enabled
AutomaticallyPinAppointments	bool	Automatically pinning appointments is enabled
IsManuallyPinningAppointmentsEnabled	bool	Manually pinning appointments is enabled
IsAutomaticallyPinnedAppointmentsReadonly	bool	Automatically pinned appointments are readonly is enabled
IsDayplannerEnabled	bool	Dayplanner is enabled
AutomaticallyAssignWOWhenCheckStarted	bool	Automatically assign the workorder to the mechanic who started the check
AutomaticallyAssignWOWhenInterventionFixed	bool	Automatically assign the workorder to the mechanic who fixed the intervention
RecurringCarDuration	int	Duration in week to mark a car as recurring car, default is 4 weeks
AutomaticAppointmentRefreshInterval	int	When the location is connected to a Scheduler DMS. This will automatically update appointments, upon opening, if the elapsed time surpasses the specified interval
PlanItPlanningEstablishmentID	PlanItPlanningEstablishmentID	PlanIt Planning Identifier for the location
PlanitPlanningReplacementVehicle	bool	Convert the planit replacement vehicle into a note on the appointment
WebClockOmgevingID	WebClockOmgevingID	ID from the Omgeving in TruckVision database to use WebClock
BarCodeType	Barcode	Type of barcode to be scanned
IsWarrantyPinSupportWarningEnabled	bool	Is support nr warning enabled on the warranty pin
IsWarrantyPinClaimWarningEnabled	bool	Is claim nr warning enabled on the warranty pin
IsRecallPinSupportWarningEnabled	bool	Is support nr warning enabled on the recall pin
IsRecallPinClaimWarningEnabled	bool	Is claim nr warning enabled on the recall pin
IsWarrantyPinSignatureMissingWarningEnabled	bool	Is warning enabled for missing signature on warranty pin
EVHCExportEnabled	bool	EVHC exports are Enabled
EVHCPrimaryCode	string	EVHC Primary Dealer Code
EVHCSecondaryCode	string	EVHC Secondary Dealer Code
IsCustomerAnsweredCheckInMandatory	bool	Is customer answered checkin mandatory
IsNextKmAndNextDateOptional	bool	Next Km and Next Date are optional fields
HideNextKmAndNextDate	bool	Hide next km and next date on the wo detail page
IsShareboxEnabled	bool	Sharebox credentials are enabled
ShareboxApiClientID	string	Sharebox API Client ID used as client_id during authentication
ShareboxCustomerID	string	Sharebox customer id
ShareboxSessionID	string	Sharebox session id
IsKioskEnabled	bool	Kiosks are enabled
IsAcsesEnabled	bool	Acses lockers are enabled
AcsesEmail	string	Acses email used as Basic Auth during authentication
IsRecallsServiceEnabled	bool	Recalls service is enabled
IsPonRecallEnabled	bool	PON Recall are enabled
PonLocationNumber	string	PON Location Number
ExactAccountID	AccountID	ID of the linked account in Exact Online
IsExactInvoicingEnabled	bool	Use Exact invoice generation
IsExactCategoryLicenceEnabled	bool	Use Exact category licenses
IsExactLocationStartupCostsInvoiced	bool	Is the startup cost for this location already invoiced
IsTyreMotionEnabled	bool	Is the usage of tyre motion api enabled on this location
KeyLabelTypeID	KeyLabelTypeID	The Key Label layout, it can be either standard layout of basic layout
RedirectToNewWebVersion	bool	Redirect the user to new web version
CheckInDaysPrior	int
SendParkingGateCode	bool
Brands	Brand
WarrantyPinSignatureBrands	Brand
Checklists	Checklist
AppointmentStatuses	AppointmentStatus
Timeslots	Timeslot
Dealer	Dealer
DealerName	string
DMSCapabilityIDs	DMSCapabilityID
MCCCodes	MCCDealerLocationCode
LastDMSUpdate	time.Time
AutoUnpinAppointmentStatuses	StatusIdentifier
HasAutoflexPassword	bool	Autoflex password has been set
HasShareboxApiClientSecret	bool	Sharebox API Client secret used as client_secret during authentication has been set
HasShareboxWeblinkAccessKey	bool	Sharebox weblink access key has been set
HasShareboxPrivateKey	bool	Sharebox private key has been set
HasDBBPassword	bool	DBB Password has been set
HasRobnetApiKey	bool	Robnet API Key has been set
HasAcsesPassword	bool	Acses password has been set
NoteSuggestions	NoteSuggestion	List of suggestions for notes
NoteTypes	NoteType	List of types of notes for the suggestions
DMSLocations	DealerLocationDMS	List of dms configurations for this location
BrandIDs	BrandID	Brand IDs list
NumberOfMissingExactLicenses	int	The quantity of Exact license categories that don't have a connected license'
EnabledAppointmentNoteTypeIDs	AppointmentNoteType	List of enabled Appointment Note Types
DMSLocationIDs	string

DealerLocationDMS Model

Field	Type	Description
ID	DealerLocationDMSID
DealerID	DealerID	Dealer Identifier
DealerLocationID	DealerLocationID	Dealer Location Identifier
DMSID	DMSID	DMS platform Identifier
Comment	string	Comments for this configuration
DMSLocationID	string	Location Identifier in the DMS
Database	string	Database Identifier in the DMS
MaintenanceIntervention	string	Identify interventions to be labeled as Maintenance when importing from the DMS
CustomerNotApproved	string	Identify interventions that are not customer approved when importing from the DMS
NotVisibleToCustomer	string	Identify interventions that are not visible to the customer when importing from the DMS
ExcludeFromImport	string	Identify interventions to be not imported when importing from the DMS
AutolineConfig	DealerLocationDMSAutolineConfig
IncadeaConfig	DealerLocationDMSIncadeaConfig

DealerLocationDMSAutolineConfig Model

Field	Type	Description
DealerLocationDMSID	DealerLocationDMSID	Dealer location dms Identifier
BusinessCustomerTableID	string	Table to use when selecting business customers (contractors)
CustomerTableID	string	Table to use when selecting customers
CarTableID	string	Table to use when selecting cars
CustomerDetailTableID	string	Table to use when selecting customer details
CarMakeTableID	string	Table to use when selecting car make
CarNoteTableID	string	Table to use when selecting car notes
DepartmentID	string	Department Identifier, since Locations can be split into departments
VatTableID	string	Table to use when selecting how to calculate VAT on prices
PriceIncludesVat	string	Prices include VAT already calculated
RentalBilled	string	Identifier for the Customer having paid for using a rental vehicle, used to set the billed status
RentalCode	string	Identifier for the code of the rental vehicle, used to set the billed status
RentalStatus	string	Identifier for the state of the rental vehicle, used to set the billed status

DealerLocationDMSIncadeaConfig Model

Field	Type	Description
DealerLocationDMSID	DealerLocationDMSID	Dealer location dms Identifier
DMSDealerID	string
DMSAppointmentType	string	Appointment type in the DMS to query for some extra data like APK
DMSWarrantyInterventionID	string	Identify intervention that are for warranty purpose
DMSInternalInterventionID	string	Identify intervention that are internal

DeleteRequest Model

Field	Type	Description
ID	TagID	Identifier of the tag to delete

Device Model

Field	Type	Description
ID	DeviceID
MacAddress	string
OSVersion	string
Brand	string
Model	string
FreeSpace	string
IsLeased	bool
LastUsed	time.Time
CurrentUser	User
CurrentUserID	UserID
History	DeviceHistory
DealerLocationID	DealerLocationID

DeviceHistory Model

Field	Type	Description
ID	DeviceHistoryID
FullName	string
DealerName	string
LocationName	string
RoleName	string
DeviceID	DeviceID
UserID	UserID

Domain Model

Field	Type	Description
Name	string	Name of the domain
DealerID	DealerID	Dealer Identifier to which this domain belongs
SpamAction	mailgun.SpamAction	Mailgun reported SpamAction
Wildcard	bool	Wildcard is enabled
State	string	Current state of the domain
SendingRecords	mailgun.DNSRecord	Sending DNS Records

FormFile Model

Field	Type	Description

LandingPage Model

Field	Type	Description
ID	LandingPageID
Name	string

Language Model

Field	Type	Description
LanguageCode	string

LoggedAppointment Model

Field	Type	Description
ID	ImportLogID
DealerLocationID	DealerLocationID
ExternalID	string
WONr	string

MCCDealerLocationCode Model

Field	Type	Description
DealerLocationID	DealerLocationID
VINPrefix	string
Brand	string
DealerCode	string

NetworkMetrics Model

Field	Type	Description
ID	NetworkMetricsID
PingClaire	float32
PingOutside	float32
DelayClaire	float32
DelayOutside	float32
WiFiStrength	float32
WiFiName	string
UserID	UserID
DealerLocationID	DealerLocationID

NoteSuggestion Model

Field	Type	Description
DealerLocationID	DealerLocationID	Identifier of the dealer location
NoteType	NoteTypeID	ID of the appointment note type to which this suggestion belong
Order	int	Order of the suggestion in the suggestion list
Content	string	Appointment note comment suggestion
Active	bool	Is the note suggestion active for the dealer location

NoteType Model

Field	Type	Description
NoteTypeID	NoteTypeID	Identifier of the note type
DealerLocationID	DealerLocationID	Dealer location identifier
Active	bool	Is the note type active

NotificationElement Model

Field	Type	Description
NotificationElementID	NotificationElementID	Identifier for the notification element
NotificationEntityID	NotificationEntityID	Identifier for the notification entity
NotificationFieldID	NotificationFieldID	Identifier for the notification field
Entity	NotificationEntity
Field	NotificationField
UserID	UserID

NotificationEntity Model

Field	Type	Description
ID	NotificationEntityID
Name	string	Name of the entity
TemplateID	NotificationEntityTemplateID	Identifier for the entity template

NotificationField Model

Field	Type	Description
ID	NotificationFieldID
Name	string	Name of the field
Value	string	Value of the field
Icon	string	Icon of the field to be displayed in frontend
SubIcon	string	Sub icon of the field to be displayed in frontend

OneiPlanningMonteur Model

Field	Type	Description
ID	OneiPlanningMonteurID
Location	string
Code	string
MonteurName	string
DealerLocationID	DealerLocationID
UserID	UserID

PausedCheck Model

Field	Type	Description
ID	PausedCheckID	Claire paused check ID
AppointmentID	AppointmentID	Claire appointment ID
ChecklistID	ChecklistID	Claire checklist ID
UserID	UserID	ID of the user who paused the check
URL	string	URL of the serialized java check

PlanItPlanningMechanic Model

Field	Type	Description
ID	PlanItPlanningMechanicID
Code	string
MechanicName	string
DealerLocationID	DealerLocationID
UserID	UserID

Question Model

Field	Type	Description
ID	QuestionID	Claire Question ID
Title	string	Title of the question
Active	bool
Order	int
RoleID	RoleID	NULL if it is a default question available to all, otherwise the role ID of the user who created this question (meaning it is only visible to that Dealer's locations)
DefaultStatus	int
CanDuplicate	bool
EVHCLaborPercent	int	Labor percentage to the total cost, sum <=100
EVHCPartPercent	int	Part percentage to the total cost, sum <=100
EVHCTirePercent	int	Tire percentage to the total cost, sum <=100
EVHCExternalPercent	int	External percentage to the total cost, sum <=100
IsDeleted	bool
DealerID	DealerID
DealerLocationID	DealerLocationID
QuestionElements	QuestionElement	List of question element in this question
Checklists	Checklist
TagIDs	TagID
Tags	Tag
ContainsTyreElement	bool
QuestionOptions	QuestionOption
DefaultImages	QuestionResultImage
DefaultVideos	QuestionResultVideo

QuestionElement Model

Field	Type	Description
ID	QuestionElementID	Claire Question Element ID
Name	string	Name of the question element
Order	int
Template	QuestionElementTemplate	Template of the question element, define what type of answer will be provided, refer to that enumeration for more details
DefaultConfiguration	string	Default configuration, depending on the template can contain prefilled values or labels
RoleID	RoleID	NULL if it is a default question element available to all, otherwise the role ID of the user who created this question element (meaning it is only visible to that Dealer's locations)
DefaultAnswer	AnswerItem

QuestionGroup Model

Field	Type	Description
ID	QuestionGroupID	Claire Question Group ID
Name	string	Name of the group of question
Order	int	Order of the group of question
Questions	Question	List of questions in this group

QuestionOption Model

Field	Type	Description
ID	QuestionOptionID
Name	string
Value	bool

QuestionResultImage Model

Field	Type	Description
ID	QuestionResultImageID
URL	string
Active	bool
VisibleInPDF	bool
IsFinalCheck	bool
InterventionIndex	int
QuestionResultID	QuestionResultID

QuestionResultVideo Model

Field	Type	Description
ID	QuestionResultVideoID
URL	string
Active	bool
Visible	bool
IsFinalCheck	bool
InterventionIndex	int
QuestionResultID	QuestionResultID

Role Model

Field	Type	Description
ID	RoleID
Name	string
ACL	ACL

Settings Model

Field	Type	Description
ID	SettingsID
Name	string
Locale	string
URL	string

Tag Model

Field	Type	Description
ID	TagID	Claire Tag ID
Name	string	Name of the tag
Color	string	Color of the tag
System	bool	Wheter it is a system tag

Timeslot Model

Field	Type	Description
ID	TimeslotID
Deadline	time.Time
Active	bool
DealerLocationID	DealerLocationID

Translation Model

Field	Type	Description
TranslationKey	string
LanguageCode	LanguageCode
Value	string

User Model

Field	Type	Description
ID	UserID	Claire User ID
DMSNr	string	DMS Number of the Claire User
FirstName	string	First name
LastName	string	Last name
Email	string	Email in Claire
Username	string	Username in Claire
Mobile	string	Mobile phone numer
Phone	string	Phone numer
Birthday	time.Time	Birthdate
LastActive	time.Time	Last activity date in Claire
Address1	string	Address line 1
Address2	string	Address line 2
ChannelToken	string	Channel token
ClientID	string	Client ID
LastPasswordChange	time.Time	Last password change date in Claire
GoogleID	string	Google ID
Status	UserStatusID	User status
WebVersion	string	Web version the user is using
AppVersion	string	App version the user is using
CameraVersion	string	Camera app version the user is using
LocationColumnVisible	bool	Is Location Visible
MultiDeviceLoginEnabled	bool	Is user allowed to login from multiple devices simultaneously
IsCombiUser	bool	Indicates if a user can use both web and tablet
ListAppointmentsByScheduledRange	bool	Indicates if a user can list appointments by scheduled range
CsvDownload	bool	Indicates if a user can download CSV files
ProfilePicture	string	Profile picture URL
LanguageCode	LanguageCode	Default language for the user
DealerID	DealerID	Default Dealer ID when loggin in
DealerLocationID	DealerLocationID	Default Location ID when loggin in
RoleID	RoleID	Default Role ID when loggin in
ZohoID	string	Zoho ID
LandingPageID	LandingPageID	Default Landing Page ID when loggin in
IsCounterTabletUser	bool	Indicates if a user is a counter tablet user
IsKeyLockerAllowed	bool	Indicates if a user is allowed to use key locker
IsAvailable	bool
PinStatusNotificationEnabled	bool	Indicates if a user is allowed to receive pin status notifications
TyreOrderingEnabled	bool	Indicates if a user is allowed to order tyres
ShopStatusSameDayFilterEnabled	bool	Indicates if same day shop status filter is enabled
ShopStatusNextDayFilterEnabled	bool	Indicates if next day shop status filter is enabled
ShopStatusToOrderFilterEnabled	bool	Indicates if to order shop status filter is enabled
ShopStatusBackorderFilterEnabled	bool	Indicates if backorder shop status filter is enabled
ShopStatusArrivedPartsFilterEnabled	bool	Indicates if arrived parts shop status filter is enabled
WorkingOn	AppointmentID	ID of the appointment the user is currently working on
MyLocations	DealerLocationID	Locations the user has access to
Dealers	Dealer	Dealers the user has access to
DealersIDs	DealerID	Dealer IDs the user has access to
LocationIDs	DealerLocationID	Location IDs the user has access to
DealerLocation	DealerLocation	Dealer location the user has access to
DeviceID	DeviceID	Device ID of the user
CounterTabletKey	string	come from the auth user, not saved in the DB to last only as long as the session
RoleName	string	Role name of the user
DPO	bool	Indicates if the user is a DPO user
ACL	ACL	ACLs of the user
Brands	Brand	List of brands
OneiPlanningMonteurID	OneiPlanningMonteurID
PlanItPlanningMechanicID	PlanItPlanningMechanicID	PlanIt Planning Mechanic ID of the user
NotificationElementIDs	NotificationElementID	Notification element IDs of the user
DealerName	string	Name of the dealer
LocationName	string	Name of the location
AppointmentID	AppointmentID	AppointmentID, used internally

Changelog

This section contains changes related to the System service. Changes will be included if:

A new endpoint is added
A new field is added to an existing endpoint
Field description changes
A field is deprecated

User - 01.04.2025.

The following endpoints are included in this version:

/v1/users/password/strength

User - 12.03.2025.

The following endpoints are included in this version:

/v1/users/language/update

User - 25.02.2025.

The following endpoints are included in this version:

/v1/users/profile_picture/upload

User - 18.02.2025.

The following endpoints are included in this version:

/v1/users/reinstate
/v1/users/account/update
/v1/users/location/update
/v1/users/landing_pages

Device - 31.10.2024.

The following endpoints are included in this version:

/v1/devices/lease/update
/v1/devices/find_by_user
/v1/devices/find_by_id
/v1/devices/list
/v1/devices/save
/v1/devices/models/list
/v1/devices/os_versions/list
/v1/devices/brands/list
/v1/devices/export

User - 17.10.2024.

The following endpoints are included in this version:

/v1/users/admins/list
/v1/users/create
/v1/users/delete
/v1/users/details
/v1/users/dms/users/list
/v1/users/list
/v1/users/list_by_location
/v1/users/notification_elements/list
/v1/users/pairing/dms/update
/v1/users/pairing/onei/list
/v1/users/pairing/onei/update
/v1/users/pairing/planit/list
/v1/users/pairing/planit/update
/v1/users/search
/v1/users/update
/v1/users/versions/list

Translations - 24.09.2024.

The following endpoints are included in this version:

/v1/translations/export_missing_translations
/v1/translations/import_missing_translations

Settings - 02.09.2024.

The following endpoints are included in this version: * /v1/settings/versions/current * /v1/settings/versions/camera/current * /v1/settings/find * /v1/settings/update * /v1/settings/versions/list * /v1/settings/versions/camera/add * /v1/settings/create * /v1/settings/versions/add * /v1/settings/versions/camera/list

Bitbucket, languages, tags - 02.09.2024.

The following endpoints are included in this version: * /v1/bitbucket/new_pull_request * /v1/languages/list * /v1/tags/list * /v1/tags/create * /v1/tags/update * /v1/tags/delete

Initial release - 30.08.2024.

The following endpoints are included with initial release:

/v1/support/list
/v1/support/network_metrics
/v1/support/import_location_logs
/v1/translations/create
/v1/translations/delete
/v1/translations/generate_migration
/v1/translations/list
/v1/translations/list_by_language_id
/v1/translations/update

Errors

The Claire Automotive Support APIs uses the following error codes:

Error Code	Meaning
400	Bad Request : Your request is invalid.
401	Unauthorized : Your API key is wrong.
404	Not Found : The specified endpoint could not be found.
405	Method Not Allowed : You tried to access server with an invalid method.
429	Too Many Requests : You're making too many requests.
500	Internal Server Error : We had a problem with our server. Try again later.
503	Service Unavailable : We're temporarily offline for maintenance. Please try again later.