Search dispatch preferences

POST

api

{version}

dispatchpreferences

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/dispatchpreferences/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "DispatcherIds": [
    "<string>"
  ],
  "DriverIds": [
    "<string>"
  ],
  "TruckIds": [
    "<string>"
  ],
  "TrailerIds": [
    "<string>"
  ],
  "UpdatedAtStart": "2023-11-07T05:31:56Z",
  "UpdatedAtEnd": "2023-11-07T05:31:56Z"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    DispatcherIds: ['<string>'],
    DriverIds: ['<string>'],
    TruckIds: ['<string>'],
    TrailerIds: ['<string>'],
    UpdatedAtStart: '2023-11-07T05:31:56Z',
    UpdatedAtEnd: '2023-11-07T05:31:56Z'
  })
};

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

payload = {
    "DispatcherIds": ["<string>"],
    "DriverIds": ["<string>"],
    "TruckIds": ["<string>"],
    "TrailerIds": ["<string>"],
    "UpdatedAtStart": "2023-11-07T05:31:56Z",
    "UpdatedAtEnd": "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}/dispatchpreferences/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([
    'DispatcherIds' => [
        '<string>'
    ],
    'DriverIds' => [
        '<string>'
    ],
    'TruckIds' => [
        '<string>'
    ],
    'TrailerIds' => [
        '<string>'
    ],
    'UpdatedAtStart' => '2023-11-07T05:31:56Z',
    'UpdatedAtEnd' => '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}/dispatchpreferences/search"

	payload := strings.NewReader("{\n  \"DispatcherIds\": [\n    \"<string>\"\n  ],\n  \"DriverIds\": [\n    \"<string>\"\n  ],\n  \"TruckIds\": [\n    \"<string>\"\n  ],\n  \"TrailerIds\": [\n    \"<string>\"\n  ],\n  \"UpdatedAtStart\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAtEnd\": \"2023-11-07T05:31:56Z\"\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}/dispatchpreferences/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"DispatcherIds\": [\n    \"<string>\"\n  ],\n  \"DriverIds\": [\n    \"<string>\"\n  ],\n  \"TruckIds\": [\n    \"<string>\"\n  ],\n  \"TrailerIds\": [\n    \"<string>\"\n  ],\n  \"UpdatedAtStart\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAtEnd\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

[
  {
    "UpdatedAt": "2023-11-07T05:31:56Z",
    "DispatcherId": "<string>",
    "Driver1Id": "<string>",
    "Driver2Id": "<string>",
    "TruckId": "<string>",
    "TrailerId": "<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>"
}

This endpoint provides detailed information about dispatch preferences that match the search criteria, enabling efficient tracking and management of dispatcher, driver, truck, and trailer assignments.

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 Parameters

The following parameters are required in the request body:

Parameter	Type	Required	Description
DispatcherIds	Array of Strings	No	A list of dispatcher IDs to filter results.
DriverIds	Array of Strings	No	A list of driver IDs to filter results.
TruckIds	Array of Strings	No	A list of truck IDs to filter results.
TrailerIds	Array of Strings	No	A list of trailer IDs to filter results.
UpdatedAtStart	String (DateTime)	No	The start date-time for filtering updated dispatch data.
UpdatedAtEnd	String (DateTime)	No	The end date-time for filtering updated dispatch data.

Example CURL request

Use the current API version number and ensure you replace the Authorization header value with your actual Bearer token for the request:

curl --location 'https://integrations.alvys.com/api/p/v1/dispatchpreferences/search' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...' \
--header 'Content-Type: application/json' \
--data '{
  "DispatcherIds": ["2c551c41c840410ebcf34ba388749258"],
  "DriverIds": ["DR2517197559590084753"],
  "TruckIds": ["TR2517389363484408036"],
  "TrailerIds": ["TL2517274420190288696"],
  "UpdatedAtStart": "2025-03-01T00:00:00.000Z",
  "UpdatedAtEnd": "2025-03-03T23:59:59.999Z"
}'

Response Parameters

The following table lists the parameters included in the response for dispatch preferences requests.

Parameter	Type	Required	Description
UpdatedAt	String (DateTime)	No	The timestamp when the dispatch preference was last updated.
DispatcherId	String	No	The unique identifier of the dispatcher.
Driver1Id	String	No	The unique identifier of the primary driver.
Driver2Id	String	No	The unique identifier of the secondary driver.
TruckId	String	No	The unique identifier of the truck.
TrailerId	String	No	The unique identifier of the trailer.

Versioning

The version parameter in the URL path specifies which version of the API you are using. Including the version number ensures that your application interacts with the correct version of the API, providing stability and compatibility as the API evolves. For more information on how versioning works and how to include it in your requests, please refer to the Versioning page.

Example Response

[
  {
    "UpdatedAt": "2025-03-02T14:30:05+00:00",
    "DispatcherId": "2c551c41c840410ebcf34ba388749258",
    "Driver1Id": "DR2517197559590084753",
    "Driver2Id": "DR2518197559590084765",
    "TruckId": "TR2517389363484408036",
    "TrailerId": "TL2517274420190288696"
  },
  {
    "UpdatedAt": "2025-03-02T16:45:10+00:00",
    "DispatcherId": "3d671c41c840410ebcf34ba388749275",
    "Driver1Id": "DR2527197559590084754",
    "Driver2Id": "",
    "TruckId": "TR2527389363484408047",
    "TrailerId": "TL2527274420190288799"
  }
]

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 specifying the API version in the URL path and providing the necessary request body. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can fork our Public API Postman Collection directly. 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

DispatcherIds

string[] | null

DriverIds

string[] | null

TruckIds

string[] | null

TrailerIds

string[] | null

UpdatedAtStart

string<date-time> | null

UpdatedAtEnd

string<date-time> | null

Response

UpdatedAt

string<date-time>

required

DispatcherId

string | null

Driver1Id

string | null

Driver2Id

string | null

TruckId

string | null

TrailerId

string | null

⌘I

Search dispatch preferences

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/dispatchpreferences/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "DispatcherIds": [
    "<string>"
  ],
  "DriverIds": [
    "<string>"
  ],
  "TruckIds": [
    "<string>"
  ],
  "TrailerIds": [
    "<string>"
  ],
  "UpdatedAtStart": "2023-11-07T05:31:56Z",
  "UpdatedAtEnd": "2023-11-07T05:31:56Z"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    DispatcherIds: ['<string>'],
    DriverIds: ['<string>'],
    TruckIds: ['<string>'],
    TrailerIds: ['<string>'],
    UpdatedAtStart: '2023-11-07T05:31:56Z',
    UpdatedAtEnd: '2023-11-07T05:31:56Z'
  })
};

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

