GET Api/v1/Vehicles?page={page}&pageSize={pageSize}&sort={sort}&order={order}

Returns a paged list of all Vehicles.

Request Information

URI Parameters

Name	Type	Additional information
Search	string	None.
TerminalId	Collection of string	None.
Deleted	boolean	None.
page	integer	Default value is 1
pageSize	integer	Default value is 25
sort	string	Default value is name
order	string	Default value is desc

Body Parameters

None.

Response Information

Resource Description

PagedListOfVehicleViewModel

Name	Type	Additional information
Data	Collection of VehicleViewModel	None.
Page	integer	None.
PageSize	integer	None.
PageCount	integer	None.
Total	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "data": [
    {
      "pk": 1,
      "number": "sample string 2",
      "licensePlate": "sample string 3",
      "odometer": 4.0,
      "trailer": "sample string 5",
      "overrideCompanyAutoDutyStatusSetting": true,
      "autoDutyStatusDisabled": true,
      "hosEnabled": true,
      "terminal": {
        "id": 1,
        "publicId": "sample string 2",
        "name": "sample string 3",
        "address": {
          "id": 1,
          "addressLine1": "sample string 2",
          "addressLine2": "sample string 3",
          "addressLine3": "sample string 4",
          "city": "sample string 5",
          "stateProvince": "sample string 6",
          "country": "sample string 7",
          "postalCode": "sample string 8"
        },
        "organization": {
          "id": 1,
          "name": "sample string 2",
          "address": {
            "id": 1,
            "addressLine1": "sample string 2",
            "addressLine2": "sample string 3",
            "addressLine3": "sample string 4",
            "city": "sample string 5",
            "stateProvince": "sample string 6",
            "country": "sample string 7",
            "postalCode": "sample string 8"
          },
          "usDotCompanyName": "sample string 3",
          "usDotNumber": "sample string 4",
          "nscCompanyName": "sample string 5",
          "nscNumber": "sample string 6"
        },
        "timeZoneId": "sample string 4",
        "observesDst": true,
        "timeZoneName": "sample string 6",
        "timeZoneStandardName": "sample string 7",
        "timeZoneDaylightName": "sample string 8",
        "timeZoneTzid": "sample string 9",
        "startHour": "00:00:00.1234567",
        "personalConveyanceSettings": {
          "usKm": 1.0,
          "usWarningThresholdKm": 2.0,
          "canadaKm": 3.0,
          "canadaWarningThresholdKm": 4.0
        }
      },
      "organization": {
        "id": 1,
        "name": "sample string 2",
        "address": {
          "id": 1,
          "addressLine1": "sample string 2",
          "addressLine2": "sample string 3",
          "addressLine3": "sample string 4",
          "city": "sample string 5",
          "stateProvince": "sample string 6",
          "country": "sample string 7",
          "postalCode": "sample string 8"
        },
        "usDotCompanyName": "sample string 3",
        "usDotNumber": "sample string 4",
        "nscCompanyName": "sample string 5",
        "nscNumber": "sample string 6"
      }
    },
    {
      "pk": 1,
      "number": "sample string 2",
      "licensePlate": "sample string 3",
      "odometer": 4.0,
      "trailer": "sample string 5",
      "overrideCompanyAutoDutyStatusSetting": true,
      "autoDutyStatusDisabled": true,
      "hosEnabled": true,
      "terminal": {
        "id": 1,
        "publicId": "sample string 2",
        "name": "sample string 3",
        "address": {
          "id": 1,
          "addressLine1": "sample string 2",
          "addressLine2": "sample string 3",
          "addressLine3": "sample string 4",
          "city": "sample string 5",
          "stateProvince": "sample string 6",
          "country": "sample string 7",
          "postalCode": "sample string 8"
        },
        "organization": {
          "id": 1,
          "name": "sample string 2",
          "address": {
            "id": 1,
            "addressLine1": "sample string 2",
            "addressLine2": "sample string 3",
            "addressLine3": "sample string 4",
            "city": "sample string 5",
            "stateProvince": "sample string 6",
            "country": "sample string 7",
            "postalCode": "sample string 8"
          },
          "usDotCompanyName": "sample string 3",
          "usDotNumber": "sample string 4",
          "nscCompanyName": "sample string 5",
          "nscNumber": "sample string 6"
        },
        "timeZoneId": "sample string 4",
        "observesDst": true,
        "timeZoneName": "sample string 6",
        "timeZoneStandardName": "sample string 7",
        "timeZoneDaylightName": "sample string 8",
        "timeZoneTzid": "sample string 9",
        "startHour": "00:00:00.1234567",
        "personalConveyanceSettings": {
          "usKm": 1.0,
          "usWarningThresholdKm": 2.0,
          "canadaKm": 3.0,
          "canadaWarningThresholdKm": 4.0
        }
      },
      "organization": {
        "id": 1,
        "name": "sample string 2",
        "address": {
          "id": 1,
          "addressLine1": "sample string 2",
          "addressLine2": "sample string 3",
          "addressLine3": "sample string 4",
          "city": "sample string 5",
          "stateProvince": "sample string 6",
          "country": "sample string 7",
          "postalCode": "sample string 8"
        },
        "usDotCompanyName": "sample string 3",
        "usDotNumber": "sample string 4",
        "nscCompanyName": "sample string 5",
        "nscNumber": "sample string 6"
      }
    }
  ],
  "page": 1,
  "pageSize": 2,
  "pageCount": 3,
  "total": 4
}