List Axle Configurations

Returns a list of Axle Configurations

Query Parameters

start_cursor string
The start cursor for Keyset pagination.
per_page integer
Possible values: >= 2 and <= 100
Default value: 50
The number of records per page to return.
filter object
The fields, operations, and values to filter the records by.
- active object
  eq string required
  Possible values: [true, false]
  Default value: true
- is_trailer object
  eq string required
  Possible values: [true, false]
  Default value: true
- vehicle_id object
  oneOf
  MOD1
  MOD2
  include string required
- axle_config_template_id object
  oneOf
  MOD1
  MOD2
  include string required
- name object
  oneOf
  MOD1
  MOD2
  like string required
- created_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- updated_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
sort object
The fields and direction to sort the results by.
- id string
  Possible values: [asc, desc]
  Default value: desc
- created_at string
  Possible values: [asc, desc]
- updated_at string
  Possible values: [asc, desc]

Responses

application/json

Schema
Example (from schema)

Schema

start_cursor string
The current start cursor of the records returned.
next_cursor string
The next cursor to retrieve the next page of records.
per_page integer
The maxumum number of records returned.
estimated_remaining_count integer
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set.
anyOf
MOD1
MOD2
MOD3
MOD4
MOD5
MOD6
MOD7
active object
eq string
Possible values: [true, false]
Default value: true
sorted_by object[]
The sorts applied to the returned record set.
anyOf
MOD1
MOD2
MOD3
updated_at string
Possible values: [asc, desc]
records object[]
id integer
name string
This Axle Configuration's name.
description string
This Axle Configuration's description.
axle_config_template_id integer
The Id of the AxleConfigTemplate associated with this Axle Config.
vehicle_id integer
The Id of the Vehicle associated with this Axle Config.
active boolean
Whether this is the Vehicle's current active Axle Configuration
axles_count integer
The count of Axles represented in this Axle Config.
is_trailer boolean
Whether or not this is Axle Config is for a trailer.
tire_positions_count integer
The count of tire positions represented in this Axle Config.
tires_count integer
The number of Tires represented in this Axle Config.
vehicle object
A Vehicle
id integer
name string
This vehicle's name.
color string
The color of this Vehicle.
license_plate string
The license plate number of this Vehicle.
vin string
The Vehicle Identification Number of this Vehicle.
year string
This Vehicle's model year.
make string
The name of this Vehicle's manufacturer.
model string
The name of the model of this Vehicle.
trim string
The trim level of this Vehicle.
registration_expiration_month integer
Possible values: <= 12
The month in which this Vehicle's registration expires.
registration_state string
The state, province, or territory in which this Vehicle is registered.
default_image_url_small string
The URL of a small-sized version of the default image for this Vehicle.

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "active": {
        "eq": "true"
      }
    },
    {
      "is_trailer": {
        "eq": "true"
      }
    },
    {
      "vehicle_id": {
        "include": "string"
      }
    },
    {
      "axle_config_template_id": {
        "include": "string"
      }
    },
    {
      "name": {
        "include": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "name": "4x4",
      "description": "4 wheel positions, 4 driven",
      "axle_config_template_id": 0,
      "vehicle_id": 0,
      "active": true,
      "axles_count": 0,
      "is_trailer": true,
      "tire_positions_count": 0,
      "tires_count": 0,
      "vehicle": {
        "id": 0,
        "name": "string",
        "color": "string",
        "license_plate": "string",
        "vin": "string",
        "year": "string",
        "make": "string",
        "model": "string",
        "trim": "string",
        "registration_expiration_month": 0,
        "registration_state": "string",
        "default_image_url_small": "string"
      }
    }
  ]
}

The format or parameters of the request was invalid

application/json

Schema
Example (from schema)

Schema

errors object
type
items string

{
  "errors": {}
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}