LapID API (3.2.0)

New API version

Version 3.2.0 introduces full System User management via /system-users incl. role assignments to companies. It also adds person move support (…/persons/{personUuid}/move), extends person instructions with deepLink and introduces uuids for all objects and routes (numeric IDs are deprecated as of now.).

1. Adjusted objects:

• Person (language enum extended with fr)

2. Identifier migration:

• Path variables are now named as UUID placeholders (e.g. {companyUuid}, {personUuid}).
• Existing entities support UUIDs and legacy numeric IDs for backward compatibility. If a UUID and a deprecated numeric ID are both provided for the same object or relation, the UUID is used. If no UUID is provided and the deprecated numeric ID is provided, the numeric ID is used.
• New system user and system user assignment endpoints use UUID-only identifiers.
• In 201 Created responses, the response body returns the created resource UUID. Legacy object-id is returned as deprecated header for backward compatibility on legacy create endpoints.
• Numeric IDs are deprecated and should be replaced by UUIDs.

3. Person instructions deep link:

• Assigned person instructions now include deepLink in the response object to open the exact instruction/e-learning directly in the LapID portal without requiring a separate login.

4. Person instruction module selection:

• For instruction activation requests, moduleUuids (optional) was added to select instruction modules by UUID.
• The legacy modules request field is deprecated and only kept for backward compatibility.

5. Person company move:

• A dedicated endpoint was added to move persons between companies: …/persons/{personUuid}/move.
• During the move, assigned person products are deactivated and supervisor assignments are removed.
• If required, products and supervisors must be assigned again in the target company via separate API calls.
• Moving a person is an asynchronous process. The move endpoint returns an asyncTaskUuid to poll the processing status via GET /async-tasks/{asyncTaskUuid}.

6. Async task status:

• A dedicated endpoint was added to get the status and result of async tasks: …/async-tasks/{asyncTaskUuid}.

7. System User management:

• Full system user management is now available including CRUD operations, role assignments to companies, and activation/deactivation controls. System users can be managed independently across multiple companies with role-based access control.

8. License categories (Coming soon):

• Update and manage driver's license categories for persons.

9. New requests:

• List all system users: …/system-users

• Create a system user: …/system-users

• Get a system user: …/system-users/{systemUserUuid}

• Get extended system user information: …/system-users/{systemUserUuid}/extended

• Update a system user: …/system-users/{systemUserUuid}

• Delete a system user: …/system-users/{systemUserUuid}

• Activate or deactivate a system user: …/system-users/{systemUserUuid}/active

• Get system user assignments: …/system-users/{systemUserUuid}/assignments

• Update system user assignments: …/system-users/{systemUserUuid}/assignments

• Start an async task to move a person to another company: …/persons/{personUuid}/move

• Get async task processing status and result: …/async-tasks/{asyncTaskUuid}

• Coming soon: Update a person's driver's license categories: …/persons/{personUuid}/license/categories

10. New objects:

• SystemUser

• SystemUserCreate

• SystemUserExtended

• SystemUserAssignment

• SystemUserAssignments

• SystemUserRole

• ListResponseSystemUser

• PersonMoveCompanyRequest

• Coming soon: LicenseCategory

• Coming soon: PersonLicenseCategoryUpdateRequest

The LapID API supports syncing of base data for persons, supervisors, companies and system users. Additionally it supports the LapID products License Check and Instructions. You can change the settings for both products. The License Check and Instructions will still be processed by the LapID systems. For further instructions please see the Integration Guide.

To use the API, a Bearer Token is required. You can create this token as an administrator via the settings in the LapID customer system. For more information, see the Integration Guide. For authorization, use the API token as a Bearer Token in the Authorization header.

if-match recommend to prevent synchronisation issues. Value should represent sha256 hash of the lastModified value. if-None-match recommend if you only want to update, if there was a change.

Some API calls return a paginated list of items. To control the pagination of this list, the following parameters may be provided:

• If the optional offset is provided, the given number of items will be skipped. Otherwise, it will be set to 0, resulting in no items being skipped.

• Using limit the number of returned items can be limited. A maximum of 100 items can be requested.

• The order of returned items can be controlled using the orderBy key. The list will be ordered using the object property named by this key. By default items will be ordered by id.

In addition to the list of items both offset and limit will be returned. These may differ from the request if their values lay outside the range of allowed values. Moreover, a property called maxCount will also be returned containing the total number of items on the server.

Accept-Language Header must be submitted to get the response in the local format. Currently, only English and German locales are supported. If no header is provided the default locale (English) will be used.

Manage persons data and product specific settings for the person.

Manage supervisors data and product specific settings for the supervisor.

Specific Driver's License Check settings for a person, supervisor and company