9.1 API Access & Setup

The LAAMP platform provides a set of RESTful APIs that allow organisations to programmatically interact with their LAAMP environment. These APIs are intended for developers and IT teams looking to automate user management, training records, competency retrieval, and more.

This section provides an overview of the available API endpoints, setup requirements, and key integration tips.

Overview of LAAMP API Capabilities

LAAMP currently supports the following API operations:

• [POST] Create User

• [PUT] Update User

• [GET] Get All Users

• [GET] User Competencies

• [GET] All Roles

• [GET] Role Users

• [GET] All Groups

• [GET] Competent Users

• [GET] Heartbeat (System Status)

These endpoints use standard HTTP methods (GET, PUT, POST) and return data in JSON format. All calls require authentication headers including a valid token and client identifier.

Authentication & Headers

All requests must include the following headers:

Example: Creating a User

Endpoint:
POST http://{{USER_URL}}/

Request Body Example:

{
  "UserType": "Staff",
  "Username": "profoak",
  "FirstName": "Professor",
  "LastName": "Oak",
  "Email": "prof.oak@company.com"
}

Expected Response:

{
  "Message": "Ok",
  "UserId": "generated-user-id"
}

Example: Updating a User

Endpoint:
PUT http://{{USER_URL}}/:id

Include the user’s ID as a path variable. You may update details such as name, contact info, permissions, groups, and competencies.

Example: Retrieving All Users

Endpoint:
GET http://{{USER_URL}}/?start=0&max=20&order=ASC

Optional query parameters allow filtering by group, location, or search keyword. The response includes user metadata and can include location data if requested.

Other Endpoints

• User Competencies: Retrieve a specific user's competencies by user ID.

• All Roles: List all defined roles.

• Role Users: See users assigned to a specific role.

• All Groups: Retrieve all organisational groups.

• Competent Users: List users competent in a given competency.

• Heartbeat: Used to confirm the API service is active.

Integration Tips

• Use the Heartbeat endpoint to confirm API availability before running bulk operations.

• Ensure role, group, and permission mappings in your API calls match your LAAMP configuration.

• All POST and PUT requests must follow the expected JSON schema. Missing fields may cause errors or failed submissions.

Support

For API access tokens, endpoint setup, or advanced integration support, contact your Account Manager.