Search maintenance records

POST

api

{version}

maintenance

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/maintenance/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Page": 123,
  "PageSize": 123,
  "TruckIds": [
    "<string>"
  ],
  "TrailerIds": [
    "<string>"
  ],
  "Categories": [
    "<string>"
  ],
  "Status": "<string>",
  "DateRange": {
    "Start": "2023-11-07T05:31:56Z",
    "End": "2023-11-07T05:31:56Z"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Page: 123,
    PageSize: 123,
    TruckIds: ['<string>'],
    TrailerIds: ['<string>'],
    Categories: ['<string>'],
    Status: '<string>',
    DateRange: {Start: '2023-11-07T05:31:56Z', End: '2023-11-07T05:31:56Z'}
  })
};

fetch('https://integrations.alvys.com/api/p/v{version}/maintenance/search', 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/search"

payload = {
    "Page": 123,
    "PageSize": 123,
    "TruckIds": ["<string>"],
    "TrailerIds": ["<string>"],
    "Categories": ["<string>"],
    "Status": "<string>",
    "DateRange": {
        "Start": "2023-11-07T05:31:56Z",
        "End": "2023-11-07T05:31:56Z"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/maintenance/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Page' => 123,
    'PageSize' => 123,
    'TruckIds' => [
        '<string>'
    ],
    'TrailerIds' => [
        '<string>'
    ],
    'Categories' => [
        '<string>'
    ],
    'Status' => '<string>',
    'DateRange' => [
        'Start' => '2023-11-07T05:31:56Z',
        'End' => '2023-11-07T05:31:56Z'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"TruckIds\": [\n    \"<string>\"\n  ],\n  \"TrailerIds\": [\n    \"<string>\"\n  ],\n  \"Categories\": [\n    \"<string>\"\n  ],\n  \"Status\": \"<string>\",\n  \"DateRange\": {\n    \"Start\": \"2023-11-07T05:31:56Z\",\n    \"End\": \"2023-11-07T05:31:56Z\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/maintenance/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"TruckIds\": [\n    \"<string>\"\n  ],\n  \"TrailerIds\": [\n    \"<string>\"\n  ],\n  \"Categories\": [\n    \"<string>\"\n  ],\n  \"Status\": \"<string>\",\n  \"DateRange\": {\n    \"Start\": \"2023-11-07T05:31:56Z\",\n    \"End\": \"2023-11-07T05:31:56Z\"\n  }\n}")
  .asString();

{
  "Page": 123,
  "PageSize": 123,
  "Total": 123,
  "Items": [
    {
      "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>"
    }
  ],
  "Facets": {}
}

{
  "Errors": {},
  "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 Search Maintenance API endpoint allows you to search for maintenance records within the Alvys system based on various criteria such as asset type, category, status, and date range. This endpoint provides detailed information about each maintenance record that matches the search criteria, facilitating efficient management and retrieval of maintenance records.

Request Parameters

The following parameter is required in the URL path:

Parameter	Type	Required	Description
version	String	Yes	The API version to use.

Request Body

The following fields are required in the request body to filter the search results: <Table> ParameterTypeRequiredDescription PageIntegerYesThe page number to retrieve.PageSizeIntegerYesThe number of results per page.
PageSize must be greater than 0.TruckIdsArray of StringsConditionallyA list of truck IDs to filter by. This field is required if the other conditionally required fields are left empty.TrailerIdsArray of StringsConditionallyA list of trailer IDs to filter by. This field is required if the other conditionally required fields are left empty.CategoriesArray of StringsConditionallyA list of categories to filter by. This field is required if the other conditionally required fields are left empty.StatusStringConditionallyThe status of the maintenance record. One of the following: Urgent, Open, Closed. This field is required if the other conditionally required fields are left empty.DateRangeObjectConditionallyThe date range for the maintenance records. This field is required if the other conditionally required fields are left empty.DateRange.StartString (Date-Time)ConditionallyThe start date of the maintenance records range. This field is required if the other conditionally required fields are left empty.DateRange.EndString (Date-Time)ConditionallyThe end date of the maintenance records range. This field is required if the other conditionally required fields are left empty. </Table>

Example CURL request

Use the Current API version number and make sure to replace the Authorization header value with your actual Bearer token for the request:

curl --location 'https://integrations.alvys.com/api/p/v1/maintenance/search' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....' \
--header 'Content-Type: application/json' \
--data '{
  "Page": 0,
  "PageSize": 100,
  "TruckIds": [
      "TR123456789"
  ],
  "TrailerIds": [
      ""
  ],
  "Categories": [
      "Tires"
  ],
  "Status": "Open",
  "DateRange": {
      "Start": "2021-01-23T13:36:42.021Z",
      "End": "2024-08-23T13:36:42.021Z"
  }
}'

Response Parameters

The following table lists the parameters included in the response for maintenance search requests:

Parameter	Type	Required	Description
Page	Integer	Yes	The current page number of the results.
PageSize	Integer	Yes	The number of results per page.
Total	Integer	Yes	The total number of matching maintenance records.
Items	Array of Objects	Yes	The list of maintenance records matching the criteria.
Items.Id	String	Yes	The unique identifier of the maintenance record.
Items.PO	String	No	The purchase order number associated with the maintenance.
Items.Reference	String	No	A reference string for the maintenance record.
Items.RelatedAsset	Object	No	Details about the related asset for the maintenance.
Items.RelatedAsset.AssetId	String	No	The unique identifier of the asset.
Items.RelatedAsset.AssetNumber	String	No	The asset number.
Items.RelatedAsset.AssetType	String	No	The type of asset (e.g., Truck, Trailer).
Items.Category	Object	No	The category of the maintenance work.
Items.Category.Id	String	No	The unique identifier of the category.
Items.Category.Name	String	No	The name of the category.
Items.Description	String	No	A description of the maintenance work.
Items.Comments	String	No	Additional comments or notes about the maintenance.
Items.Amount	Object	No	The total amount for the maintenance work.
Items.Amount.Amount	Number	No	The amount value.
Items.Amount.Currency	Integer	No	The currency of the amount.
Items.RepairShop	Object	No	Information about the repair shop.
Items.RepairShop.Id	String	No	The unique identifier of the repair shop.
Items.RepairShop.Name	String	No	The name of the repair shop.
Items.Reminders	Array	No	A list of reminders associated with the maintenance.
Items.Reminders.id	String	No	The unique identifier of the reminder.
Items.Reminders.DueDate	String (Date-Time)	No	The due date for the reminder.
Items.CreatedAt	String (Date-Time)	Yes	The date and time when the maintenance record was created. For some maintenance records, the `CreatedAt` field may display `1970-01-01T00:00:00+00:00`. This placeholder represents the Unix Epoch and indicates that the original creation timestamp is unavailable. Users should interpret this as an unknown creation date, specific only to the `CreatedAt` field and not reflective of other timestamps or data.
Items.CreatedBy	String	No	The user who created the maintenance record.
Items.ModifiedAt	String (Date-Time)	No	The date and time when the maintenance record was last modified.
Items.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 completing the fields for the parameters below. 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

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Body

Page

integer<int32>

required

PageSize

integer<int32>

required

TruckIds

string[] | null

TrailerIds

string[] | null

Response

Page

integer<int32>

required

PageSize

integer<int32>

required

Total

integer<int64>

required

Items

object[]

required

Show child attributes

Facets

object | null

Show child attributes

⌘I

Search maintenance records

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/maintenance/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Page": 123,
  "PageSize": 123,
  "TruckIds": [
    "<string>"
  ],
  "TrailerIds": [
    "<string>"
  ],
  "Categories": [
    "<string>"
  ],
  "Status": "<string>",
  "DateRange": {
    "Start": "2023-11-07T05:31:56Z",
    "End": "2023-11-07T05:31:56Z"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Page: 123,
    PageSize: 123,
    TruckIds: ['<string>'],
    TrailerIds: ['<string>'],
    Categories: ['<string>'],
    Status: '<string>',
    DateRange: {Start: '2023-11-07T05:31:56Z', End: '2023-11-07T05:31:56Z'}
  })
};

fetch('https://integrations.alvys.com/api/p/v{version}/maintenance/search', 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/search"

payload = {
    "Page": 123,
    "PageSize": 123,
    "TruckIds": ["<string>"],
    "TrailerIds": ["<string>"],
    "Categories": ["<string>"],
    "Status": "<string>",
    "DateRange": {
        "Start": "2023-11-07T05:31:56Z",
        "End": "2023-11-07T05:31:56Z"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/maintenance/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Page' => 123,
    'PageSize' => 123,
    'TruckIds' => [
        '<string>'
    ],
    'TrailerIds' => [
        '<string>'
    ],
    'Categories' => [
        '<string>'
    ],
    'Status' => '<string>',
    'DateRange' => [
        'Start' => '2023-11-07T05:31:56Z',
        'End' => '2023-11-07T05:31:56Z'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"TruckIds\": [\n    \"<string>\"\n  ],\n  \"TrailerIds\": [\n    \"<string>\"\n  ],\n  \"Categories\": [\n    \"<string>\"\n  ],\n  \"Status\": \"<string>\",\n  \"DateRange\": {\n    \"Start\": \"2023-11-07T05:31:56Z\",\n    \"End\": \"2023-11-07T05:31:56Z\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/maintenance/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"TruckIds\": [\n    \"<string>\"\n  ],\n  \"TrailerIds\": [\n    \"<string>\"\n  ],\n  \"Categories\": [\n    \"<string>\"\n  ],\n  \"Status\": \"<string>\",\n  \"DateRange\": {\n    \"Start\": \"2023-11-07T05:31:56Z\",\n    \"End\": \"2023-11-07T05:31:56Z\"\n  }\n}")
  .asString();

{
  "Page": 123,
  "PageSize": 123,
  "Total": 123,
  "Items": [
    {
      "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>"
    }
  ],
  "Facets": {}
}

{
  "Errors": {},
  "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

​Request Body

​Example CURL request

​Response Parameters

​Example Response

​Rate Limits

Authorizations

Path Parameters

Body

Response

Request Parameters

Request Body

Example CURL request

Response Parameters

Example Response

Rate Limits