Get maintenance record

GET

api

{version}

maintenance

{id}

Get maintenance record

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/maintenance/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/maintenance/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/maintenance/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/maintenance/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/maintenance/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "Id": "<string>",
  "RelatedAsset": {
    "AssetId": "<string>",
    "AssetType": "<string>",
    "AssetNumber": "<string>"
  },
  "Category": {
    "Id": "<string>",
    "Name": "<string>"
  },
  "Amount": {
    "Amount": 123,
    "Currency": 123
  },
  "CreatedAt": "2023-11-07T05:31:56Z",
  "CreatedBy": "<string>",
  "PO": "<string>",
  "Reference": "<string>",
  "Description": "<string>",
  "Comments": "<string>",
  "RepairShop": {
    "Id": "<string>",
    "Name": "<string>"
  },
  "Reminders": [
    {
      "id": "<string>",
      "DueDate": "2023-11-07T05:31:56Z"
    }
  ],
  "ModifiedAt": "2023-11-07T05:31:56Z",
  "ModifiedBy": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

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	Integer	No	The currency identifier of the amount (Money = ).
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.

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

string

required

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Response

string

required

Show child attributes

Category

object

required

Show child attributes

Amount

object

required

Show child attributes

CreatedAt

string<date-time>

required

CreatedBy

string

required

string | null

Reference

string | null

Description

string | null

Comments

string | null

RepairShop

object | null

Show child attributes

Reminders

object[] | null

Show child attributes

ModifiedAt

string<date-time> | null

ModifiedBy

string | null

⌘I

Get maintenance record

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/maintenance/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/maintenance/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/maintenance/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/maintenance/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/maintenance/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "Id": "<string>",
  "RelatedAsset": {
    "AssetId": "<string>",
    "AssetType": "<string>",
    "AssetNumber": "<string>"
  },
  "Category": {
    "Id": "<string>",
    "Name": "<string>"
  },
  "Amount": {
    "Amount": 123,
    "Currency": 123
  },
  "CreatedAt": "2023-11-07T05:31:56Z",
  "CreatedBy": "<string>",
  "PO": "<string>",
  "Reference": "<string>",
  "Description": "<string>",
  "Comments": "<string>",
  "RepairShop": {
    "Id": "<string>",
    "Name": "<string>"
  },
  "Reminders": [
    {
      "id": "<string>",
      "DueDate": "2023-11-07T05:31:56Z"
    }
  ],
  "ModifiedAt": "2023-11-07T05:31:56Z",
  "ModifiedBy": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

​Request Parameters

​Example CURL request

​Response Parameters

​Example Response

​Rate Limits

Authorizations

Path Parameters

Response

Request Parameters

Example CURL request

Response Parameters

Example Response

Rate Limits