Search driver events

POST

api

{version}

drivers

events

Search driver events

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

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

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

payload = {
    "StartDate": "2023-11-07T05:31:56Z",
    "DriverIds": ["<string>"],
    "EndDate": "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}/drivers/events/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([
    'StartDate' => '2023-11-07T05:31:56Z',
    'DriverIds' => [
        '<string>'
    ],
    'EndDate' => '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}/drivers/events/search"

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

[
  {
    "Id": "<string>",
    "Name": "<string>",
    "Type": "<string>",
    "SubsidiaryId": "<string>",
    "Status": "<string>",
    "Notes": [
      {
        "id": "<string>",
        "Description": "<string>",
        "NoteType": "<string>",
        "User": "<string>",
        "Time": "2023-11-07T05:31:56Z",
        "UserId": "<string>"
      }
    ],
    "CreatedAt": "2023-11-07T05:31:56Z",
    "IsActive": true,
    "EmployeeId": "<string>",
    "PhoneNumber": "<string>",
    "UserId": "<string>",
    "Email": "<string>",
    "Address": {
      "Street": "<string>",
      "City": "<string>",
      "State": "<string>",
      "ZipCode": "<string>"
    },
    "LicenseNum": "<string>",
    "LicenseState": "<string>",
    "LicenseCountry": "<string>",
    "LicenseExpiresAt": "2023-11-07T05:31:56Z",
    "MedicalExpiresAt": "2023-11-07T05:31:56Z",
    "HiredAt": "2023-11-07T05:31:56Z",
    "TerminatedAt": "2023-11-07T05:31:56Z",
    "Fleet": {
      "Id": "<string>",
      "Name": "<string>",
      "InvoiceNumberPrefix": "<string>"
    },
    "References": [
      {
        "Name": "<string>",
        "Value": "<string>",
        "Id": "<string>",
        "ReferenceId": "<string>",
        "Type": "<string>",
        "Access": "<string>",
        "Origin": "<string>"
      }
    ]
  }
]

{
  "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>"
}

This endpoint provides detailed information about driver events that match the search criteria, enabling efficient tracking and management of driver-related activities.

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
StartDate	String (DateTime)	Yes	The start date-time for the event search range.
EndDate	String (DateTime)	No	The end date-time for the event search range.
DriverIds	Array of Strings	Yes	The list of driver IDs to filter driver events.

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/drivers/events/search' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...' \
--header 'Content-Type: application/json' \
--data '{
  "StartDate": "2025-02-06T06:50:20.471Z",
  "EndDate": "2025-02-06T06:50:20.471Z",
  "DriverIds": [
    "string"
  ]
}'

Response Parameters

The following table lists the parameters included in the response for driver events requests.

Parameter	Type	Required	Description
Id	String	Yes	The unique identifier of the driver event.
DriverId	String	Yes	The unique identifier of the driver.
EventType	String	Yes	The type of event (e.g., Vacation, Restart, Other).
Description	String	No	A detailed description of the event.
StartDate	String (DateTime)	Yes	The start date-time of the event.
EndDate	String (DateTime)	Yes	The end date-time of the event.
Address	Object	No	The location details associated with the event.
Address.Street	String	No	The street address where the event occurred.
Address.City	String	No	The city where the event took place.
Address.State	String	No	The state where the event took place.
Address.ZipCode	String	No	The ZIP code of the event location.
CreatedBy	String	Yes	The user who created the event record.
CreatedAt	String (DateTime)	Yes	The timestamp for when the event was created.

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

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 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

StartDate

string<date-time>

required

DriverIds

string[]

required

EndDate

string<date-time> | null

Response

string

required

Name

string

required

Type

string

required

SubsidiaryId

string

required

Status

string

required

Notes

object[]

required

Show child attributes

CreatedAt

string<date-time>

required

IsActive

boolean

required

EmployeeId

string | null

PhoneNumber

string | null

UserId

string | null

Address

object | null

Show child attributes

LicenseNum

string | null

LicenseState

string | null

LicenseCountry

string | null

LicenseExpiresAt

string<date-time> | null

MedicalExpiresAt

string<date-time> | null

HiredAt

string<date-time> | null

TerminatedAt

string<date-time> | null

Fleet

object | null

Show child attributes

References

object[] | null

Show child attributes

⌘I

Search driver events

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

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

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

payload = {
    "StartDate": "2023-11-07T05:31:56Z",
    "DriverIds": ["<string>"],
    "EndDate": "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}/drivers/events/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([
    'StartDate' => '2023-11-07T05:31:56Z',
    'DriverIds' => [
        '<string>'
    ],
    'EndDate' => '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}/drivers/events/search"

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

[
  {
    "Id": "<string>",
    "Name": "<string>",
    "Type": "<string>",
    "SubsidiaryId": "<string>",
    "Status": "<string>",
    "Notes": [
      {
        "id": "<string>",
        "Description": "<string>",
        "NoteType": "<string>",
        "User": "<string>",
        "Time": "2023-11-07T05:31:56Z",
        "UserId": "<string>"
      }
    ],
    "CreatedAt": "2023-11-07T05:31:56Z",
    "IsActive": true,
    "EmployeeId": "<string>",
    "PhoneNumber": "<string>",
    "UserId": "<string>",
    "Email": "<string>",
    "Address": {
      "Street": "<string>",
      "City": "<string>",
      "State": "<string>",
      "ZipCode": "<string>"
    },
    "LicenseNum": "<string>",
    "LicenseState": "<string>",
    "LicenseCountry": "<string>",
    "LicenseExpiresAt": "2023-11-07T05:31:56Z",
    "MedicalExpiresAt": "2023-11-07T05:31:56Z",
    "HiredAt": "2023-11-07T05:31:56Z",
    "TerminatedAt": "2023-11-07T05:31:56Z",
    "Fleet": {
      "Id": "<string>",
      "Name": "<string>",
      "InvoiceNumberPrefix": "<string>"
    },
    "References": [
      {
        "Name": "<string>",
        "Value": "<string>",
        "Id": "<string>",
        "ReferenceId": "<string>",
        "Type": "<string>",
        "Access": "<string>",
        "Origin": "<string>"
      }
    ]
  }
]

{
  "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 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