payload = {
    "DispatcherIds": ["<string>"],
    "DriverIds": ["<string>"],
    "TruckIds": ["<string>"],
    "TrailerIds": ["<string>"],
    "UpdatedAtStart": "2023-11-07T05:31:56Z",
    "UpdatedAtEnd": "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}/dispatchpreferences/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([
    'DispatcherIds' => [
        '<string>'
    ],
    'DriverIds' => [
        '<string>'
    ],
    'TruckIds' => [
        '<string>'
    ],
    'TrailerIds' => [
        '<string>'
    ],
    'UpdatedAtStart' => '2023-11-07T05:31:56Z',
    'UpdatedAtEnd' => '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}/dispatchpreferences/search"

	payload := strings.NewReader("{\n  \"DispatcherIds\": [\n    \"<string>\"\n  ],\n  \"DriverIds\": [\n    \"<string>\"\n  ],\n  \"TruckIds\": [\n    \"<string>\"\n  ],\n  \"TrailerIds\": [\n    \"<string>\"\n  ],\n  \"UpdatedAtStart\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAtEnd\": \"2023-11-07T05:31:56Z\"\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}/dispatchpreferences/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"DispatcherIds\": [\n    \"<string>\"\n  ],\n  \"DriverIds\": [\n    \"<string>\"\n  ],\n  \"TruckIds\": [\n    \"<string>\"\n  ],\n  \"TrailerIds\": [\n    \"<string>\"\n  ],\n  \"UpdatedAtStart\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAtEnd\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

[
  {
    "UpdatedAt": "2023-11-07T05:31:56Z",
    "DispatcherId": "<string>",
    "Driver1Id": "<string>",
    "Driver2Id": "<string>",
    "TruckId": "<string>",
    "TrailerId": "<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 Parameters

​Example CURL request

​Response Parameters

​Versioning

​Example Response

​Rate Limits

Authorizations

Path Parameters

Body

Response

Request Parameters

Request Body Parameters

Example CURL request

Response Parameters

Versioning

Example Response

Rate Limits