This endpoint allows you to get detailed information about a specific maintenance record using its unique ID. The data retrieved includes the maintenance details such as description, amount, repair shop information, and reminders.
The GET Maintenance by ID API endpoint allows you to retrieve detailed information about a specific maintenance record using its unique ID. This endpoint provides comprehensive data about the maintenance record, facilitating effective asset management and tracking within the Alvys system.
Request Parameters
The following parameters are required in the URL path:
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | String | Yes | The API version to use. |
| id | String | Yes | The unique identifier of the maintenance record. |
Example CURL request
curl --location 'https://integrations.alvys.com/api/p/v{version}/maintenance/{id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Replace {version} with the API version number, {id} with the actual maintenance ID, and YOUR_ACCESS_TOKEN with your actual Bearer token:
curl --location 'https://integrations.alvys.com/api/p/v1/maintenance/123456789a-00b0-00ae-0000-0e01234567e6f' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...'
Response Parameters
The following table lists the parameters included in the response for maintenance-related requests:
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | String | Yes | The unique identifier of the maintenance record. |
| po | String | No | The purchase order number associated with the maintenance. |
| reference | String | No | A reference string for the maintenance record. |
| relatedAsset | Object | No | Details about the related asset for the maintenance. |
| relatedAsset.assetId | String | No | The unique identifier of the asset. |
| relatedAsset.assetNumber | String | No | The asset number. |
| relatedAsset.assetType | String | No | The type of asset (e.g., Truck, Trailer). |
| category | Object | No | The category of the maintenance work. |
| category.id | String | No | The unique identifier of the category. |
| category.name | String | No | The name of the category. |
| description | String | No | A description of the maintenance work. |
| comments | String | No | Additional comments or notes about the maintenance. |
| amount | Object | No | The total amount for the maintenance work. |
| amount.amount | Number | No | The amount value. |
| amount.currency | String | No | The currency of the amount. |
| repairShop | Object | No | Information about the repair shop. |
| repairShop.id | String | No | The unique identifier of the repair shop. |
| repairShop.name | String | No | The name of the repair shop. |
| reminders | Array | No | A list of reminders associated with the maintenance. |
| reminders.id | String | No | The unique identifier of the reminder. |
| reminders.dueDate | String (Date-Time) | No | The due date for the reminder. |
| createdAt | String (Date-Time) | Yes | The date and time when the maintenance record was created. |
| createdBy | String | No | The user who created the maintenance record. |
| modifiedAt | String (Date-Time) | No | The date and time when the maintenance record was last modified. |
| modifiedBy | String | No | The user who last modified the maintenance record. |
Example Response
On the right side, you can see examples of different error codes by clicking "Example" and selecting the response code.
Rate Limits
All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section.
This page is interactive, allowing you to try a request by providing the driver ID in the URL path. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can directly edit the Curl command. Make sure to authorize yourself before trying a request.