Retrieve Axle Configuration

GET 
https://secure.fleetio.com/api/v1/axle_configs/:id

Retrieve the details of an existing Axle Configuration.

Request

Path Parameters

id stringrequired

The Fleetio ID of the relevant Axle Configuration

Responses

200

OK

application/json

Schema

Schema

idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
account_idId (integer)required
Possible values: >= 1
namestringrequired
This Axle Configuration's name.
Example: 4x4
descriptionstringnullablerequired
This Axle Configuration's name.
Example: 4 wheel positions, 4 driven
vehicle_idId (integer)required
Possible values: >= 1
activebooleanrequired
Whether this is the Vehicle's current active Axle Configuration
axles object[]required
All Axles for this Axle Configuration
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
account_idId (integer)required
Possible values: >= 1
axle_config_idId (integer)
Possible values: >= 1
is_poweredboolean
Whether this Axle is powered
sequenceinteger
The Axle's sequence. The front-most Axle sequence is 0, the 2nd Axle sequence is 1, etc.
Example: 0
namestringrequired
The Axle's name.
Example: Front
type_codestring
The type of Axle ie steer, drive trailer, liftable, dead, etc.
Example: steer
tire_positions object[]
All Tire Positions for the Axle
Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
axle_idId (integer)
Possible values: >= 1
left_rightstring
Will be either left or right
inner_outerstringnullable
This only applies to 'dually' Axles, ie an Axle that has dual Tire Positions on each end of the Axle.
tire objectnullable
A Tire
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
part_idId (integer)
Possible values: >= 1
tire_position_idId (integer)
Possible values: >= 1
tread_depthfloatnullable
The Tread Depth of the Tire in 1/32 Inch
tread_depth_healthstring
The Tread Depth health.
Possible values: [unknown, normal, warning, low]
pressurefloatnullable
The Tire Pressure of the Tire in PSI
pressure_healthstring
The Tire Pressure health
Possible values: [unknown, normal, warning, low]
installed_atdate-time
current_meterfloat
The meter of the Tire
part objectnullable
numberstring
The part number being used for this Part within Fleetio.
descriptionstringnullable
A description of this Part.
default_image_urlstringnullable
tire_config object
aspect_ratiofloat
Aspect ratio of tire.
rim_diameterfloat
Rim diameter of tire.
load_indexfloat
Load index of tire.
metric_typestring
Metric type of tire.
Possible values: [EU, P, HL, T, LT, C, ST]
widthfloat
Width of tire.
constructionstring
Construction type of tire.
Possible values: [B, R, D]
speed_ratingstring
Speed rating of tire.
Possible values: [A1, A2, A3, A4, A5, A6, A7, A8, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V, W, Y]
factory_tread_depthfloat
factory_tread_depth support is currently in private beta.
Tread depth of tire in /32" when new, as specified by the manufacturer.
minimum_tread_depthfloat
minimum_tread_depth support is currently in private beta.
The legal minimum tread depth, in /32".
life_expectancyinteger
life_expectancy support is currently in private beta.
The Life Expectancy or “Warranty” of a tire is the expected meter range, usually measured in miles, of a given tire as specified by the manufacturer.
]
]

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "name": "4x4",
  "description": "4 wheel positions, 4 driven",
  "vehicle_id": 0,
  "active": true,
  "axles": [
    {
      "id": 1,
      "axle_config_id": 1,
      "name": "Front Axle",
      "sequence": 0,
      "type_code": "steer",
      "is_powered": true,
      "tire_positions": [
        {
          "id": 1,
          "axle_id": 1,
          "left_right": "left",
          "inner_outer": null,
          "tire": [
            {
              "id": 1,
              "part_id": null,
              "tire_position_id": 1,
              "tread_depth": 6,
              "tread_depth_health": "warning",
              "pressure": 28,
              "pressure_health": "normal",
              "current_meter": 4315,
              "part": null
            }
          ]
        },
        {
          "id": 2,
          "axle_id": 1,
          "left_right": "right",
          "inner_outer": null,
          "tire": [
            {
              "id": 2,
              "part_id": null,
              "tire_position_id": 2,
              "tread_depth": 4,
              "tread_depth_health": "low",
              "pressure": 34,
              "pressure_health": "normal",
              "current_meter": 4315,
              "part": null
            }
          ]
        }
      ]
    },
    {
      "id": 2,
      "axle_config_id": 1,
      "name": "Rear Axle",
      "sequence": 1,
      "rear_axle": "drive",
      "is_powered": true,
      "tire_positions": [
        {
          "id": 3,
          "axle_id": 2,
          "left_right": "left",
          "inner_outer": null,
          "tire": [
            {
              "id": 3,
              "part_id": null,
              "tire_position_id": 3,
              "tread_depth": 12,
              "tread_depth_health": "ok",
              "pressure": 30,
              "pressure_health": "ok",
              "current_meter": 4315,
              "part": null
            }
          ]
        },
        {
          "id": 4,
          "axle_id": 2,
          "left_right": "right",
          "inner_outer": null,
          "tire": [
            {
              "id": 4,
              "part_id": null,
              "tire_position_id": 4,
              "tread_depth": 15,
              "tread_depth_health": "normal",
              "pressure": null,
              "pressure_health": "unknown",
              "current_meter": 4315,
              "part": null
            }
          ]
        }
      ]
    }
  ]
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

404

The requested resource could not be located

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/axle_configs/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!