Provides an overview of the Activity Definition Manager module
What is Activity Definition Manager
Use the Activity Definition Manager module to retrieve the list of activity definitions configured by the organisation.
Activity definitions describe the activities a driver can perform or track time upon. The actual registration of those activities of drivers are visible in the SCALAR Track and Trace product.
An activity definition profile is a collection of activity definitions that defines all activities that can happen in a driver’s day-to-day operations upon which the user can collect feedback in a structured manner. An organization can have multiple activity definition profiles to register different activities or collect different feedback for parts of the fleet.
| Base URL | https://activity-definitions.api.eu1.scalar.zf.com |
| Audience | ADMGRAPI |
| Supported Versions | V1 |
Why use the Activity Definition Manager
Purpose I: Get activity definitions
SCALAR enables users to retrieve the list of activity definitions for an organisation and its details.
Purpose II: Manage assignment of activity definition profiles
- An activity definition profile is a configuration that specifies the activity definitions that should be available for a driver.
- Users can add assets to a particular activity definition profile and assign other assets to a different activity definition profile. Hence, the user can control the selection of activities or collect different information depending on the asset that is being used by the driver.
Purpose III: Collect information for creating trips
- Users can retrieve the information required for creating Scheduled trips.
- Users can fetch details of activity definition profiles and see the activity definitions applicable for the specific assets. Based on these details users can create the trips suitable for the asset.
Use cases
Use case I: Retrieves list of the activity definitions
To retrieve activity definitions details of an organisation. This helps to interpret the result of the track trace product.
Use case II: Get the activity definition profiles
To get the available activity definition profiles of an organization.
Use case III: Get the activity definition profile details
- To get the activity definition profile details.
- It helps an integrator to view the activity definitions included with an activity definition profile and the assets assigned to the profile.
Use case IV: Assign assets to an activity definition profile
- Users can assign assets to an activity definition profile.
- It allows drivers to register activities and enter the feedback on those activities relevant to the capabilities of the asset or to the needs of the organization.