Introduction

Welcome to the Axscend API! You can use our API to access Axscend API endpoints, which can get information on various objects in our database.

Fair Use

To ensure a consistent service for all of our users, we enforce a limit of 60 requests per minute, after which requests will be automatically rejected with error code 429. If you believe your application will need more than that many requests per minute, please contact your Axscend representative to discuss additional options. Frequent exceeding of the limits described in this policy without prior agreement from Axscend may result in access to the API being withdrawn.

Development Server

Axscend make available the staging server to provide customers the ability to test their applications on a ‘live-like’ environment without risking their business’ live data. We reserve the right to remove access to this service at any time.

Please contact your Axscend representative if you require additional users granting access to the staging environment.

Please be aware that due to the nature of the staging environment, we sometimes have unplanned downtime. We aim to keep any downtime to a minimum.

The data on the staging environment is refreshed periodically to provide you with fresh data to work with on a regular basis. During these refreshes, the server may be unavailable for up to 24 hours whilst data is restored. We may also choose to delay these refreshes if requested by a relevant party. If you have an issue with the currently loaded dataset on the staging server and need it to be refreshed (or not), please contact your Axscend representative to discuss available options.

Technical Specification

Base URL

All requests are made to the same base URL, with only the route or path portion of the URL changing.

Live URL Available on request

Development URL https://api.staging.axscend.com/v3

Parameters

Unexpected Parameters

For each request, the Axscend API will only accept parameters specified in the document below. If any additional parameters are passed to the API, the request will be rejected with error code 400 (see below).

Boolean Parameters

To avoid any unexpected responses due to miss-parsing of the parameter, we ask that you use numeric boolean values (1 for true and 0 for false) where a boolean parameter is expected.

Response Format

Responses are returned in JSON format and use standard HTTP response codes. Below is a list of common HTTP responses and descriptions of when they will be used, which apply to all routes unless otherwise specified:

200 – Successful Response

401 – Unauthorized

Returned when you do not have permission to access the specified route.

403 – Unauthenticated

Returned when you cannot perform the action on the given resource.

400 – Bad Request

Returned when an unexpected parameter has been given. You may also be provided with the following details about the error:

Key	Value
message	Description of the problem
errors	JSON object describing the problems with the request. For each key-value pair, each key is a parameter sent in the request which was not accepted, and each value is a textual description of the problem.

422 – Unprocessable Entity

Returned when an expected parameter has been given with an unprocessable value. You may also be provided with the following details about the error:

Key	Value
message	Description of the problem
errors	JSON object describing the problems with the request. For each key-value pair, each key is a parameter sent in the request which was not accepted, and each value is a textual description of the problem.

A more complete list of response codes can be found in the Errors section below.

Errors

The Axscend API uses the following HTTP error codes to signify a problem with the request, or making the response.

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- You do not have permission to view the requested item.
404	Not Found -- The specified item could not be found.
405	Method Not Allowed -- You tried to access an item using an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The item requested has been removed.
429	Too Many Requests -- You have reached Axscend's API limit.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Authentication

Access to the API is not session-based, rather an API token should be sent in the header of each request. To retrieve a token, a call must be made to the API’s login URL with valid credentials.

Request

URL	/login
Method	POST
Parameters	email The e-mail address associated with the Axscend account password The password for the given account

Response - Success

Key	Value
Response Code	200
result	true
api_token	Your API Token e.g. ABCDE2NWiplokHkZbfjNxHCLe8b5RdFtGrmHcglMC12345

Response – Failure

Key	Value
Response Code	403
result	false

---

Calls to routes requiring the authentication should include the captured API Token in the HTTP header as follows:

Header	Value
Authorization	Bearer {API Token} e.g. Bearer ABCDE2NWiplokHkZbfjNxHCLe8b5RdFtGrmHcglMC12345

Request Headers

We recommend including the following HTTP headers with most requests (with some exceptions described with specific cases) to allow the correct responses to be generated.

Key	Value
Authorization	Bearer {API Token}
Accept	application/json
Content-Type	application/json

Asset

Vehicles and Trailers are described within the system as assets. Assets are uniquely identified by an ID. For users with large fleets, we recommend using the pagination parameters to split results into smaller chunks to improve response times.

Asset Index Request

Request

URL	new/asset/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/new/asset/

Asset Status Filter Values

These status values are used to determine the health of the asset and/or feature. The value should generally be treated as a bitmask that may contain multiple statuses for the feature (e.g. TPMS status of 6 would indicate that some sensors are critical and others are missing/warning).

FILTER	VALUE	DESCRIPTION
Good	8	Everything is okay and it passes all defined checks.
Warning	4	There are issues which indicate there could be a problem, but it should be confirmed at the next available opportunity.
Critical	2	There is a known problem, this should be looked at as soon as possible.
Unknown	0	We have no information on this status. We have not yet received data, likely because the asset does not have a connect unit fitted or because the unit is not configured to send that data back.

Parameters

Filters

KEY	TYPE	DESCRIPTION
asset_name	string	Filter by the Asset's name. Will return all Assets that have a name that contains the given string
asset_id	string	Filter by the Asset's ID. Will return all Assets that have an ID that contains the given string
asset_ids	array. Each item in the array must be an integer.	Filter by the Asset's ID. Will return all Assets that have an ID within the given array.
esn	string	Filter by the Asset's esn. Will return all Assets that have an esn that contains the given string
esn_like	string	Filter by the Asset's esn like. Will return all Assets that have an esn like that contains the given string
chassis_number	string	Filter by the Asset's chassis number. Will return all Assets that have a chassis number that contains the given string
similar_chassis_number	string	Filter by an Asset's chassis number. Will return all Asset's that have a similar chassis number to the given string.
application_version	string	Filter by the Asset's application version. Will return all Assets that have an application version that contains the given string
hardware_type	string	Filter by the Asset's hardware type. Will return all Assets that have a hardware type that contains the given string
hardware_types	array. Each item in the array must be a string.	Filter by the Asset's hardware type. Will return all Assets that have a hardware type within the given array.
hardware_rev	string	Filter by the Asset's hardware revision. Will return all Assets that have a hardware revision that contains the given string
hardware_revs	array. Each item in the array must be a string.	Filter by the Asset's hardware revision. Will return all Assets that have a hardware revision within the given array.
ebs_type	string	Filter by the Asset's ebs type. Will return all Assets that have an ebs type that contains the given string
dvs_permit_information	string, nullable	Filter by the Asset's dvs permit information. Will return all Asset's that have dvs permit information containing the given string.
adr	string, nullable	Filter by the Asset's adr. Will return all Assets that have an adr that contains the given string, nullable
ebs_types	array. Each item in the array must be a string.	Filter by the Asset's ebs type. Will return all Assets that have an ebs type within the given array.
dvs_permit_holder_ids	array. Each item in the array must be integer, exists:DvsPermitHolder.	Filter by the Asset's dvs permit holder id. Will return all Assets that have a dvs permit holder id within the given array.
leaseholder_ids	array. Each item in the array must be integer, exists:Leaseholder.	Filter by the Asset's leaseholder id. Will return all Assets that have a leaseholder id within the given array.
leaseholder_id	integer, exists:Leaseholder	Filter by the Asset's leaseholder id. Will return all Assets with the given leaseholder id. You can see what leaseholder ids you have access to (including the associated objects) by calling the leaseholder index route.
dvs_permit_holder_id	integer, exists:DvsPermitHolder	Filter by the Asset's dvs permit holder id. Will return all Assets with the given dvs permit holder id.
dvs_permit_star_rating	nullable, integer	Filter by the Asset's dvs permit star rating. Will return all Assets that have a dvs permit star rating that contains the given nullable, integer
dvs_permit_star_ratings	array. Each item in the array must be an integer.	Filter by the Asset's dvs permit star rating. Will return all Assets that have a dvs permit star rating within the given array.
brake_type	string	Filter by the Asset's brake type. Will return all Assets that have a brake type that contains the given string
brake_types	array. Each item in the array must be a string.	Filter by the Asset's brake type. Will return all Assets that have a brake type within the given array.
ebs_should_be_connected	boolean	Filter by whether the Asset is ebs should be connected. If true, will return all Assets which are ebs should be connected. If false, will return all Assets which are not ebs should be connected.
axle_manufacturer_id	integer, exists:AxleManufacturer	Filter by the Asset's axle manufacturer id. Will return all Assets with the given axle manufacturer id. You can see what axle manufacturer ids you have access to (including the associated objects) by calling the axle manufacturer index route.
axle_manufacturer_ids	array. Each item in the array must be exists:AxleManufacturer.	Filter by the Asset's axle manufacturer id. Will return all Assets that have an axle manufacturer id within the given array.
asset_build_id	integer, exists:AssetBuild	Filter by the Asset's asset build id. Will return all Assets with the given asset build id.
ebpms_configuration_id	nullable, integer, exists:EbpmsConfiguration	Filter by the Asset's ebpms configuration id. Will return all Assets with the given ebpms configuration id.
ebpms_configuration_ids	array. Each item in the array must be integer, exists:EbpmsConfiguration. The value can also be NULL..	Filter by the Asset's ebpms configuration id. Will return all Assets that have an ebpms configuration id within the given array.
proximity_distance_m	integer, gt:0	Filter by the Asset's proximity distance (in Metres) . Will return all Assets that have a proximity distance (in Metres) that contains the given integer, gt:0
proximity_latitude	between:-90,90	Filter by the Asset's proximity latitude. Will return all Assets that have a proximity latitude that contains the given between:-90,90
proximity_longitude	between:-180,180	Filter by the Asset's proximity longitude. Will return all Assets that have a proximity longitude that contains the given between:-180,180
ministry_number	string	Filter by the Asset's ministry number. Will return all Assets that have a ministry number that contains the given string
ministry_numbers	array. Each item in the array must be a string.	Filter by the Asset's ministry number. Will return all Assets that have a ministry number within the given array.
yard_location	string	Filter by the Asset's yard location. Will return all Assets that have a yard location that contains the given string
yard_locations	array. Each item in the array must be a string.	Filter by the Asset's yard location. Will return all Assets that have a yard location within the given array.
company_id	exists:Company	Filter by the Asset's company id. Will return all Assets with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
company_ids	array. Each item in the array must be exists:Company.	Filter by the Asset's company id. Will return all Assets that have a company id within the given array.
owner_id	exists:Company	Filter by the Asset's owner id. Will return all Assets with the given owner id. You can see what owner ids you have access to (including the associated objects) by calling the owner index route.
owner_ids	array. Each item in the array must be exists:Company.	Filter by the Asset's owner id. Will return all Assets that have an owner id within the given array.
manufacturer_id	exists:Company	Filter by the Asset's manufacturer id. Will return all Assets with the given manufacturer id. You can see what manufacturer ids you have access to (including the associated objects) by calling the manufacturer index route.
manufacturer_ids	array. Each item in the array must be exists:Company.	Filter by the Asset's manufacturer id. Will return all Assets that have a manufacturer id within the given array.
model_id	exists:Model	Filter by the Asset's model id. Will return all Assets with the given model id.
model_ids	array. Each item in the array must be exists:Model.	Filter by the Asset's model id. Will return all Assets that have a model id within the given array.
group_id	exists:Group	Filter by the Asset's group id. Will return all Assets with the given group id. You can see what group ids you have access to (including the associated objects) by calling the group index route.
group_ids	array. Each item in the array must be integer, exists:Group.	Filter by the Asset's group id. Will return all Assets that have a group id within the given array.
type_id	exists:AssetType	Filter by the Asset's type id. Will return all Assets with the given type id. You can see what type ids you have access to (including the associated objects) by calling the type index route.
type_ids	array. Each item in the array must be exists:AssetType.	Filter by the Asset's type id. Will return all Assets that have a type id within the given array.
sub_type_ids	array. Each item in the array must be exists:AssetSubType.	Filter by the Asset's sub type id. Will return all Assets that have a sub type id within the given array.
asset_type_ids	array, exists:AssetType	Filter by the Asset's asset type id. Will return all Assets that have an asset type id within the given array.
location	string	Filter by the Asset's location (or POI). Will return all Assets that have a location (or POI) that contains the given string
has_feature_vor	boolean	Filter by whether the Asset has the vor feature enabled. If true, will return all Assets which have the vor feature enabled. If false, will return all Assets which do not have the vor feature enabled.
has_feature_load	boolean	Filter by whether the Asset has the load feature enabled. If true, will return all Assets which have the load feature enabled. If false, will return all Assets which do not have the load feature enabled.
has_feature_ebpms	boolean	Filter by whether the Asset has the EBPMS feature enabled. If true, will return all Assets which have the EBPMS feature enabled. If false, will return all Assets which do not have the EBPMS feature enabled.
has_feature_tpms	boolean	Filter by whether the Asset has the TPMS feature enabled. If true, will return all Assets which have the TPMS feature enabled. If false, will return all Assets which do not have the TPMS feature enabled.
has_feature_dtc	boolean	Filter by whether the Asset has the dtc feature enabled. If true, will return all Assets which have the dtc feature enabled. If false, will return all Assets which do not have the dtc feature enabled.
has_feature_refrigeration	boolean	Filter by whether the Asset has the refrigeration feature enabled. If true, will return all Assets which have the refrigeration feature enabled. If false, will return all Assets which do not have the refrigeration feature enabled.
has_feature_temperature	boolean	Filter by whether the Asset has the temperature feature enabled. If true, will return all Assets which have the temperature feature enabled. If false, will return all Assets which do not have the temperature feature enabled.
has_feature_lighting	boolean	Filter by whether the Asset has the lighting feature enabled. If true, will return all Assets which have the lighting feature enabled. If false, will return all Assets which do not have the lighting feature enabled.
has_feature_maintenance	boolean	Filter by whether the Asset has the maintenance feature enabled. If true, will return all Assets which have the maintenance feature enabled. If false, will return all Assets which do not have the maintenance feature enabled.
has_rdc_enabled	boolean	Filter by whether the Asset has rdc enabled. If true, will return all Assets which have rdc enabled. If false, will return all Assets which do not have rdc enabled.
has_rdc_stats_enabled	boolean	Filter by whether the Asset has rdc stats enabled. If true, will return all Assets which have rdc stats enabled. If false, will return all Assets which do not have rdc stats enabled.
has_axle_gateway_enabled	boolean	Filter by whether the Asset has axle gateway enabled. If true, will return all Assets which have axle gateway enabled. If false, will return all Assets which do not have axle gateway enabled.
has_door_switch_enabled	boolean	Filter by whether the Asset has door switch enabled. If true, will return all Assets which have door switch enabled. If false, will return all Assets which do not have door switch enabled.
has_decommissioned_timestamp	boolean	Filter by whether the Asset has decommissioned timestamp monitoring enabled. If true, will return all Assets which have decommissioned timestamp monitoring enabled. If false, will return all Assets which do not have decommissioned timestamp monitoring enabled.
has_fuel_efficiency	boolean	Filter by whether the Asset has fuel efficiency monitoring enabled. If true, will return all Assets which have fuel efficiency monitoring enabled. If false, will return all Assets which do not have fuel efficiency monitoring enabled.
has_recent_movement	boolean	Filter by whether the Asset has recent movement monitoring enabled. If true, will return all Assets which have recent movement monitoring enabled. If false, will return all Assets which do not have recent movement monitoring enabled.
wildcard	string, nullable	Filter by the any Asset field using the Wildcard. Will return all Assets where the given string matches any of the Asset field values.
overall_status	integer, gte:0	Filter by the Asset's overall status. Will return all Assets that have an overall status that contains the given integer. For more information on this, please refer to the 'Asset Status Filter Values' table above.
vor_status	integer, gte:0	Filter by the Asset's vor status. Will return all Assets that have a vor status that contains the given integer, gte:0
vor_sub_status	integer, gte:0	Filter by the Asset's vor sub status. Will return all Assets that have a vor sub status that contains the given integer, gte:0
ebpms_status	integer, gte:0	Filter by the Asset's ebpms status. Will return all Assets that have an ebpms status that contains the given integer, gte:0
tpms_status	integer, gte:0	Filter by the Asset's tpms status. Will return all Assets that have a tpms status that contains the given integer, gte:0
axle_status	integer, gte:0	Filter by the Asset's axle status. Will return all Assets that have an axle status that contains the given integer, gte:0
lighting_status	integer, gte:0	Filter by the Asset's lighting status. Will return all Assets that have a lighting status that contains the given integer, gte:0
maintenance_status	integer, gte:0	Filter by the Asset's maintenance status. Will return all Assets that have a maintenance status that contains the given integer, gte:0
load_status	integer, gte:0	Filter by the Asset's load status. Will return all Assets that have a load status that contains the given integer, gte:0
dtc_status	integer, gte:0	Filter by the Asset's dtc status. Will return all Assets that have a dtc status that contains the given integer, gte:0
iso7638_status	integer, gte:0	Filter by the Asset's iso7638 status. Will return all Assets that have an iso7638 status that contains the given integer, gte:0
overall_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's overall status. Will return all Assets that have an overall status within the given array.
vor_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's vor status. Will return all Assets that have a vor status within the given array.
vor_sub_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's vor sub status. Will return all Assets that have a vor sub status within the given array.
ebpms_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's ebpms status. Will return all Assets that have an ebpms status within the given array.
tpms_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's tpms status. Will return all Assets that have a tpms status within the given array.
axle_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's axle status. Will return all Assets that have an axle status within the given array.
lighting_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's lighting status. Will return all Assets that have a lighting status within the given array.
maintenance_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's maintenance status. Will return all Assets that have a maintenance status within the given array.
load_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's load status. Will return all Assets that have a load status within the given array.
dtc_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's dtc status. Will return all Assets that have a dtc status within the given array.
iso7638_statuses	array. Each item in the array must be integer, gte:0.	Filter by the Asset's iso7638 status. Will return all Assets that have an iso7638 status within the given array.
load_change_percent	integer	Filter by the Asset's load change percent. Will return all Assets that have a load change percent that contains the given integer
load_change_inequality	string, in:>,<,>=,<=	Filter by the Asset's load change inequality. Will return all Assets that have a load change inequality that contains the given string, in:>,<,>=,<=
has_note	boolean	Filter by whether the Asset has a note. If true, will return all Assets which have a note filled out. If false, will return all Assets which do not have a note.
has_dvs_permit_information	boolean	Filter by whether the Asset has it's DVS permit information filled in. If true, will return all Assets which DVS permit information. If false, will return all Assets which do not have DVS permit information.
has_en_12642xl_certified	boolean	Filter by whether the Asset has en 12642xl certified monitoring enabled. If true, will return all Assets which have en 12642xl certified monitoring enabled. If false, will return all Assets which do not have en 12642xl certified monitoring enabled.
has_dcu	boolean	Filter by whether the Asset has a DCU. If true, will return all Assets which have a DCU. If false, will return all Assets which do not have a DCU.
decommissioned	boolean	Filter by whether the Asset is decommissioned. If true, will return all Assets which are decommissioned. If false, will return all Assets which are not decommissioned.
virtual	boolean	Filter by whether the Asset is virtual. If true, will return all Assets which are virtual. If false, will return all Assets which are not virtual.
is_coupled	boolean	Filter by whether the Asset is coupled. If true, will return all Assets which are coupled. If false, will return all Assets which are not coupled.
is_waiting_unload	boolean	Filter by whether the Asset is waiting unload. If true, will return all Assets which are waiting unload. If false, will return all Assets which are not waiting unload.
earned_recognition_enabled	boolean	Filter by whether the Asset is earned recognition enabled. If true, will return all Assets which are earned recognition enabled. If false, will return all Assets which are not earned recognition enabled.
lookup_enabled	boolean	Filter by whether the Asset is lookup enabled. If true, will return all Assets which are lookup enabled. If false, will return all Assets which are not lookup enabled.
has_open_defects	boolean	Filter by whether the Asset has open defect monitoring enabled. If true, will return all Assets which have open defect monitoring enabled. If false, will return all Assets which do not have open defect monitoring enabled.
has_missing_tpms_sensors	boolean	Filter by whether the Asset has missing tpms sensor monitoring enabled. If true, will return all Assets which have missing tpms sensor monitoring enabled. If false, will return all Assets which do not have missing tpms sensor monitoring enabled.
due_maintenance	boolean	Filter by whether the Asset is due maintenance. If true, will return all Assets which are due maintenance. If false, will return all Assets which are not due maintenance.
overdue_maintenance	boolean	Filter by whether the Asset is overdue maintenance. If true, will return all Assets which are overdue maintenance. If false, will return all Assets which are not overdue maintenance.
has_maintenance_schedule	boolean	Filter by whether the Asset has maintenance schedules. If true, will return all Assets which have maintenance schedules. If false, will return all Assets which do not have maintenance schedules.
due_adr_inspection	boolean	Filter by whether the Asset is due adr inspection. If true, will return all Assets which are due adr inspection. If false, will return all Assets which are not due adr inspection.
has_adr_inspection_schedule	boolean	Filter by whether the Asset has adr inspection schedules. If true, will return all Assets which have adr inspection schedules. If false, will return all Assets which do not have adr inspection schedules.
due_brake_test	boolean	Filter by whether the Asset is due a brake test. If true, will return all Assets which are due a brake test. If false, will return all Assets which are not due a brake test.
has_brake_test_schedule	boolean	Filter by whether the Asset has brake test schedules. If true, will return all Assets which have brake test schedules. If false, will return all Assets which do not have brake test schedules.
due_fridge_service	boolean	Filter by whether the Asset is due a fridge service. If true, will return all Assets which are due a fridge service. If false, will return all Assets which are not due a fridge service.
has_fridge_service_schedule	boolean	Filter by whether the Asset has fridge service schedules. If true, will return all Assets which have fridge service schedules. If false, will return all Assets which do not have fridge service schedules.
due_inspection	boolean	Filter by whether the Asset is due an inspection. If true, will return all Assets which are due an inspection. If false, will return all Assets which are not due an inspection.
has_inspection_schedule	boolean	Filter by whether the Asset has inspection schedules. If true, will return all Assets which have inspection schedules. If false, will return all Assets which do not have inspection schedules.
due_insurance	boolean	Filter by whether the Asset is due insurance. If true, will return all Assets which are due insurance. If false, will return all Assets which are not due insurance.
has_insurance_schedule	boolean	Filter by whether the Asset has insurance schedules. If true, will return all Assets which have insurance schedules. If false, will return all Assets which do not have insurance schedules.
due_loler_inspection	boolean	Filter by whether the Asset is due loler inspection. If true, will return all Assets which are due loler inspection. If false, will return all Assets which are not due loler inspection.
has_loler_inspection_schedule	boolean	Filter by whether the Asset has loler inspection schedules. If true, will return all Assets which have loler inspection schedules. If false, will return all Assets which do not have loler inspection schedules.
due_mot	boolean	Filter by whether the Asset is due an MOT. If true, will return all Assets which are due an MOT. If false, will return all Assets which are not due an MOT.
has_mot_schedule	boolean	Filter by whether the Asset has mot schedules. If true, will return all Assets which have mot schedules. If false, will return all Assets which do not have mot schedules.
due_road_fund_licence	boolean	Filter by whether the Asset is due road fund licence. If true, will return all Assets which are due road fund licence. If false, will return all Assets which are not due road fund licence.
has_road_fund_licence_schedule	boolean	Filter by whether the Asset has road fund licence schedules. If true, will return all Assets which have road fund licence schedules. If false, will return all Assets which do not have road fund licence schedules.
due_sanitation	boolean	Filter by whether the Asset is due sanitation. If true, will return all Assets which are due sanitation. If false, will return all Assets which are not due sanitation.
has_sanitation_schedule	boolean	Filter by whether the Asset has sanitation schedules. If true, will return all Assets which have sanitation schedules. If false, will return all Assets which do not have sanitation schedules.
due_tacho_calibration	boolean	Filter by whether the Asset is due tacho calibration. If true, will return all Assets which are due tacho calibration. If false, will return all Assets which are not due tacho calibration.
has_tacho_calibration_schedule	boolean	Filter by whether the Asset has tacho calibration schedules. If true, will return all Assets which have tacho calibration schedules. If false, will return all Assets which do not have tacho calibration schedules.
due_tail_lift_inspection	boolean	Filter by whether the Asset is due tail lift inspection. If true, will return all Assets which are due tail lift inspection. If false, will return all Assets which are not due tail lift inspection.
has_tail_lift_inspection_schedule	boolean	Filter by whether the Asset has tail lift inspection schedules. If true, will return all Assets which have tail lift inspection schedules. If false, will return all Assets which do not have tail lift inspection schedules.
due_tyre_inspection	boolean	Filter by whether the Asset is due tyre inspection. If true, will return all Assets which are due tyre inspection. If false, will return all Assets which are not due tyre inspection.
has_tyre_inspection_schedule	boolean	Filter by whether the Asset has tyre inspection schedules. If true, will return all Assets which have tyre inspection schedules. If false, will return all Assets which do not have tyre inspection schedules.
due_weight_test	boolean	Filter by whether the Asset is due weight test. If true, will return all Assets which are due weight test. If false, will return all Assets which are not due weight test.
has_weight_test_schedule	boolean	Filter by whether the Asset has weight test schedules. If true, will return all Assets which have weight test schedules. If false, will return all Assets which do not have weight test schedules.
has_self_install_tracker	boolean	Filter by whether the Asset has self install tracker monitoring enabled. If true, will return all Assets which have self install tracker monitoring enabled. If false, will return all Assets which do not have self install tracker monitoring enabled.
search_id	integer, exists:Search	Filter by the Asset's search id. Will return all Assets with the given search id.
site_ids	array. Each item in the array must be exists:Site.	Filter by the Asset's site id. Will return all Assets that have a site id within the given array.
business_unit_id	integer, exists:BusinessUnit	Filter by the Asset's business unit id. Will return all Assets with the given business unit id. You can see what business unit ids you have access to (including the associated objects) by calling the business unit index route.
business_unit_ids	array. Each item in the array must be integer, exists:BusinessUnit.	Filter by the Asset's business unit id. Will return all Assets that have a business unit id within the given array.
cost_centre_id	integer, exists:CostCentre	Filter by the Asset's cost centre id. Will return all Assets with the given cost centre id. You can see what cost centre ids you have access to (including the associated objects) by calling the cost centre index route.
cost_centre_ids	array. Each item in the array must be integer, exists:CostCentre.	Filter by the Asset's cost centre id. Will return all Assets that have a cost centre id within the given array.
customer_id	integer, exists:Customer	Filter by the Asset's customer id. Will return all Assets with the given customer id. You can see what customer ids you have access to (including the associated objects) by calling the customer index route.
customer_ids	array. Each item in the array must be integer, exists:Customer.	Filter by the Asset's customer id. Will return all Assets that have a customer id within the given array.
operating_centre_id	integer, exists:OperatingCentre	Filter by the Asset's operating centre id. Will return all Assets with the given operating centre id. You can see what operating centre ids you have access to (including the associated objects) by calling the operating centre index route.
operating_centre_ids	array. Each item in the array must be integer, exists:OperatingCentre.	Filter by the Asset's operating centre id. Will return all Assets that have an operating centre id within the given array.
operator_licence_id	integer, exists:OperatorLicence	Filter by the Asset's operator licence id. Will return all Assets with the given operator licence id. You can see what operator licence ids you have access to (including the associated objects) by calling the operator licence index route.
operator_licence_ids	array. Each item in the array must be integer, exists:OperatorLicence.	Filter by the Asset's operator licence id. Will return all Assets that have an operator licence id within the given array.
yard_location_id	integer, exists:YardLocation	Filter by the Asset's yard location id. Will return all Assets with the given yard location id.
yard_location_ids	array. Each item in the array must be integer, exists:YardLocation.	Filter by the Asset's yard location id. Will return all Assets that have a yard location id within the given array.
insurance_category_id	integer, exists:InsuranceCategory	Filter by the Asset's insurance category id. Will return all Assets with the given insurance category id. You can see what insurance category ids you have access to (including the associated objects) by calling the insurance category index route.
insurance_category_ids	array. Each item in the array must be exists:InsuranceCategory.	Filter by the Asset's insurance category id. Will return all Assets that have an insurance category id within the given array.
insurance_type_id	integer, exists:InsuranceType	Filter by the Asset's insurance type id. Will return all Assets with the given insurance type id. You can see what insurance type ids you have access to (including the associated objects) by calling the insurance type index route.
insurance_type_ids	array. Each item in the array must be exists:InsuranceType.	Filter by the Asset's insurance type id. Will return all Assets that have an insurance type id within the given array.
asset_finance_type_id	integer, exists:AssetFinanceType	Filter by the Asset's asset finance type id. Will return all Assets with the given asset finance type id. You can see what asset finance type ids you have access to (including the associated objects) by calling the asset finance type index route.
asset_finance_type_ids	array. Each item in the array must be exists:AssetFinanceType.	Filter by the Asset's asset finance type id. Will return all Assets that have an asset finance type id within the given array.
repair_arrangement_id	integer, exists:RepairArrangement	Filter by the Asset's repair arrangement id. Will return all Assets with the given repair arrangement id. You can see what repair arrangement ids you have access to (including the associated objects) by calling the repair arrangement index route.
trailer_deck_type_id	integer, exists:TrailerDeckType	Filter by the Asset's trailer deck type id. Will return all Assets with the given trailer deck type id.
asset_emission_standard_id	integer, exists:AssetEmissionStandard	Filter by the Asset's asset emission standard id. Will return all Assets with the given asset emission standard id. You can see what asset emission standard ids you have access to (including the associated objects) by calling the asset emission standard index route.
asset_emission_standard_ids	array. Each item in the array must be exists:AssetEmissionStandard.	Filter by the Asset's asset emission standard id. Will return all Assets that have an asset emission standard id within the given array.
fuel_type_id	integer, exists:FuelType	Filter by the Asset's fuel type id. Will return all Assets with the given fuel type id. You can see what fuel type ids you have access to (including the associated objects) by calling the fuel type index route.
fuel_type_ids	array. Each item in the array must be exists:FuelType.	Filter by the Asset's fuel type id. Will return all Assets that have a fuel type id within the given array.
asset_use_class_id	integer, exists:AssetUseClass	Filter by the Asset's asset use class id. Will return all Assets with the given asset use class id. You can see what asset use class ids you have access to (including the associated objects) by calling the asset use class index route.
asset_use_class_ids	array. Each item in the array must be exists:AssetUseClass.	Filter by the Asset's asset use class id. Will return all Assets that have an asset use class id within the given array.
country_id	integer, exists:Country	Filter by the Asset's country id. Will return all Assets with the given country id. You can see what country ids you have access to (including the associated objects) by calling the country index route.
country_ids	array. Each item in the array must be exists:Country.	Filter by the Asset's country id. Will return all Assets that have a country id within the given array.
poi_id	nullable, integer, exists:Poi	Filter by the Asset's poi id. Will return all Assets with the given poi id. You can see what poi ids you have access to (including the associated objects) by calling the poi index route.
poi_ids	array. Each item in the array must be exists:Poi.	Filter by the Asset's poi id. Will return all Assets that have a poi id within the given array.
livery_id	integer, exists:Livery	Filter by the Asset's livery id. Will return all Assets with the given livery id. You can see what livery ids you have access to (including the associated objects) by calling the livery index route.
livery_ids	array. Each item in the array must be exists:Livery.	Filter by the Asset's livery id. Will return all Assets that have a livery id within the given array.
registration_number	string	Filter by the Asset's registration number. Will return all Assets that have a registration number that contains the given string
serial_number	string	Filter by the Asset's serial number. Will return all Assets that have a serial number that contains the given string
alternate_name	string	Filter by the Asset's alternate name. Will return all Assets that have an alternate name that contains the given string
specification_code	string	Filter by the Asset's specification code. Will return all Assets that have a specification code that contains the given string
buyback_agreement	nullable, boolean	Filter by whether the Asset has a buyback agreement. If true, will return all Assets which have a buyback agreement. If false, will return all Assets which do not have a buyback agreement.
colour_id	integer, exists:Colour	Filter by the Asset's colour id. Will return all Assets with the given colour id.
properties_platform	nullable, boolean	Filter by whether the Asset has a platform. If true, will return all Assets which have a platform. If false, will return all Assets which do not have a platform.
properties_side_shift	nullable, boolean	Filter by whether the Asset has a side shift. If true, will return all Assets which have a side shift. If false, will return all Assets which do not have a side shift.
properties_number_of_wheels	integer	Filter by the Asset's properties number of wheels. Will return all Assets that have a properties number of wheels that contains the given integer
properties_number_of_batteries	integer	Filter by the Asset's properties number of batteries. Will return all Assets that have a properties number of batteries that contains the given integer
properties_numbers_of_wheels	array. Each item in the array must be an integer.	Filter by the Asset's properties numbers of wheel. Will return all Assets that have a properties numbers of wheel within the given array.
properties_numbers_of_batteries	array. Each item in the array must be an integer.	Filter by the Asset's properties numbers of battery. Will return all Assets that have a properties numbers of battery within the given array.
properties_working_hours_per_year_start	integer	Filter by the Asset's properties working hours per year start. Will return all Assets that have a properties working hours per year start that contains the given integer
properties_working_hours_per_year_end	integer	Filter by the Asset's properties working hours per year end. Will return all Assets that have a properties working hours per year end that contains the given integer
properties_mast_type_id	integer, exists:MastType	Filter by the Asset's properties mast type id. Will return all Assets with the given properties mast type id.
properties_mast_type_ids	array	Filter by the Asset's properties mast type id. Will return all Assets that have a properties mast type id within the given array.
overdue_maintenance_type_ids	array. Each item in the array must be exists:AssetRecordType.	Filter by the Asset's overdue maintenance type id. Will return all Assets that have an overdue maintenance type id within the given array.
ebpms_qualifying_logs_count_lt	integer	Filter by the Asset's ebpms qualifying logs count lt. Will return all Assets that have an ebpms qualifying logs count lt that contains the given integer
ebpms_qualifying_logs_count_lte	integer	Filter by the Asset's ebpms qualifying logs count lte. Will return all Assets that have an ebpms qualifying logs count lte that contains the given integer
ebpms_qualifying_logs_count_gt	integer	Filter by the Asset's ebpms qualifying logs count gt. Will return all Assets that have an ebpms qualifying logs count gt that contains the given integer
ebpms_qualifying_logs_count_gte	integer	Filter by the Asset's ebpms qualifying logs count gte. Will return all Assets that have an ebpms qualifying logs count gte that contains the given integer
minimum_static_days	integer	Filter by the Asset's minimum static days. Will return all Assets that have a minimum static days that contains the given integer
feature_setting_id	integer, exists:AssetFeatureSetting	Filter by the Asset's feature setting id. Will return all Assets with the given feature setting id.
asset_type_name	string	Filter by the Asset's asset type name. Will return all Assets that have an asset type name that contains the given string
ebpms_score_date	date, nullable	Filter by the Asset's ebpms score date. Will return all Assets that have an ebpms score date that contains the given date, nullable
has_schedules	boolean	Filter by whether the Asset has schedules. If true, will return all Assets which have schedules. If false, will return all Assets which do not have schedules.
has_clone_dcu	boolean	Filter by whether the Asset has a cloned DCU. If true, will return all Assets which have a cloned DCU. If false, will return all Assets which do not have a cloned DCU.
has_cloned_assets	boolean	Filter by whether the Asset has cloned asset monitoring enabled. If true, will return all Assets which have cloned asset monitoring enabled. If false, will return all Assets which do not have cloned asset monitoring enabled.
created_after	date, nullable	Filter by the Asset's created after. Will return all Assets that have a created after that contains the given date, nullable
created_before	date, nullable	Filter by the Asset's created before. Will return all Assets that have a created before that contains the given date, nullable
static_days_min	integer	Filter by the Asset's static days min. Will return all Assets that have a static days min that contains the given integer
static_days_max	integer	Filter by the Asset's static days max. Will return all Assets that have a static days max that contains the given integer
load_filter	integer, nullable	Filter by the Asset's load filter. Will return all Assets that have a load filter that contains the given integer, nullable
load_filter_operator	string, nullable	Filter by the Asset's load filter operator. Will return all Assets that have a load filter operator that contains the given string, nullable
battery_filter	integer, nullable	Filter by the Asset's battery filter. Will return all Assets that have a battery filter that contains the given integer, nullable
battery_filter_operator	string, required with:battery_filter, In	Filter by the Asset's battery filter operator. Will return all Assets that have a battery filter operator that contains the given string, required with:battery_filter, In
latest_ebpms_score_filter	integer, nullable	Filter by the Asset's latest ebpms score filter. Will return all Assets that have a latest ebpms score filter that contains the given integer, nullable
latest_ebpms_score_filter_operator	string, required with:latest_ebpms_score_filter, In	Filter by the Asset's latest ebpms score filter operator. Will return all Assets that have a latest ebpms score filter operator that contains the given string, required with:latest_ebpms_score_filter, In
latest_weekly_ebpms_score_filter	integer, nullable	Filter by the Asset's latest weekly ebpms score filter. Will return all Assets that have a latest weekly ebpms score filter that contains the given integer, nullable
latest_weekly_ebpms_score_filter_operator	string, required with:latest_weekly_ebpms_score_filter, In	Filter by the Asset's latest weekly ebpms score filter operator. Will return all Assets that have a latest weekly ebpms score filter operator that contains the given string, required with:latest_weekly_ebpms_score_filter, In
currency_id	integer, exists:Currency	Filter by the Asset's currency id. Will return all Assets with the given currency id. You can see what currency ids you have access to (including the associated objects) by calling the currency index route.
currency_ids	array. Each item in the array must be integer, exists:Currency.	Filter by the Asset's currency id. Will return all Assets that have a currency id within the given array.
limit	integer	Filter by the Asset's limit. Will return all Assets that have a limit that contains the given integer
vor_limit	integer	Filter by the Asset's vor limit. Will return all Assets that have a vor limit that contains the given integer
paginate	boolean	Filter by whether the Asset is paginate. If true, will return all Assets which are paginate. If false, will return all Assets which are not paginate.
has_tpms_low_battery	boolean	Filter by whether the Asset's TPMS sensors have a low battery. If true, will return all Assets whose TPMS sensors have a low battery. If false, will return all Assets whose TPMS sensors dos not have a low battery.
maintenance_start_date	date	Filter by the Asset's maintenance start date. Will return all Assets that have a maintenance start date that occurs after the given date.
maintenance_end_date	date	Filter by the Asset's maintenance end date. Will return all Assets that have a maintenance end date that occurs before the given date.
mileage_snapshot_day_start_date	date	Filter by the Asset's mileage snapshot day start date. Will return all Assets that have a mileage snapshot day start date that occurs after the given date.
mileage_snapshot_day_end_date	date	Filter by the Asset's mileage snapshot day end date. Will return all Assets that have a mileage snapshot day end date that occurs before the given date.
mileage_snapshot_week_start_date	date	Filter by the Asset's mileage snapshot week start date. Will return all Assets that have a mileage snapshot week start date that occurs after the given date.
mileage_snapshot_week_end_date	date	Filter by the Asset's mileage snapshot week end date. Will return all Assets that have a mileage snapshot week end date that occurs before the given date.
mileage_snapshot_month_start_date	date	Filter by the Asset's mileage snapshot month start date. Will return all Assets that have a mileage snapshot month start date that occurs after the given date.
mileage_snapshot_month_end_date	date	Filter by the Asset's mileage snapshot month end date. Will return all Assets that have a mileage snapshot month end date that occurs before the given date.
snapshot_ids	array. Each item in the array must be exists:Snapshot.	Filter by the Asset's snapshot id. Will return all Assets that have a snapshot id within the given array.
tag_id	integer, exists:AssetTag	Filter by the Asset's tag id. Will return all Assets with the given tag id.
asset_tag_ids	array. Each item in the array must be integer, exists:AssetTag.	Filter by the Asset's asset tag id. Will return all Assets that have an asset tag id within the given array.
asset_snapshot_filter	array	Filter by the Asset's asset snapshot filter. Will return all Assets that have an asset snapshot filter within the given array.
last_reported_before_date	date	Filter by the Asset's last reported before date. Will return all Assets that have a last reported before date that contains the given date
last_reported_after_date	date	Filter by the Asset's last reported after date. Will return all Assets that have a last reported after date that contains the given date
group_by	string, In	Group Asset's by the given string.
query_timeout	nullable, integer, min:1000	Set the timeout value through the given string.
response_delivery_email	boolean	Filter by whether the Asset is response delivery email. If true, will return all Assets which are response delivery email. If false, will return all Assets which are not response delivery email.
response_type	in:csv,csv-data,pdf,json,csv_old,mileage,count,maintenance_grid_assets,longest_vor_assets	Return the response corresponding to required format as per the given string.
contract_id	integer, exists:Contract	Filter by the Asset's contract id. Will return all Assets with the given contract id.
site_id	integer, exists:Site	Filter by the Asset's site id. Will return all Assets with the given site id. You can see what site ids you have access to (including the associated objects) by calling the site index route.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_dcu_icon	boolean	If true, includes the dcu icon of an Asset.	dcu_icon
with_open_defect_count	boolean	If true, includes the open defect count of an Asset.	open_defect_count
with_lookup_enabled	boolean	If true, includes the lookup enabled of an Asset.	lookup_enabled
with_primary_ebpms_algorithm	boolean, nullable	If true, includes the primary ebpms algorithm of an Asset.	primary_ebpms_algorithm
with_health	boolean	If true, includes the health of an Asset.	health
with_pac_number	boolean	If true, includes the pac number of an Asset.	pac_number
with_cluster	boolean	If true, includes the cluster of an Asset.	cluster
with_features	boolean	If true, includes the features of an Asset.	features
with_profile_number	boolean	If true, includes the profile number of an Asset.	profile_number
with_coupled	boolean	If true, includes the coupled of an Asset.	coupled
with_alternate_name	boolean	If true, includes the alternate name of an Asset.	alternate_name
with_ebs_detected_skew	boolean	If true, includes the ebs detected skew of an Asset.	ebs_detected_skew
with_ministry_number	boolean	If true, includes the ministry number of an Asset.	ministry_number
with_chassis_number	boolean	If true, includes the chassis number of an Asset.	chassis_number
with_ebs_vin	boolean	If true, includes the ebs vin of an Asset.	ebs_vin
with_serial_number	boolean	If true, includes the serial number of an Asset.	serial_number
with_registration_number	boolean	If true, includes the registration number of an Asset.	registration_number
with_type	boolean	If true, includes the type of an Asset.	type
with_company	boolean	If true, includes the company of an Asset.	company
with_group	boolean	If true, includes the group of an Asset.	group
with_group_path	boolean	If true, includes the group path of an Asset.	group_path
with_last_transfer_date	boolean	If true, includes the last transfer date of an Asset.	last_transfer_date
with_axle_manufacturer	boolean	If true, includes the axle manufacturer of an Asset.	axle_manufacturer
with_manufacturer	boolean	If true, includes the manufacturer of an Asset.	manufacturer
with_model	boolean	If true, includes the model of an Asset.	model
with_owner	boolean	If true, includes the owner of an Asset.	owner
with_odometer	boolean	If true, includes the odometer of an Asset.	odometer
with_daily_utilisation_score	boolean	If true, includes the daily utilisation score of an Asset.	daily_utilisation_score
with_daily_total_distance	boolean	If true, includes the daily total distance of an Asset.	daily_total_distance
with_weekly_utilisation_score	boolean	If true, includes the weekly utilisation score of an Asset.	weekly_utilisation_score
with_weekly_total_distance	boolean	If true, includes the weekly total distance of an Asset.	weekly_total_distance
with_monthly_utilisation_score	boolean	If true, includes the monthly utilisation score of an Asset.	monthly_utilisation_score
with_monthly_total_distance	boolean	If true, includes the monthly total distance of an Asset.	monthly_total_distance
with_note	boolean	If true, includes the note of an Asset.	note
with_last_updated	boolean	If true, includes the last updated of an Asset.	last_updated
with_load_change	boolean	If true, includes the load change of an Asset.	load_change
with_yard_location	boolean	If true, includes the yard location of an Asset.	yard_location
with_decommissioned	boolean	If true, includes the decommissioned of an Asset.	decommissioned
with_last_decommissioned_timestamp	boolean	If true, includes the last decommissioned timestamp of an Asset.	last_decommissioned_timestamp
with_ebs_detected_type	boolean	If true, includes the ebs detected type of an Asset.	ebs_detected_type
with_specification_code	boolean	If true, includes the specification code of an Asset.	specification_code
with_use_class	boolean	If true, includes the use class of an Asset.	use_class
with_fuel_type	boolean	If true, includes the fuel type of an Asset.	fuel_type
with_finance_type	boolean	If true, includes the finance type of an Asset.	finance_type
with_emission_standard	boolean	If true, includes the emission standard of an Asset.	emission_standard
with_emissions	boolean	If true, includes the emissions of an Asset.	emissions
with_document_counts	boolean	If true, includes the document counts of an Asset.	document_counts
with_country	boolean	If true, includes the country of an Asset.	country
with_esn	boolean	If true, includes the esn of an Asset.	esn
with_created_at	boolean	If true, includes the created at of an Asset.	created_at
with_ebpms_qualifying_logs_count	boolean	If true, includes the ebpms qualifying logs count of an Asset.	ebpms_qualifying_logs_count
with_latest_ebpms_score	boolean	If true, includes the latest ebpms score of an Asset.	latest_ebpms_score
with_latest_ebpms_weekly_score	boolean	If true, includes the latest ebpms weekly score of an Asset.	latest_ebpms_weekly_score
with_livery	boolean	If true, includes the livery of an Asset.	livery
with_leaseholder	boolean	If true, includes the leaseholder of an Asset.	leaseholder
with_lamps	boolean	If true, includes the lamps of an Asset.	lamps
with_load_plate	boolean	If true, includes the load plate of an Asset.	load_plate
with_properties	boolean	If true, includes the properties of an Asset.	properties
with_rigid_body_manufacturer	boolean	If true, includes the rigid body manufacturer of an Asset.	rigid_body_manufacturer
with_business_unit	boolean	If true, includes the business unit of an Asset.	business_unit
with_cost_centre	boolean	If true, includes the cost centre of an Asset.	cost_centre
with_customer	boolean	If true, includes the customer of an Asset.	customer
with_insurance_category	boolean	If true, includes the insurance category of an Asset.	insurance_category
with_insurance_type	boolean	If true, includes the insurance type of an Asset.	insurance_type
with_tyre_arrangement	boolean	If true, includes the tyre arrangement of an Asset.	tyre_arrangement
with_operating_centre	boolean	If true, includes the operating centre of an Asset.	operating_centre
with_operator_licence	boolean	If true, includes the operator licence of an Asset.	operator_licence
with_site	boolean	If true, includes the site of an Asset.	site
with_site_name	boolean	If true, includes the site name of an Asset.	site_name
with_site_id	boolean	If true, includes the site id of an Asset.	site_id
with_ebpms_computed_configuration	boolean	If true, includes the ebpms computed configuration of an Asset.	ebpms_computed_configuration
with_primary_ebpms_configuration	boolean	If true, includes the primary ebpms configuration of an Asset.	primary_ebpms_configuration
with_ebpms_data_providers	boolean	If true, includes the ebpms data providers of an Asset.	ebpms_data_providers
with_overall_status	boolean	If true, includes the overall status of an Asset.	overall_status
with_overall_icon_name	boolean	If true, includes the overall icon name of an Asset.	overall_icon_name
with_vor_status	boolean	If true, includes the vor status of an Asset.	vor_status
with_vor_statuses	boolean	If true, includes the vor statuses of an Asset.	vor_statuses
with_asset_vor_status_map	boolean	If true, includes the asset vor status map of an Asset.	asset_vor_status_map
with_vor_date	boolean	If true, includes the vor date of an Asset.	vor_date
with_ebs_status	boolean	If true, includes the ebs status of an Asset.	ebs_status
with_ebpms_status	boolean	If true, includes the ebpms status of an Asset.	ebpms_status
with_tpms_status	boolean	If true, includes the tpms status of an Asset.	tpms_status
with_axle_status	boolean	If true, includes the axle status of an Asset.	axle_status
with_lighting_status	boolean	If true, includes the lighting status of an Asset.	lighting_status
with_maintenance_status	boolean	If true, includes the maintenance status of an Asset.	maintenance_status
with_load_status	boolean	If true, includes the load status of an Asset.	load_status
with_dtc_status	boolean	If true, includes the dtc status of an Asset.	dtc_status
with_iso7638_status	boolean	If true, includes the iso7638 status of an Asset.	iso7638_status
with_uds_dtc_logs	boolean	If true, includes the uds dtc logs of an Asset.	uds_dtc_logs
with_amber_light_status	boolean	If true, includes the amber light status of an Asset.	amber_light_status
with_dtc_timestamps	boolean	If true, includes the dtc timestamps of an Asset.	dtc_timestamps
with_dtc_counts	boolean	If true, includes the dtc counts of an Asset.	dtc_counts
with_last_ebpms_calc	boolean	If true, includes the last ebpms calc of an Asset.	last_ebpms_calc
with_missing_tpms_sensor_count	boolean	If true, includes the missing tpms sensor count of an Asset.	missing_tpms_sensor_count
with_tpms_sensor_info	boolean	If true, includes the tpms sensor info of an Asset.	tpms_sensor_info
with_orientation	boolean	If true, includes the orientation of an Asset.	orientation
with_bulb_statuses	boolean	If true, includes the bulb statuses of an Asset.	bulb_statuses
with_last_maintenance_dates	boolean	If true, includes the last maintenance dates of an Asset.	last_maintenance_dates
with_last_adr_inspection_date	boolean	If true, includes the last adr inspection date of an Asset.	last_adr_inspection_date
with_last_brake_test_date	boolean	If true, includes the last brake test date of an Asset.	last_brake_test_date
with_last_fridge_service_date	boolean	If true, includes the last fridge service date of an Asset.	last_fridge_service_date
with_last_inspection	boolean	If true, includes the last inspection of an Asset.	last_inspection
with_last_insurance_date	boolean	If true, includes the last insurance date of an Asset.	last_insurance_date
with_last_loler_inspection_date	boolean	If true, includes the last loler inspection date of an Asset.	last_loler_inspection_date
with_last_mot	boolean	If true, includes the last mot of an Asset.	last_mot
with_last_rfl_date	boolean	If true, includes the last rfl date of an Asset.	last_rfl_date
with_last_sanitation_date	boolean	If true, includes the last sanitation date of an Asset.	last_sanitation_date
with_last_tacho_calibration_date	boolean	If true, includes the last tacho calibration date of an Asset.	last_tacho_calibration_date
with_last_tail_lift_inspection_date	boolean	If true, includes the last tail lift inspection date of an Asset.	last_tail_lift_inspection_date
with_last_tyre_inspection_date	boolean	If true, includes the last tyre inspection date of an Asset.	last_tyre_inspection_date
with_last_weight_test_date	boolean	If true, includes the last weight test date of an Asset.	last_weight_test_date
with_last_f_gas_certificate_check	boolean	If true, includes the last f gas certificate check of an Asset.	last_f_gas_certificate_check
with_last_wheel_alignment	boolean	If true, includes the last wheel alignment of an Asset.	last_wheel_alignment
with_last_winch_inspection	boolean	If true, includes the last winch inspection of an Asset.	last_winch_inspection
with_last_fire_extinguisher_check	boolean	If true, includes the last fire extinguisher check of an Asset.	last_fire_extinguisher_check
with_last_laden_brake_test	boolean	If true, includes the last laden brake test of an Asset.	last_laden_brake_test
with_last_clean	boolean	If true, includes the last clean of an Asset.	last_clean
with_last_audit	boolean	If true, includes the last audit of an Asset.	last_audit
with_last_deck_loler_inspection	boolean	If true, includes the last deck loler inspection of an Asset.	last_deck_loler_inspection
with_last_deck_weight_test	boolean	If true, includes the last deck weight test of an Asset.	last_deck_weight_test
with_last_odometer_check	boolean	If true, includes the last odometer check of an Asset.	last_odometer_check
with_last_mileage_check	boolean	If true, includes the last mileage check of an Asset.	last_mileage_check
with_last_fridge_temperature_calibration	boolean	If true, includes the last fridge temperature calibration of an Asset.	last_fridge_temperature_calibration
with_last_donkey_engine_service	boolean	If true, includes the last donkey engine service of an Asset.	last_donkey_engine_service
with_last_tank_pressure_test	boolean	If true, includes the last tank pressure test of an Asset.	last_tank_pressure_test
with_last_safety_recall	boolean	If true, includes the last safety recall of an Asset.	last_safety_recall
with_last_spot_check	boolean	If true, includes the last spot check of an Asset.	last_spot_check
with_last_puwer_inspection	boolean	If true, includes the last puwer inspection of an Asset.	last_puwer_inspection
with_last_flow_meter_calibration	boolean	If true, includes the last flow meter calibration of an Asset.	last_flow_meter_calibration
with_last_hydropack_service	boolean	If true, includes the last hydropack service of an Asset.	last_hydropack_service
with_last_axle_strip_inspection	boolean	If true, includes the last axle strip inspection of an Asset.	last_axle_strip_inspection
with_last_safe_loading_pass	boolean	If true, includes the last safe loading pass of an Asset.	last_safe_loading_pass
with_last_vapour_tightness_test	boolean	If true, includes the last vapour tightness test of an Asset.	last_vapour_tightness_test
with_last_dvs_permit	boolean	If true, includes the last dvs permit of an Asset.	last_dvs_permit
with_last_periodic_tank_test	boolean	If true, includes the last periodic tank test of an Asset.	last_periodic_tank_test
with_last_intermediate_tank_test	boolean	If true, includes the last intermediate tank test of an Asset.	last_intermediate_tank_test
with_last_wheel_hub_repack	boolean	If true, includes the last wheel hub repack of an Asset.	last_wheel_hub_repack
with_last_shutter_service	boolean	If true, includes the last shutter service of an Asset.	last_shutter_service
with_last_crane_test	boolean	If true, includes the last crane test of an Asset.	last_crane_test
with_last_strop_swap	boolean	If true, includes the last strop swap of an Asset.	last_strop_swap
with_last_hose_test	boolean	If true, includes the last hose test of an Asset.	last_hose_test
with_last_body_inspection	boolean	If true, includes the last body inspection of an Asset.	last_body_inspection
with_maintenance_statuses	boolean	If true, includes the maintenance statuses of an Asset.	maintenance_statuses
with_overdue_statuses	boolean	If true, includes the overdue statuses of an Asset.	overdue_statuses
with_next_adr_inspection_date	boolean	If true, includes the next adr inspection date of an Asset.	next_adr_inspection_date
with_next_brake_test_date	boolean	If true, includes the next brake test date of an Asset.	next_brake_test_date
with_next_fridge_service_date	boolean	If true, includes the next fridge service date of an Asset.	next_fridge_service_date
with_next_inspection	boolean	If true, includes the next inspection of an Asset.	next_inspection
with_next_insurance_date	boolean	If true, includes the next insurance date of an Asset.	next_insurance_date
with_next_loler_inspection_date	boolean	If true, includes the next loler inspection date of an Asset.	next_loler_inspection_date
with_mot_date	boolean	If true, includes the mot date of an Asset.	mot_date
with_next_mot	boolean	If true, includes the next mot of an Asset.	next_mot
with_next_rfl_date	boolean	If true, includes the next rfl date of an Asset.	next_rfl_date
with_next_sanitation_date	boolean	If true, includes the next sanitation date of an Asset.	next_sanitation_date
with_next_tacho_calibration_date	boolean	If true, includes the next tacho calibration date of an Asset.	next_tacho_calibration_date
with_next_tail_lift_inspection_date	boolean	If true, includes the next tail lift inspection date of an Asset.	next_tail_lift_inspection_date
with_next_tyre_inspection_date	boolean	If true, includes the next tyre inspection date of an Asset.	next_tyre_inspection_date
with_next_weight_test_date	boolean	If true, includes the next weight test date of an Asset.	next_weight_test_date
with_next_hose_test	boolean	If true, includes the next hose test of an Asset.	next_hose_test
with_next_f_gas_certificate_check	boolean	If true, includes the next f gas certificate check of an Asset.	next_f_gas_certificate_check
with_next_wheel_alignment	boolean	If true, includes the next wheel alignment of an Asset.	next_wheel_alignment
with_next_winch_inspection	boolean	If true, includes the next winch inspection of an Asset.	next_winch_inspection
with_next_fire_extinguisher_check	boolean	If true, includes the next fire extinguisher check of an Asset.	next_fire_extinguisher_check
with_next_laden_brake_test	boolean	If true, includes the next laden brake test of an Asset.	next_laden_brake_test
with_next_clean	boolean	If true, includes the next clean of an Asset.	next_clean
with_next_audit	boolean	If true, includes the next audit of an Asset.	next_audit
with_next_deck_loler_inspection	boolean	If true, includes the next deck loler inspection of an Asset.	next_deck_loler_inspection
with_next_deck_weight_test	boolean	If true, includes the next deck weight test of an Asset.	next_deck_weight_test
with_next_odometer_check	boolean	If true, includes the next odometer check of an Asset.	next_odometer_check
with_next_mileage_check	boolean	If true, includes the next mileage check of an Asset.	next_mileage_check
with_next_fridge_temperature_calibration	boolean	If true, includes the next fridge temperature calibration of an Asset.	next_fridge_temperature_calibration
with_next_donkey_engine_service	boolean	If true, includes the next donkey engine service of an Asset.	next_donkey_engine_service
with_next_tank_pressure_test	boolean	If true, includes the next tank pressure test of an Asset.	next_tank_pressure_test
with_next_safety_recall	boolean	If true, includes the next safety recall of an Asset.	next_safety_recall
with_next_spot_check	boolean	If true, includes the next spot check of an Asset.	next_spot_check
with_next_puwer_inspection	boolean	If true, includes the next puwer inspection of an Asset.	next_puwer_inspection
with_next_flow_meter_calibration	boolean	If true, includes the next flow meter calibration of an Asset.	next_flow_meter_calibration
with_next_hydropack_service	boolean	If true, includes the next hydropack service of an Asset.	next_hydropack_service
with_next_axle_strip_inspection	boolean	If true, includes the next axle strip inspection of an Asset.	next_axle_strip_inspection
with_next_safe_loading_pass	boolean	If true, includes the next safe loading pass of an Asset.	next_safe_loading_pass
with_next_vapour_tightness_test	boolean	If true, includes the next vapour tightness test of an Asset.	next_vapour_tightness_test
with_next_dvs_permit	boolean	If true, includes the next dvs permit of an Asset.	next_dvs_permit
with_next_periodic_tank_test	boolean	If true, includes the next periodic tank test of an Asset.	next_periodic_tank_test
with_next_intermediate_tank_test	boolean	If true, includes the next intermediate tank test of an Asset.	next_intermediate_tank_test
with_next_wheel_hub_repack	boolean	If true, includes the next wheel hub repack of an Asset.	next_wheel_hub_repack
with_next_shutter_service	boolean	If true, includes the next shutter service of an Asset.	next_shutter_service
with_next_crane_test	boolean	If true, includes the next crane test of an Asset.	next_crane_test
with_next_strop_swap	boolean	If true, includes the next strop swap of an Asset.	next_strop_swap
with_next_body_inspection	boolean	If true, includes the next body inspection of an Asset.	next_body_inspection
with_location	boolean	If true, includes the location (or POI) of an Asset.	location
with_poi	boolean	If true, includes the poi of an Asset.	poi
with_last_position_timestamp	boolean	If true, includes the last position timestamp of an Asset.	last_position_timestamp
with_gps_lat_lng	boolean	If true, includes the gps lat lng of an Asset.	gps_lat_lng
with_gps_heading	boolean	If true, includes the gps heading of an Asset.	gps_heading
with_gps_speed_mps	boolean	If true, includes the gps speed mps of an Asset.	gps_speed_mps
with_static_days	boolean	If true, includes the static days of an Asset.	static_days
with_last_comms	boolean	If true, includes the last comms of an Asset.	last_comms
with_gps	boolean	If true, includes the gps of an Asset.	gps
with_gps_log	boolean	If true, includes the gps log of an Asset.	gps_log
with_tpms	boolean	If true, includes the tpms of an Asset.	tpms
with_battery_v	boolean	If true, includes the battery v of an Asset.	battery_v
with_recent_trips	boolean	If true, includes the recent trips of an Asset.	recent_trips
with_load_inc_bogie_percent	boolean	If true, includes the load inc bogie percent of an Asset.	load_inc_bogie_percent
with_load_percent	boolean	If true, includes the load percent of an Asset.	load_percent
with_dcu	boolean	If true, includes the dcu of an Asset.	dcu
with_dcu_assigned	boolean	If true, includes the dcu assigned of an Asset.	dcu_assigned
with_dcu_build_hardware_type	boolean	If true, includes the dcu build hardware type of an Asset.	dcu_build_hardware_type
with_clone_dcu	boolean	If true, includes the clone dcu of an Asset.	clone_dcu
with_tpms_cold_inflation_temperature_c	boolean	If true, includes the TPMS cold inflation temperature (degrees c) of an Asset.	tpms_cold_inflation_temperature_c
with_tpms_expected_pressure_psi	boolean	If true, includes the TPMS expected pressure (psi) of an Asset.	tpms_expected_pressure_psi
with_virtual	boolean	If true, includes the virtual of an Asset.	virtual
with_internal_height_m	boolean	If true, includes the internal height (in Metres) of an Asset.	internal_height_m
with_internal_length_m	boolean	If true, includes the internal length (in Metres) of an Asset.	internal_length_m
with_internal_width_m	boolean	If true, includes the internal width (in Metres) of an Asset.	internal_width_m
with_height_m	boolean	If true, includes the height (in Metres) of an Asset.	height_m
with_length_m	boolean	If true, includes the length (in Metres) of an Asset.	length_m
with_width_m	boolean	If true, includes the width (in Metres) of an Asset.	width_m
with_external_height_m	boolean	If true, includes the external height (in Metres) of an Asset.	external_height_m
with_external_length_m	boolean	If true, includes the external length (in Metres) of an Asset.	external_length_m
with_external_width_m	boolean	If true, includes the external width (in Metres) of an Asset.	external_width_m
with_fifth_wheel_height_m	boolean	If true, includes the fifth wheel height (in Metres) of an Asset.	fifth_wheel_height_m
with_loading_height_through_sides_m	boolean	If true, includes the loading height through sides (in Metres) of an Asset.	loading_height_through_sides_m
with_lease_number	boolean	If true, includes the lease number of an Asset.	lease_number
with_lease_start_date	boolean	If true, includes the lease start date of an Asset.	lease_start_date
with_lease_end_date	boolean	If true, includes the lease end date of an Asset.	lease_end_date
with_lease_weekly_cost	boolean	If true, includes the lease weekly cost of an Asset.	lease_weekly_cost
with_extension_start_date	boolean	If true, includes the extension start date of an Asset.	extension_start_date
with_extension_end_date	boolean	If true, includes the extension end date of an Asset.	extension_end_date
with_extension_weekly_cost	boolean	If true, includes the extension weekly cost of an Asset.	extension_weekly_cost
with_contract_number	boolean	If true, includes the contract number of an Asset.	contract_number
with_contract_visibility_type	boolean	If true, includes the contract visibility type of an Asset.	contract_visibility_type
with_default_maintenance_provider	boolean	If true, includes the default maintenance provider of an Asset.	default_maintenance_provider
with_lease_period_months	boolean	If true, includes the lease period months of an Asset.	lease_period_months
with_lease_monthly_cost	boolean	If true, includes the lease monthly cost of an Asset.	lease_monthly_cost
with_insurance_rate	boolean	If true, includes the insurance rate of an Asset.	insurance_rate
with_insurance_start_date	boolean	If true, includes the insurance start date of an Asset.	insurance_start_date
with_insurance_end_date	boolean	If true, includes the insurance end date of an Asset.	insurance_end_date
with_repair_and_maintenance_rate	boolean	If true, includes the repair and maintenance rate of an Asset.	repair_and_maintenance_rate
with_repair_and_maintenance_date	boolean	If true, includes the repair and maintenance date of an Asset.	repair_and_maintenance_date
with_warranty_date	boolean	If true, includes the warranty date of an Asset.	warranty_date
with_road_fund_licence_rate	boolean	If true, includes the road fund licence rate of an Asset.	road_fund_licence_rate
with_contracted_allowed_distance_km_per_year	boolean	If true, includes the contracted allowed distance km per year of an Asset.	contracted_allowed_distance_km_per_year
with_contracted_allowed_distance_km_per_lease_period	boolean	If true, includes the contracted allowed distance km per lease period of an Asset.	contracted_allowed_distance_km_per_lease_period
with_days_had	boolean	If true, includes the days had of an Asset.	days_had
with_kms_per_day_allowed	boolean	If true, includes the kms per day allowed of an Asset.	kms_per_day_allowed
with_allowed_kms_to_date	boolean	If true, includes the allowed kms to date of an Asset.	allowed_kms_to_date
with_difference_against_current	boolean	If true, includes the difference against current of an Asset.	difference_against_current
with_acquired_date_numeric	boolean	If true, includes the acquired date numeric of an Asset.	acquired_date_numeric
with_end_date_numeric	boolean	If true, includes the end date numeric of an Asset.	end_date_numeric
with_current_run_rate_daily	boolean	If true, includes the current run rate daily of an Asset.	current_run_rate_daily
with_current_contract_run_rate	boolean	If true, includes the current contract run rate of an Asset.	current_contract_run_rate
with_contract_length_days	boolean	If true, includes the contract length days of an Asset.	contract_length_days
with_lease_number_internal_reference	boolean	If true, includes the lease number internal reference of an Asset.	lease_number_internal_reference
with_contract_run_rate_variance	boolean	If true, includes the contract run rate variance of an Asset.	contract_run_rate_variance
with_km_warning_status	boolean	If true, includes the km warning status of an Asset.	km_warning_status
with_manufactured_at	boolean	If true, includes the manufactured at of an Asset.	manufactured_at
with_registered_at	boolean	If true, includes the registered at of an Asset.	registered_at
with_brake_type	boolean	If true, includes the brake type of an Asset.	brake_type
with_buyback_agreement	boolean	If true, includes the buyback agreement of an Asset.	buyback_agreement
with_currency	boolean	If true, includes the currency of an Asset.	currency
with_repair_arrangement	boolean	If true, includes the repair arrangement of an Asset.	repair_arrangement
with_dvs_permit_information	boolean	If true, includes the dvs permit information of an Asset.	dvs_permit_information
with_dvs_permit_holder	boolean	If true, includes the dvs permit holder of an Asset.	dvs_permit_holder
with_dvs_permit_star_rating	boolean	If true, includes the dvs permit star rating of an Asset.	dvs_permit_star_rating
with_dvs_permit_expiry_date	boolean	If true, includes the dvs permit expiry date of an Asset.	dvs_permit_expiry_date
with_dvs_permit_start_date	boolean	If true, includes the dvs permit start date of an Asset.	dvs_permit_start_date
with_en_12642xl_certified	boolean	If true, includes the en 12642xl certified of an Asset.	en_12642xl_certified
with_adr	boolean	If true, includes the adr of an Asset.	adr
with_company_min_walkaround_asset_maintenance_status	boolean	If true, includes the company min walkaround asset maintenance status of an Asset.	company_min_walkaround_asset_maintenance_status
with_completed_checklist_items	boolean	If true, includes the completed checklist items of an Asset.	completed_checklist_items
with_completed_checklist_items_icon	boolean	If true, includes the completed checklist items icon of an Asset.	completed_checklist_items_icon
with_searches	boolean	If true, includes the searches of an Asset.	searches
with_fuel_efficiency	boolean	If true, includes the fuel efficiency of an Asset.	fuel_efficiency
with_asset_feature_settings	boolean	If true, includes the asset feature settings of an Asset.	asset_feature_settings
with_asset_finance_calculated_fields	boolean	If true, includes the asset finance calculated fields of an Asset.	asset_finance_calculated_fields
with_brake_calc_logs	boolean	If true, includes the brake calc logs of an Asset.	brake_calc_logs
with_chassis	boolean	If true, includes the chassis of an Asset.	chassis
with_ebpms_chassis	boolean	If true, includes the ebpms chassis of an Asset.	ebpms_chassis
with_brake_calc	boolean	If true, includes the brake calc of an Asset.	brake_calc
with_axle_count	boolean	If true, includes the axle count of an Asset.	axle_count
with_wheels_per_axle	boolean	If true, includes the wheels per axle of an Asset.	wheels_per_axle
with_histogram	boolean	If true, includes the histogram of an Asset.	histogram
with_tag_names	boolean	If true, includes the tag names of an Asset.	tag_names
with_additional_vor_info	boolean	If true, includes the additional vor info of an Asset.	additional_vor_info
with_vor_days	boolean	If true, includes the vor days of an Asset.	vor_days
with_vor_records	boolean	If true, includes the vor records of an Asset.	vor_records
with_vor_initial_date	boolean	If true, includes the vor initial date of an Asset.	vor_initial_date
with_battery_percentage	boolean	If true, includes the battery percentage of an Asset.	battery_percentage
with_battery_voltage	boolean	If true, includes the battery voltage of an Asset.	battery_voltage
with_battery_timestamp	boolean	If true, includes the battery timestamp of an Asset.	battery_timestamp
with_snapshots	boolean	If true, includes the snapshots of an Asset.	snapshots
with_default_questionnaire	boolean	If true, includes the default questionnaire of an Asset.	default_questionnaire
with_default_questionnaire_id	boolean	If true, includes the default questionnaire id of an Asset.	default_questionnaire_id
with_properties_weight_limit_ton	boolean	If true, includes the properties weight limit ton of an Asset.	properties_weight_limit_ton
with_properties_gross_vehicle_weight_kg	boolean	If true, includes the properties gross vehicle weight (in Kg) of an Asset.	properties_gross_vehicle_weight_kg
with_properties_unladen_weight_kg	boolean	If true, includes the properties unladen weight (in Kg) of an Asset.	properties_unladen_weight_kg
with_properties_has_crane	boolean	If true, includes the properties has crane field of an Asset.	properties_has_crane
with_properties_has_moffett	boolean	If true, includes the properties has moffett field of an Asset.	properties_has_moffett
with_properties_has_tail_lift	boolean	If true, includes the properties has tail lift field of an Asset.	properties_has_tail_lift
with_properties_tail_lift_type	boolean	If true, includes the properties tail lift type of an Asset.	properties_tail_lift_type
with_properties_tail_lift_capacity_kg	boolean	If true, includes the properties tail lift capacity (in Kg) of an Asset.	properties_tail_lift_capacity_kg
with_properties_tail_lift_manufacturer	boolean	If true, includes the properties tail lift manufacturer of an Asset.	properties_tail_lift_manufacturer
with_properties_has_draw_bar	boolean	If true, includes the properties has draw bar field of an Asset.	properties_has_draw_bar
with_properties_has_fridge	boolean	If true, includes the properties has fridge field of an Asset.	properties_has_fridge
with_properties_has_generator	boolean	If true, includes the properties has generator field of an Asset.	properties_has_generator
with_properties_has_cage	boolean	If true, includes the properties has cage field of an Asset.	properties_has_cage
with_properties_has_step_frame	boolean	If true, includes the properties has step frame field of an Asset.	properties_has_step_frame
with_properties_trailer_axle_type	boolean	If true, includes the properties trailer axle type of an Asset.	properties_trailer_axle_type
with_properties_trailer_body_type	boolean	If true, includes the properties trailer body type of an Asset.	properties_trailer_body_type
with_properties_trailer_frame_type	boolean	If true, includes the properties trailer frame type of an Asset.	properties_trailer_frame_type
with_properties_trailer_deck_type	boolean	If true, includes the properties trailer deck type of an Asset.	properties_trailer_deck_type
with_properties_fridge_type	boolean	If true, includes the properties fridge type of an Asset.	properties_fridge_type
with_properties_fridge_layout_type	boolean	If true, includes the properties fridge layout type of an Asset.	properties_fridge_layout_type
with_properties_fridge_manufacturer	boolean	If true, includes the properties fridge manufacturer of an Asset.	properties_fridge_manufacturer
with_properties_fridge_model	boolean	If true, includes the properties fridge model of an Asset.	properties_fridge_model
with_properties_fridge_chassis_number	boolean	If true, includes the properties fridge chassis number of an Asset.	properties_fridge_chassis_number
with_properties_fridge_date_of_manufacture	boolean	If true, includes the properties fridge date of manufacture of an Asset.	properties_fridge_date_of_manufacture
with_properties_fridge_warranty_months	boolean	If true, includes the properties fridge warranty months of an Asset.	properties_fridge_warranty_months
with_properties_tractor_unit_axle_type	boolean	If true, includes the properties tractor unit axle type of an Asset.	properties_tractor_unit_axle_type
with_properties_transmission_type	boolean	If true, includes the properties transmission type of an Asset.	properties_transmission_type
with_properties_van_body_type	boolean	If true, includes the properties van body type of an Asset.	properties_van_body_type
with_properties_car_body_type	boolean	If true, includes the properties car body type of an Asset.	properties_car_body_type
with_properties_moffett_support_fitting_type	boolean	If true, includes the properties moffett support fitting type of an Asset.	properties_moffett_support_fitting_type
with_properties_rigid_body_manufacturer	boolean	If true, includes the properties rigid body manufacturer of an Asset.	properties_rigid_body_manufacturer
with_properties_mhe_type	boolean	If true, includes the properties mhe type of an Asset.	properties_mhe_type
with_properties_number_of_batteries	boolean	If true, includes the properties number of batteries of an Asset.	properties_number_of_batteries
with_properties_battery_serial_number_1	boolean	If true, includes the properties battery serial number 1 of an Asset.	properties_battery_serial_number_1
with_properties_battery_serial_number_2	boolean	If true, includes the properties battery serial number 2 of an Asset.	properties_battery_serial_number_2
with_properties_working_hours_per_year	boolean	If true, includes the properties working hours per year of an Asset.	properties_working_hours_per_year
with_properties_total_height_of_elevation_m	boolean	If true, includes the properties total height of elevation (in Metres) of an Asset.	properties_total_height_of_elevation_m
with_properties_mast_height_retracted_m	boolean	If true, includes the properties mast height retracted (in Metres) of an Asset.	properties_mast_height_retracted_m
with_properties_mast_lift_height_m	boolean	If true, includes the properties mast lift height (in Metres) of an Asset.	properties_mast_lift_height_m
with_properties_capacity_kg	boolean	If true, includes the properties capacity (in Kg) of an Asset.	properties_capacity_kg
with_properties_capacity_at_maximum_height_kg	boolean	If true, includes the properties capacity at maximum height (in Kg) of an Asset.	properties_capacity_at_maximum_height_kg
with_properties_number_of_wheels	boolean	If true, includes the properties number of wheels of an Asset.	properties_number_of_wheels
with_properties_length_of_forks_mm	boolean	If true, includes the properties length of forks (in Mm) of an Asset.	properties_length_of_forks_mm
with_properties_width_of_forks_mm	boolean	If true, includes the properties width of forks (in Mm) of an Asset.	properties_width_of_forks_mm
with_properties_aisle_width_mm	boolean	If true, includes the properties aisle width (in Mm) of an Asset.	properties_aisle_width_mm
with_properties_side_shift_availability_type	boolean	If true, includes the properties side shift availability type of an Asset.	properties_side_shift_availability_type
with_properties_side_protections	boolean	If true, includes the properties side protections of an Asset.	properties_side_protections
with_properties_platform	boolean	If true, includes the properties platform of an Asset.	properties_platform
with_properties_mast_type	boolean	If true, includes the properties mast type of an Asset.	properties_mast_type
with_properties_section_width_mm	boolean	If true, includes the properties section width (in Mm) of an Asset.	properties_section_width_mm
with_properties_aspect_ratio_percent	boolean	If true, includes the properties aspect ratio percent of an Asset.	properties_aspect_ratio_percent
with_properties_rim_diameter_in	boolean	If true, includes the properties rim diameter in of an Asset.	properties_rim_diameter_in
with_properties_tyre_configuration	boolean	If true, includes the properties tyre configuration of an Asset.	properties_tyre_configuration

Sort

KEY	TYPE	DESCRIPTION
sort_column	string	Sort the Asset by the given column.
sort_direction	string	Sort the Asset by the given direction.

Pagination

KEY	TYPE	DESCRIPTION
current_page	integer, gte:0	Offsets the Asset's sent back in the request by the current page multiplied by the amount of Asset's per page. Indexed from 0. Must be equal to or greater than 0. Does nothing without ‘per_page’ also being set.
per_page	integer, gt:0	Limits the amount of Asset's sent back in the request to the given value. Must be greater than 0. Does nothing without ‘current_page’ also being set.

Asset Create Request

Request

URL	new/asset/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/new/asset/create

Asset Store Request

Request

URL	new/asset/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/new/asset/

Parameters

KEY	TYPE	DESCRIPTION
name	string	Will store a permitted value as the name of the Asset.
ministry_number	nullable, string	Will store a permitted value as the ministry number of the Asset.
chassis_number	nullable, string	Will store a permitted value as the chassis number of the Asset.
feature_setting_id	nullable, integer, exists:AssetFeatureSetting	Will store a permitted value as the feature setting id of the Asset.
company_id	integer, exists:Company	Will store a permitted value as the company id of the Asset.
owner_id	nullable, integer, exists:Company	Will store a permitted value as the owner id of the Asset.
leaseholder_id	nullable, integer, exists:Leaseholder	Will store a permitted value as the leaseholder id of the Asset.
manufacturer_id	nullable, integer, exists:Company	Will store a permitted value as the manufacturer id of the Asset.
model_id	nullable, integer, exists:Model	Will store a permitted value as the model id of the Asset.
group_id	integer, exists:Group	Will store a permitted value as the group id of the Asset.
asset_build_id	nullable, integer, exists:AssetBuild	Will store a permitted value as the asset build id of the Asset.
asset_type_id	nullable, integer, exists:AssetType	Will store a permitted value as the asset type id of the Asset.
asset_subtype_id	nullable, integer, exists:AssetSubtype	Will store a permitted value as the asset subtype id of the Asset.
dvs_permit_information	string, nullable	Will store a permitted value as the dvs permit information of the Asset.
dvs_permit_holder_id	nullable, integer, exists:DvsPermitHolder	Will store a permitted value as the dvs permit holder id of the Asset.
dvs_permit_star_rating	nullable, integer, min:0, max:5	Will store a permitted value as the dvs permit star rating of the Asset.
dvs_permit_expiry_date	nullable, date	Will store a permitted value as the dvs permit expiry date of the Asset.
dvs_permit_start_date	nullable, date	Will store a permitted value as the dvs permit start date of the Asset.
en_12642xl_certified	boolean	Will store the en 12642xl certified value of the Asset as either true or false depending on the value passed.
livery_id	nullable, integer, exists:Livery	Will store a permitted value as the livery id of the Asset.
internal_height_m	nullable, numeric, min:0	Will store a permitted value as the internal height (in Metres) of the Asset.
internal_length_m	nullable, numeric, min:0	Will store a permitted value as the internal length (in Metres) of the Asset.
internal_width_m	nullable, numeric, min:0	Will store a permitted value as the internal width (in Metres) of the Asset.
height_m	nullable, numeric, min:0	Will store a permitted value as the height (in Metres) of the Asset.
length_m	nullable, numeric, min:0	Will store a permitted value as the length (in Metres) of the Asset.
width_m	nullable, numeric, min:0	Will store a permitted value as the width (in Metres) of the Asset.
fifth_wheel_height_m	nullable, numeric, min:0	Will store a permitted value as the fifth wheel height (in Metres) of the Asset.
loading_height_through_sides_m	nullable, numeric, min:0	Will store a permitted value as the loading height through sides (in Metres) of the Asset.
vor_status	integer	Will store a permitted value as the vor status of the Asset.
vor_sub_status	integer	Will store a permitted value as the vor sub status of the Asset.
note	nullable, string	Will store a permitted value as the note of the Asset.
yard_location	nullable, string	Will store a permitted value as the yard location of the Asset.
site_id	nullable, integer, exists:Site	Will store a permitted value as the site id of the Asset.
business_unit_id	nullable, integer, exists:BusinessUnit	Will store a permitted value as the business unit id of the Asset.
cost_centre_id	nullable, integer, exists:CostCentre	Will store a permitted value as the cost centre id of the Asset.
customer_id	nullable, integer, exists:Customer	Will store a permitted value as the customer id of the Asset.
operating_centre_id	nullable, integer, exists:OperatingCentre	Will store a permitted value as the operating centre id of the Asset.
operator_licence_id	nullable, integer, exists:OperatorLicence	Will store a permitted value as the operator licence id of the Asset.
insurance_category_id	nullable, integer, exists:InsuranceCategory	Will store a permitted value as the insurance category id of the Asset.
insurance_type_id	nullable, integer, exists:InsuranceType	Will store a permitted value as the insurance type id of the Asset.
asset_emission_standard_id	nullable, integer, exists:AssetEmissionStandard	Will store a permitted value as the asset emission standard id of the Asset.
emissions	nullable, integer	Will store a permitted value as the emissions of the Asset.
asset_use_class_id	nullable, integer, exists:AssetUseClass	Will store a permitted value as the asset use class id of the Asset.
country_id	nullable, integer, exists:Country	Will store a permitted value as the country id of the Asset.
fuel_type_id	nullable, integer, exists:FuelType	Will store a permitted value as the fuel type id of the Asset.
axle_manufacturer_id	nullable, integer, exists:AxleManufacturer	Will store a permitted value as the axle manufacturer id of the Asset.
registration_number	nullable, string	Will store a permitted value as the registration number of the Asset.
serial_number	nullable, string	Will store a permitted value as the serial number of the Asset.
alternate_name	nullable, string	Will store a permitted value as the alternate name of the Asset.
specification_code	nullable, string	Will store a permitted value as the specification code of the Asset.
registered_at	nullable, date	Will store a permitted value as the date registered of the Asset.
manufactured_at	nullable, date	Will store a permitted value as the date manufactured of the Asset.
colour_id	nullable, integer, exists:Colour	Will store a permitted value as the colour id of the Asset.
parc_unique_id	nullable	Will store a permitted value as the parc unique id of the Asset.
contract_visibility_type_id	nullable, integer, exists:ContractVisibilityType	Will store a permitted value as the contract visibility type id of the Asset.
default_maintenance_provider_id	nullable, integer, exists:MaintenanceProvider	Will store a permitted value as the default maintenance provider id of the Asset.
asset_properties_id	nullable, integer, exists:AssetProperties	Will store a permitted value as the asset properties id of the Asset.
ebpms_max_age_days	nullable, integer, min:0	Will store a permitted value as the ebpms max age days of the Asset.
adr	nullable, boolean	Will store the adr value of the Asset as either true or false depending on the value passed.
lookup_enabled	boolean	Will store the lookup enabled value of the Asset as either true or false depending on the value passed.
earned_recognition_enabled	nullable, boolean	Will store the earned recognition enabled value of the Asset as either true or false depending on the value passed.
asset_finance_type_id	nullable, integer, exists:AssetFinanceType	Will store a permitted value as the asset finance type id of the Asset.
average_mpg	nullable, numeric	Will store a permitted value as the average mpg of the Asset.
buyback_agreement	nullable, boolean	Will store the buyback agreement value of the Asset as either true or false depending on the value passed.
contracted_allowed_distance_km_per_year	nullable, numeric	Will store a permitted value as the contracted allowed distance km per year of the Asset.
currency_id	nullable, integer, exists:Currency	Will store a permitted value as the currency id of the Asset.
ebis_code_id	nullable, integer, exists:EbisCode	Will store a permitted value as the ebis code id of the Asset.
extension_end_date	nullable, date	Will store a permitted value as the extension end date of the Asset.
extension_start_date	nullable, date	Will store a permitted value as the extension start date of the Asset.
extension_weekly_cost	nullable, numeric	Will store a permitted value as the extension weekly cost of the Asset.
insurance_end_date	nullable, date	Will store a permitted value as the insurance end date of the Asset.
insurance_rate	nullable, numeric	Will store a permitted value as the insurance rate of the Asset.
insurance_start_date	nullable, date	Will store a permitted value as the insurance start date of the Asset.
lease_end_date	nullable, date	Will store a permitted value as the lease end date of the Asset.
lease_monthly_cost	nullable, numeric	Will store a permitted value as the lease monthly cost of the Asset.
lease_number	nullable, string	Will store a permitted value as the lease number of the Asset.
lease_number_internal_reference	nullable, string	Will store a permitted value as the lease number internal reference of the Asset.
lease_period_months	nullable, numeric	Will store a permitted value as the lease period months of the Asset.
lease_start_date	nullable, date	Will store a permitted value as the lease start date of the Asset.
lease_weekly_cost	nullable, numeric	Will store a permitted value as the lease weekly cost of the Asset.
mileage_pool_id	nullable, integer, exists:MileagePool	Will store a permitted value as the mileage pool id of the Asset.
repair_and_maintenance_date	nullable, date	Will store a permitted value as the repair and maintenance date of the Asset.
repair_and_maintenance_rate	nullable, numeric	Will store a permitted value as the repair and maintenance rate of the Asset.
repair_arrangement_id	nullable, integer, exists:RepairArrangement	Will store a permitted value as the repair arrangement id of the Asset.
road_fund_licence_rate	nullable, numeric	Will store a permitted value as the road fund licence rate of the Asset.
tyre_arrangement_id	nullable, integer, exists:TyreArrangement	Will store a permitted value as the tyre arrangement id of the Asset.
warranty_date	nullable, date	Will store a permitted value as the warranty date of the Asset.
ebpms_transitioned	boolean	Will store the ebpms transitioned value of the Asset as either true or false depending on the value passed.
decommissioned	boolean	Will store the decommissioned value of the Asset as either true or false depending on the value passed.
wheels_per_axle	nullable, integer	Will store a permitted value as the wheels per axle of the Asset.
axle_count	nullable, integer	Will store a permitted value as the axle count of the Asset.
axle_load_unladen_kg	nullable, integer	Will store a permitted value as the axle load unladen (in Kg) of the Asset.
axle_load_laden_kg	nullable, integer	Will store a permitted value as the axle load laden (in Kg) of the Asset.
bag_pressure_unladen_bar	nullable, numeric	Will store a permitted value as the bag pressure when unladen (bar) of the Asset.
bag_pressure_laden_bar	nullable, numeric	Will store a permitted value as the bag pressure when laden (bar) of the Asset.
overload_warning_percentage	integer	Will store a permitted value as the overload warning percentage of the Asset.
overload_critical_percentage	integer	Will store a permitted value as the overload critical percentage of the Asset.
tpms_high_critical_offset_pressure_percent	nullable, integer	Will store a permitted value as the tpms high critical offset pressure percent of the Asset.
tpms_high_critical_offset_pressure_psi	nullable, numeric	Will store a permitted value as the tpms high critical offset pressure psi of the Asset.
tpms_high_warning_offset_pressure_percent	nullable, integer	Will store a permitted value as the tpms high warning offset pressure percent of the Asset.
tpms_high_warning_offset_pressure_psi	nullable, numeric	Will store a permitted value as the tpms high warning offset pressure psi of the Asset.
tpms_low_critical_offset_pressure_percent	nullable, integer	Will store a permitted value as the tpms low critical offset pressure percent of the Asset.
tpms_low_critical_offset_pressure_psi	nullable, numeric	Will store a permitted value as the tpms low critical offset pressure psi of the Asset.
tpms_low_warning_offset_pressure_percent	nullable, integer	Will store a permitted value as the tpms low warning offset pressure percent of the Asset.
tpms_low_warning_offset_pressure_psi	nullable, numeric	Will store a permitted value as the tpms low warning offset pressure psi of the Asset.
tpms_sensor_count	nullable, integer	Will store a permitted value as the tpms sensor count of the Asset.
tpms_expected_pressure_psi	integer, min:1, max:200	Will store a permitted value as the TPMS expected pressure (psi) of the Asset.
tpms_cold_inflation_temperature_c	integer	Will store a permitted value as the TPMS cold inflation temperature (degrees c) of the Asset.
default_questionnaire_id	nullable, exists:Questionnaire	Will store a permitted value as the default questionnaire id of the Asset.
properties	array	Will store a permitted value as the properties of the Asset.
properties.weight_limit_ton	nullable, numeric	Will store a permitted value as the weight limit ton of the Asset's properties.
properties.gross_vehicle_weight_kg	nullable, integer, min:0	Will store a permitted value as the gross vehicle weight (in Kg) of the Asset's properties.
properties.unladen_weight_kg	nullable, integer, min:0	Will store a permitted value as the unladen weight (in Kg) of the Asset's properties.
properties.has_crane	nullable, boolean	Will store a permitted value as the has crane of the Asset's properties.
properties.has_moffett	nullable, boolean	Will store a permitted value as the has moffett of the Asset's properties.
properties.has_tail_lift	nullable, boolean	Will store a permitted value as the has tail lift of the Asset's properties.
properties.tail_lift_type_id	nullable, integer, exists:TailLiftType	Will store a permitted value as the tail lift type id of the Asset's properties.
properties.tail_lift_capacity_kg	nullable, integer	Will store a permitted value as the tail lift capacity (in Kg) of the Asset's properties.
properties.tail_lift_manufacturer_id	nullable, integer, exists:TailLiftManufacturer	Will store a permitted value as the tail lift manufacturer id of the Asset's properties.
properties.has_draw_bar	nullable, boolean	Will store a permitted value as the has draw bar of the Asset's properties.
properties.has_fridge	nullable, boolean	Will store a permitted value as the has fridge of the Asset's properties.
properties.has_generator	nullable, boolean	Will store a permitted value as the has generator of the Asset's properties.
properties.has_cage	nullable, boolean	Will store a permitted value as the has cage of the Asset's properties.
properties.has_step_frame	nullable, boolean	Will store a permitted value as the has step frame of the Asset's properties.
properties.trailer_axle_type_id	nullable, integer, exists:TrailerAxleType	Will store a permitted value as the trailer axle type id of the Asset's properties.
properties.trailer_body_type_id	nullable, integer, exists:TrailerBodyType	Will store a permitted value as the trailer body type id of the Asset's properties.
properties.trailer_frame_type_id	nullable, integer, exists:TrailerFrameType	Will store a permitted value as the trailer frame type id of the Asset's properties.
properties.trailer_deck_type_id	nullable, integer, exists:TrailerDeckType	Will store a permitted value as the trailer deck type id of the Asset's properties.
properties.fridge_type_id	nullable, integer, exists:FridgeType	Will store a permitted value as the fridge type id of the Asset's properties.
properties.fridge_layout_type_id	nullable, integer, exists:FridgeLayoutType	Will store a permitted value as the fridge layout type id of the Asset's properties.
properties.fridge_manufacturer_id	nullable, integer, exists:FridgeManufacturer	Will store a permitted value as the fridge manufacturer id of the Asset's properties.
properties.fridge_model	nullable, string	Will store a permitted value as the fridge model of the Asset's properties.
properties.fridge_chassis_number	nullable, string	Will store a permitted value as the fridge chassis number of the Asset's properties.
properties.fridge_date_of_manufacture	nullable, date	Will store a permitted value as the fridge date of manufacture of the Asset's properties.
properties.fridge_warranty_months	nullable, integer	Will store a permitted value as the fridge warranty months of the Asset's properties.
properties.tractor_unit_axle_type_id	nullable, integer, exists:TractorUnitAxleType	Will store a permitted value as the tractor unit axle type id of the Asset's properties.
properties.transmission_type_id	nullable, integer, exists:TransmissionType	Will store a permitted value as the transmission type id of the Asset's properties.
properties.van_body_type_id	nullable, integer, exists:VanBodyType	Will store a permitted value as the van body type id of the Asset's properties.
properties.car_body_type_id	nullable, integer, exists:CarBodyType	Will store a permitted value as the car body type id of the Asset's properties.
properties.moffett_support_fitting_type_id	nullable, integer, exists:MoffettSupportFittingType	Will store a permitted value as the moffett support fitting type id of the Asset's properties.
properties.rigid_body_manufacturer_id	nullable, integer, exists:CompanyRigidBodyManufacturer	Will store a permitted value as the rigid body manufacturer id of the Asset's properties.
properties.mhe_type_id	nullable, integer, exists:MheType	Will store a permitted value as the mhe type id of the Asset's properties.
properties.number_of_batteries	nullable, integer, min:0	Will store a permitted value as the number of batteries of the Asset's properties.
properties.battery_serial_number_1	nullable, string	Will store a permitted value as the battery serial number 1 of the Asset's properties.
properties.battery_serial_number_2	nullable, string	Will store a permitted value as the battery serial number 2 of the Asset's properties.
properties.working_hours_per_year	nullable, integer, min:0	Will store a permitted value as the working hours per year of the Asset's properties.
properties.total_height_of_elevation_m	nullable, numeric, min:0	Will store a permitted value as the total height of elevation (in Metres) of the Asset's properties.
properties.mast_type_id	nullable, integer, exists:MastType	Will store a permitted value as the mast type id of the Asset's properties.
properties.mast_height_retracted_m	nullable, numeric, min:0	Will store a permitted value as the mast height retracted (in Metres) of the Asset's properties.
properties.mast_lift_height_m	nullable, numeric, min:0	Will store a permitted value as the mast lift height (in Metres) of the Asset's properties.
properties.capacity_kg	nullable, numeric, min:0	Will store a permitted value as the capacity (in Kg) of the Asset's properties.
properties.capacity_at_maximum_height_kg	nullable, numeric, min:0	Will store a permitted value as the capacity at maximum height (in Kg) of the Asset's properties.
properties.number_of_wheels	nullable, numeric, min:0	Will store a permitted value as the number of wheels of the Asset's properties.
properties.length_of_forks_mm	nullable, numeric, min:0	Will store a permitted value as the length of forks (in Mm) of the Asset's properties.
properties.width_of_forks_mm	nullable, numeric, min:0	Will store a permitted value as the width of forks (in Mm) of the Asset's properties.
properties.aisle_width_mm	nullable, numeric, min:0	Will store a permitted value as the aisle width (in Mm) of the Asset's properties.
properties.side_shift_availability_type_id	nullable, integer, exists:SideShiftAvailabilityType	Will store a permitted value as the side shift availability type id of the Asset's properties.
properties.side_protections	nullable, boolean	Will store a permitted value as the side protections of the Asset's properties.
properties.platform	nullable, boolean	Will store a permitted value as the platform of the Asset's properties.
properties.aspect_ratio_percent	nullable, integer, min:0	Will store a permitted value as the aspect ratio percent of the Asset's properties.
properties.section_width_mm	nullable, integer, min:0	Will store a permitted value as the section width (in Mm) of the Asset's properties.
properties.rim_diameter_in	nullable, numeric	Will store a permitted value as the rim diameter (in Inches) of the Asset's properties.
properties.mhe_attachment	array	Will store a permitted value as the mhe attachment of the Asset's properties.
properties.mhe_attachment.*.id	integer, exists:MheAttachment	Will store a permitted value as the mhe attachment of the Asset's properties.

Asset Show Request

Request

URL	new/asset/{asset}
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/new/asset/{asset}
{asset}	Replace with the ID of the required Asset.

Parameters

Filters

KEY	TYPE	DESCRIPTION
maintenance_start_date	date	Filter by the Asset's maintenance start date. Will return all Assets that have a maintenance start date that occurs after the given date.
maintenance_end_date	date	Filter by the Asset's maintenance end date. Will return all Assets that have a maintenance end date that occurs before the given date.
mileage_snapshot_day_start_date	date	Filter by the Asset's mileage snapshot day start date. Will return all Assets that have a mileage snapshot day start date that occurs after the given date.
mileage_snapshot_day_end_date	date	Filter by the Asset's mileage snapshot day end date. Will return all Assets that have a mileage snapshot day end date that occurs before the given date.
mileage_snapshot_week_start_date	date	Filter by the Asset's mileage snapshot week start date. Will return all Assets that have a mileage snapshot week start date that occurs after the given date.
mileage_snapshot_week_end_date	date	Filter by the Asset's mileage snapshot week end date. Will return all Assets that have a mileage snapshot week end date that occurs before the given date.
mileage_snapshot_month_start_date	date	Filter by the Asset's mileage snapshot month start date. Will return all Assets that have a mileage snapshot month start date that occurs after the given date.
mileage_snapshot_month_end_date	date	Filter by the Asset's mileage snapshot month end date. Will return all Assets that have a mileage snapshot month end date that occurs before the given date.
socket_gui_id	string	Filter by the Asset's socket gui id. Will return all Assets that have a socket gui id that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_type	boolean	If true, includes the type of an Asset.	type
with_company	boolean	If true, includes the company of an Asset.	company
with_group	boolean	If true, includes the group of an Asset.	group
with_last_transfer_date	boolean	If true, includes the last transfer date of an Asset.	last_transfer_date
with_manufacturer	boolean	If true, includes the manufacturer of an Asset.	manufacturer
with_model	boolean	If true, includes the model of an Asset.	model
with_owner	boolean	If true, includes the owner of an Asset.	owner
with_completed_checklist_items	boolean	If true, includes the completed checklist items of an Asset.	completed_checklist_items
with_completed_checklist_items_icon	boolean	If true, includes the completed checklist items icon of an Asset.	completed_checklist_items_icon
with_business_unit	boolean	If true, includes the business unit of an Asset.	business_unit
with_cost_centre	boolean	If true, includes the cost centre of an Asset.	cost_centre
with_customer	boolean	If true, includes the customer of an Asset.	customer
with_insurance_category	boolean	If true, includes the insurance category of an Asset.	insurance_category
with_insurance_type	boolean	If true, includes the insurance type of an Asset.	insurance_type
with_tyre_arrangement	boolean	If true, includes the tyre arrangement of an Asset.	tyre_arrangement
with_operating_centre	boolean	If true, includes the operating centre of an Asset.	operating_centre
with_operator_licence	boolean	If true, includes the operator licence of an Asset.	operator_licence
with_site	boolean	If true, includes the site of an Asset.	site
with_location	boolean	If true, includes the location (or POI) of an Asset.	location
with_poi	boolean	If true, includes the poi of an Asset.	poi
with_dcu	boolean	If true, includes the dcu of an Asset.	dcu
with_clone_dcu	boolean	If true, includes the clone dcu of an Asset.	clone_dcu
with_function_box	boolean	If true, includes the function box of an Asset.	function_box
with_pgns	boolean	If true, includes the pgns of an Asset.	pgns
with_last_ebpms_calc	boolean	If true, includes the last ebpms calc of an Asset.	last_ebpms_calc
with_finance_type	boolean	If true, includes the finance type of an Asset.	finance_type
with_use_class	boolean	If true, includes the use class of an Asset.	use_class
with_country	boolean	If true, includes the country of an Asset.	country
with_fuel_type	boolean	If true, includes the fuel type of an Asset.	fuel_type
with_axle_manufacturer	boolean	If true, includes the axle manufacturer of an Asset.	axle_manufacturer
with_emission_standard	boolean	If true, includes the emission standard of an Asset.	emission_standard
with_emissions	boolean	If true, includes the emissions of an Asset.	emissions
with_coupled	boolean	If true, includes the coupled status of an Asset.	coupled
with_properties	boolean	If true, includes the properties of an Asset.	properties
with_rigid_body_manufacturer	boolean	If true, includes the rigid body manufacturer of an Asset.	rigid_body_manufacturer
with_livery	boolean	If true, includes the livery of an Asset.	livery
with_ebpms_transitioned	boolean	If true, includes the ebpms transitioned of an Asset.	ebpms_transitioned
with_contract_visibility_type	boolean	If true, includes the contract visibility type of an Asset.	contract_visibility_type
with_default_maintenance_provider	boolean	If true, includes the default maintenance provider of an Asset.	default_maintenance_provider
with_dvs_permit_holder	boolean	If true, includes the dvs permit holder of an Asset.	dvs_permit_holder
with_external_devices	boolean	If true, includes the external devices of an Asset.	external_devices
with_overall_icon_name	boolean	If true, includes the overall icon name of an Asset.	overall_icon_name
with_tyres	boolean	If true, includes the tyres of an Asset.	tyres
with_tpms	boolean	If true, includes the tpms of an Asset.	tpms
with_gps_log	boolean	If true, includes the gps log of an Asset.	gps_log
with_gps	boolean	If true, includes the gps of an Asset.	gps
with_maintenance_statuses	boolean	If true, includes the maintenance statuses of an Asset.	maintenance_statuses
with_company_min_walkaround_asset_maintenance_status	boolean	If true, includes the company min walkaround asset maintenance status of an Asset.	company_min_walkaround_asset_maintenance_status
with_ebpms_event_record	boolean	If true, includes the ebpms event record of an Asset.	ebpms_event_record
with_latest_ebpms_score	boolean	If true, includes the latest ebpms score of an Asset.	latest_ebpms_score
with_latest_ebpms_weekly_score	boolean	If true, includes the latest ebpms weekly score of an Asset.	latest_ebpms_weekly_score
with_ebpms_computed_configuration	boolean	If true, includes the ebpms computed configuration of an Asset.	ebpms_computed_configuration
with_ebpms_full_progress	boolean	If true, includes the ebpms full progress of an Asset.	ebpms_full_progress
with_ebpms_data_providers	boolean	If true, includes the ebpms data providers of an Asset.	ebpms_data_providers
with_data_providers	boolean	If true, includes the data providers of an Asset.	data_providers
with_asset_feature_settings	boolean	If true, includes the asset feature settings of an Asset.	asset_feature_settings
with_asset_finance_calculated_fields	boolean	If true, includes the asset finance calculated fields of an Asset.	asset_finance_calculated_fields
with_repair_arrangement	boolean	If true, includes the repair arrangement of an Asset.	repair_arrangement
with_ebs_detected_type	boolean	If true, includes the ebs detected type of an Asset.	ebs_detected_type
with_histogram	boolean	If true, includes the histogram of an Asset.	histogram
with_lamps	boolean	If true, includes the lamps of an Asset.	lamps
with_currency	boolean	If true, includes the currency of an Asset.	currency
with_vor_status	boolean	If true, includes the vor status of an Asset.	vor_status
with_properties_weight_limit_ton	boolean	If true, includes the properties weight limit ton of an Asset.	properties_weight_limit_ton
with_properties_gross_vehicle_weight_kg	boolean	If true, includes the properties gross vehicle weight (in Kg) of an Asset.	properties_gross_vehicle_weight_kg
with_properties_unladen_weight_kg	boolean	If true, includes the properties unladen weight (in Kg) of an Asset.	properties_unladen_weight_kg
with_properties_has_crane	boolean	If true, includes the properties has crane field of an Asset.	properties_has_crane
with_properties_has_moffett	boolean	If true, includes the properties has moffett field of an Asset.	properties_has_moffett
with_properties_has_tail_lift	boolean	If true, includes the properties has tail lift field of an Asset.	properties_has_tail_lift
with_properties_tail_lift_type	boolean	If true, includes the properties tail lift type of an Asset.	properties_tail_lift_type
with_properties_tail_lift_capacity_kg	boolean	If true, includes the properties tail lift capacity (in Kg) of an Asset.	properties_tail_lift_capacity_kg
with_properties_tail_lift_manufacturer	boolean	If true, includes the properties tail lift manufacturer of an Asset.	properties_tail_lift_manufacturer
with_properties_has_draw_bar	boolean	If true, includes the properties has draw bar field of an Asset.	properties_has_draw_bar
with_properties_has_fridge	boolean	If true, includes the properties has fridge field of an Asset.	properties_has_fridge
with_properties_has_generator	boolean	If true, includes the properties has generator field of an Asset.	properties_has_generator
with_properties_has_cage	boolean	If true, includes the properties has cage field of an Asset.	properties_has_cage
with_properties_has_step_frame	boolean	If true, includes the properties has step frame field of an Asset.	properties_has_step_frame
with_properties_trailer_axle_type	boolean	If true, includes the properties trailer axle type of an Asset.	properties_trailer_axle_type
with_properties_trailer_body_type	boolean	If true, includes the properties trailer body type of an Asset.	properties_trailer_body_type
with_properties_trailer_frame_type	boolean	If true, includes the properties trailer frame type of an Asset.	properties_trailer_frame_type
with_properties_trailer_deck_type	boolean	If true, includes the properties trailer deck type of an Asset.	properties_trailer_deck_type
with_properties_fridge_type	boolean	If true, includes the properties fridge type of an Asset.	properties_fridge_type
with_properties_fridge_layout_type	boolean	If true, includes the properties fridge layout type of an Asset.	properties_fridge_layout_type
with_properties_fridge_manufacturer	boolean	If true, includes the properties fridge manufacturer of an Asset.	properties_fridge_manufacturer
with_properties_fridge_model	boolean	If true, includes the properties fridge model of an Asset.	properties_fridge_model
with_properties_fridge_chassis_number	boolean	If true, includes the properties fridge chassis number of an Asset.	properties_fridge_chassis_number
with_properties_fridge_date_of_manufacture	boolean	If true, includes the properties fridge date of manufacture of an Asset.	properties_fridge_date_of_manufacture
with_properties_fridge_warranty_months	boolean	If true, includes the properties fridge warranty months of an Asset.	properties_fridge_warranty_months
with_properties_tractor_unit_axle_type	boolean	If true, includes the properties tractor unit axle type of an Asset.	properties_tractor_unit_axle_type
with_properties_transmission_type	boolean	If true, includes the properties transmission type of an Asset.	properties_transmission_type
with_properties_van_body_type	boolean	If true, includes the properties van body type of an Asset.	properties_van_body_type
with_properties_car_body_type	boolean	If true, includes the properties car body type of an Asset.	properties_car_body_type
with_properties_moffett_support_fitting_type	boolean	If true, includes the properties moffett support fitting type of an Asset.	properties_moffett_support_fitting_type
with_properties_rigid_body_manufacturer	boolean	If true, includes the properties rigid body manufacturer of an Asset.	properties_rigid_body_manufacturer
with_properties_mhe_type	boolean	If true, includes the properties mhe type of an Asset.	properties_mhe_type
with_properties_number_of_batteries	boolean	If true, includes the properties number of batteries of an Asset.	properties_number_of_batteries
with_properties_battery_serial_number_1	boolean	If true, includes the properties battery serial number 1 of an Asset.	properties_battery_serial_number_1
with_properties_battery_serial_number_2	boolean	If true, includes the properties battery serial number 2 of an Asset.	properties_battery_serial_number_2
with_properties_working_hours_per_year	boolean	If true, includes the properties working hours per year of an Asset.	properties_working_hours_per_year
with_properties_total_height_of_elevation_m	boolean	If true, includes the properties total height of elevation (in Metres) of an Asset.	properties_total_height_of_elevation_m
with_properties_mast_height_retracted_m	boolean	If true, includes the properties mast height retracted (in Metres) of an Asset.	properties_mast_height_retracted_m
with_properties_mast_lift_height_m	boolean	If true, includes the properties mast lift height (in Metres) of an Asset.	properties_mast_lift_height_m
with_properties_capacity_kg	boolean	If true, includes the properties capacity (in Kg) of an Asset.	properties_capacity_kg
with_properties_capacity_at_maximum_height_kg	boolean	If true, includes the properties capacity at maximum height (in Kg) of an Asset.	properties_capacity_at_maximum_height_kg
with_properties_number_of_wheels	boolean	If true, includes the properties number of wheels of an Asset.	properties_number_of_wheels
with_properties_length_of_forks_mm	boolean	If true, includes the properties length of forks (in Mm) of an Asset.	properties_length_of_forks_mm
with_properties_width_of_forks_mm	boolean	If true, includes the properties width of forks (in Mm) of an Asset.	properties_width_of_forks_mm
with_properties_aisle_width_mm	boolean	If true, includes the properties aisle width (in Mm) of an Asset.	properties_aisle_width_mm
with_properties_side_shift_availability_type	boolean	If true, includes the properties side shift availability type of an Asset.	properties_side_shift_availability_type
with_properties_side_protections	boolean	If true, includes the properties side protections of an Asset.	properties_side_protections
with_properties_platform	boolean	If true, includes the properties platform of an Asset.	properties_platform
with_properties_mast_type	boolean	If true, includes the properties mast type of an Asset.	properties_mast_type
with_properties_section_width_mm	boolean	If true, includes the properties section width (in Mm) of an Asset.	properties_section_width_mm
with_properties_aspect_ratio_percent	boolean	If true, includes the properties aspect ratio percent of an Asset.	properties_aspect_ratio_percent
with_properties_rim_diameter_in	boolean	If true, includes the properties rim diameter in of an Asset.	properties_rim_diameter_in

Asset Edit Request

Request

URL	new/asset/{asset}/edit
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/new/asset/{asset}/edit
{asset}	Replace with the ID of the required Asset.

Parameters

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_features	boolean	If true, includes the features of an Asset.	features
with_properties	boolean	If true, includes the properties of an Asset.	properties
with_adr	boolean	If true, includes the ADR field of an Asset.	adr

Asset Update Request

Request

URL	new/asset/{asset}
Method	PUT
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/new/asset/{asset}
{asset}	Replace with the ID of the required Asset.

Parameters

KEY	TYPE	DESCRIPTION
name	string	Will update a permitted value as the name of the Asset.
ministry_number	nullable, string	Will update a permitted value as the ministry number of the Asset.
chassis_number	nullable, string	Will update a permitted value as the chassis number of the Asset.
feature_setting_id	nullable, integer, exists:AssetFeatureSetting	Will update a permitted value as the feature setting id of the Asset.
company_id	integer, exists:Company	Will update a permitted value as the company id of the Asset.
owner_id	nullable, integer, exists:Company	Will update a permitted value as the owner id of the Asset.
leaseholder_id	nullable, integer, exists:Leaseholder	Will update a permitted value as the leaseholder id of the Asset.
manufacturer_id	nullable, integer, exists:Company	Will update a permitted value as the manufacturer id of the Asset.
model_id	nullable, integer, exists:Model	Will update a permitted value as the model id of the Asset.
group_id	integer, exists:Group	Will update a permitted value as the group id of the Asset.
asset_build_id	nullable, integer, exists:AssetBuild	Will update a permitted value as the asset build id of the Asset.
asset_type_id	nullable, integer, exists:AssetType	Will update a permitted value as the asset type id of the Asset.
asset_subtype_id	nullable, integer, exists:AssetSubtype	Will update a permitted value as the asset subtype id of the Asset.
dvs_permit_information	string, nullable	Will update a permitted value as the dvs permit information of the Asset.
dvs_permit_holder_id	nullable, integer, exists:DvsPermitHolder	Will update a permitted value as the dvs permit holder id of the Asset.
dvs_permit_star_rating	nullable, integer, min:0, max:5	Will update a permitted value as the dvs permit star rating of the Asset.
dvs_permit_expiry_date	nullable, date	Will update a permitted value as the dvs permit expiry date of the Asset.
dvs_permit_start_date	nullable, date	Will update a permitted value as the dvs permit start date of the Asset.
en_12642xl_certified	boolean	Will update the en 12642xl certified value of the Asset as either true or false depending on the value passed.
livery_id	nullable, integer, exists:Livery	Will update a permitted value as the livery id of the Asset.
internal_height_m	nullable, numeric, min:0	Will update a permitted value as the internal height (in Metres) of the Asset.
internal_length_m	nullable, numeric, min:0	Will update a permitted value as the internal length (in Metres) of the Asset.
internal_width_m	nullable, numeric, min:0	Will update a permitted value as the internal width (in Metres) of the Asset.
height_m	nullable, numeric, min:0	Will update a permitted value as the height (in Metres) of the Asset.
length_m	nullable, numeric, min:0	Will update a permitted value as the length (in Metres) of the Asset.
width_m	nullable, numeric, min:0	Will update a permitted value as the width (in Metres) of the Asset.
fifth_wheel_height_m	nullable, numeric, min:0	Will update a permitted value as the fifth wheel height (in Metres) of the Asset.
loading_height_through_sides_m	nullable, numeric, min:0	Will update a permitted value as the loading height through sides (in Metres) of the Asset.
vor_status	integer	Will update a permitted value as the vor status of the Asset.
vor_sub_status	integer	Will update a permitted value as the vor sub status of the Asset.
note	nullable, string	Will update a permitted value as the note of the Asset.
yard_location	nullable, string	Will update a permitted value as the yard location of the Asset.
site_id	nullable, integer, exists:Site	Will update a permitted value as the site id of the Asset.
business_unit_id	nullable, integer, exists:BusinessUnit	Will update a permitted value as the business unit id of the Asset.
cost_centre_id	nullable, integer, exists:CostCentre	Will update a permitted value as the cost centre id of the Asset.
customer_id	nullable, integer, exists:Customer	Will update a permitted value as the customer id of the Asset.
operating_centre_id	nullable, integer, exists:OperatingCentre	Will update a permitted value as the operating centre id of the Asset.
operator_licence_id	nullable, integer, exists:OperatorLicence	Will update a permitted value as the operator licence id of the Asset.
insurance_category_id	nullable, integer, exists:InsuranceCategory	Will update a permitted value as the insurance category id of the Asset.
insurance_type_id	nullable, integer, exists:InsuranceType	Will update a permitted value as the insurance type id of the Asset.
asset_emission_standard_id	nullable, integer, exists:AssetEmissionStandard	Will update a permitted value as the asset emission standard id of the Asset.
emissions	nullable, integer	Will update a permitted value as the emissions of the Asset.
asset_use_class_id	nullable, integer, exists:AssetUseClass	Will update a permitted value as the asset use class id of the Asset.
country_id	nullable, integer, exists:Country	Will update a permitted value as the country id of the Asset.
fuel_type_id	nullable, integer, exists:FuelType	Will update a permitted value as the fuel type id of the Asset.
axle_manufacturer_id	nullable, integer, exists:AxleManufacturer	Will update a permitted value as the axle manufacturer id of the Asset.
registration_number	nullable, string	Will update a permitted value as the registration number of the Asset.
serial_number	nullable, string	Will update a permitted value as the serial number of the Asset.
alternate_name	nullable, string	Will update a permitted value as the alternate name of the Asset.
specification_code	nullable, string	Will update a permitted value as the specification code of the Asset.
registered_at	nullable, date	Will update a permitted value as the registered at of the Asset.
manufactured_at	nullable, date	Will update a permitted value as the manufactured at of the Asset.
colour_id	nullable, integer, exists:Colour	Will update a permitted value as the colour id of the Asset.
parc_unique_id	nullable	Will update a permitted value as the parc unique id of the Asset.
contract_visibility_type_id	nullable, integer, exists:ContractVisibilityType	Will update a permitted value as the contract visibility type id of the Asset.
default_maintenance_provider_id	nullable, integer, exists:MaintenanceProvider	Will update a permitted value as the default maintenance provider id of the Asset.
asset_properties_id	nullable, integer, exists:AssetProperties	Will update a permitted value as the asset properties id of the Asset.
ebpms_max_age_days	nullable, integer, min:0	Will update a permitted value as the ebpms max age days of the Asset.
adr	nullable, boolean	Will update the adr value of the Asset as either true or false depending on the value passed.
lookup_enabled	boolean	Will update the lookup enabled value of the Asset as either true or false depending on the value passed.
earned_recognition_enabled	nullable, boolean	Will update the earned recognition enabled value of the Asset as either true or false depending on the value passed.
asset_finance_type_id	nullable, integer, exists:AssetFinanceType	Will update a permitted value as the asset finance type id of the Asset.
average_mpg	nullable, numeric	Will update a permitted value as the average mpg of the Asset.
buyback_agreement	nullable, boolean	Will update the buyback agreement value of the Asset as either true or false depending on the value passed.
contracted_allowed_distance_km_per_year	nullable, numeric	Will update a permitted value as the contracted allowed distance km per year of the Asset.
currency_id	nullable, integer, exists:Currency	Will update a permitted value as the currency id of the Asset.
ebis_code_id	nullable, integer, exists:EbisCode	Will update a permitted value as the ebis code id of the Asset.
extension_end_date	nullable, date	Will update a permitted value as the extension end date of the Asset.
extension_start_date	nullable, date	Will update a permitted value as the extension start date of the Asset.
extension_weekly_cost	nullable, numeric	Will update a permitted value as the extension weekly cost of the Asset.
insurance_end_date	nullable, date	Will update a permitted value as the insurance end date of the Asset.
insurance_rate	nullable, numeric	Will update a permitted value as the insurance rate of the Asset.
insurance_start_date	nullable, date	Will update a permitted value as the insurance start date of the Asset.
lease_end_date	nullable, date	Will update a permitted value as the lease end date of the Asset.
lease_monthly_cost	nullable, numeric	Will update a permitted value as the lease monthly cost of the Asset.
lease_number	nullable, string	Will update a permitted value as the lease number of the Asset.
lease_number_internal_reference	nullable, string	Will update a permitted value as the lease number internal reference of the Asset.
lease_period_months	nullable, numeric	Will update a permitted value as the lease period months of the Asset.
lease_start_date	nullable, date	Will update a permitted value as the lease start date of the Asset.
lease_weekly_cost	nullable, numeric	Will update a permitted value as the lease weekly cost of the Asset.
mileage_pool_id	nullable, integer, exists:MileagePool	Will update a permitted value as the mileage pool id of the Asset.
repair_and_maintenance_date	nullable, date	Will update a permitted value as the repair and maintenance date of the Asset.
repair_and_maintenance_rate	nullable, numeric	Will update a permitted value as the repair and maintenance rate of the Asset.
repair_arrangement_id	nullable, integer, exists:RepairArrangement	Will update a permitted value as the repair arrangement id of the Asset.
road_fund_licence_rate	nullable, numeric	Will update a permitted value as the road fund licence rate of the Asset.
tyre_arrangement_id	nullable, integer, exists:TyreArrangement	Will update a permitted value as the tyre arrangement id of the Asset.
warranty_date	nullable, date	Will update a permitted value as the warranty date of the Asset.
ebpms_transitioned	boolean	Will update the ebpms transitioned value of the Asset as either true or false depending on the value passed.
decommissioned	boolean	Will update the decommissioned value of the Asset as either true or false depending on the value passed.
wheels_per_axle	nullable, integer	Will update a permitted value as the wheels per axle of the Asset.
axle_count	nullable, integer	Will update a permitted value as the axle count of the Asset.
axle_load_unladen_kg	nullable, integer	Will update a permitted value as the axle load unladen (in Kg) of the Asset.
axle_load_laden_kg	nullable, integer	Will update a permitted value as the axle load laden (in Kg) of the Asset.
bag_pressure_unladen_bar	nullable, numeric	Will update a permitted value as the bag pressure when unladen (bar) of the Asset.
bag_pressure_laden_bar	nullable, numeric	Will update a permitted value as the bag pressure when laden (bar) of the Asset.
overload_warning_percentage	integer	Will update a permitted value as the overload warning percentage of the Asset.
overload_critical_percentage	integer	Will update a permitted value as the overload critical percentage of the Asset.
tpms_high_critical_offset_pressure_percent	nullable, integer	Will update a permitted value as the tpms high critical offset pressure percent of the Asset.
tpms_high_critical_offset_pressure_psi	nullable, numeric	Will update a permitted value as the tpms high critical offset pressure psi of the Asset.
tpms_high_warning_offset_pressure_percent	nullable, integer	Will update a permitted value as the tpms high warning offset pressure percent of the Asset.
tpms_high_warning_offset_pressure_psi	nullable, numeric	Will update a permitted value as the tpms high warning offset pressure psi of the Asset.
tpms_low_critical_offset_pressure_percent	nullable, integer	Will update a permitted value as the tpms low critical offset pressure percent of the Asset.
tpms_low_critical_offset_pressure_psi	nullable, numeric	Will update a permitted value as the tpms low critical offset pressure psi of the Asset.
tpms_low_warning_offset_pressure_percent	nullable, integer	Will update a permitted value as the tpms low warning offset pressure percent of the Asset.
tpms_low_warning_offset_pressure_psi	nullable, numeric	Will update a permitted value as the tpms low warning offset pressure psi of the Asset.
tpms_sensor_count	nullable, integer	Will update a permitted value as the tpms sensor count of the Asset.
tpms_expected_pressure_psi	integer, min:1, max:200	Will update a permitted value as the TPMS expected pressure (psi) of the Asset.
tpms_cold_inflation_temperature_c	integer	Will update a permitted value as the TPMS cold inflation temperature (degrees c) of the Asset.
default_questionnaire_id	nullable, exists:Questionnaire	Will update a permitted value as the default questionnaire id of the Asset.
properties	array	Will update a permitted value as the properties of the Asset.
properties.weight_limit_ton	nullable, numeric	Will update a permitted value as the weight limit ton of the Asset's properties.
properties.gross_vehicle_weight_kg	nullable, integer, min:0	Will update a permitted value as the gross vehicle weight (in Kg) of the Asset's properties.
properties.unladen_weight_kg	nullable, integer, min:0	Will update a permitted value as the unladen weight (in Kg) of the Asset's properties.
properties.has_crane	nullable, boolean	Will update a permitted value as the has crane of the Asset's properties.
properties.has_moffett	nullable, boolean	Will update a permitted value as the has moffett of the Asset's properties.
properties.has_tail_lift	nullable, boolean	Will update a permitted value as the has tail lift of the Asset's properties.
properties.tail_lift_type_id	nullable, integer, exists:TailLiftType	Will update a permitted value as the tail lift type id of the Asset's properties.
properties.tail_lift_capacity_kg	nullable, integer	Will update a permitted value as the tail lift capacity (in Kg) of the Asset's properties.
properties.tail_lift_manufacturer_id	nullable, integer, exists:TailLiftManufacturer	Will update a permitted value as the tail lift manufacturer id of the Asset's properties.
properties.has_draw_bar	nullable, boolean	Will update a permitted value as the has draw bar of the Asset's properties.
properties.has_fridge	nullable, boolean	Will update a permitted value as the has fridge of the Asset's properties.
properties.has_generator	nullable, boolean	Will update a permitted value as the has generator of the Asset's properties.
properties.has_cage	nullable, boolean	Will update a permitted value as the has cage of the Asset's properties.
properties.has_step_frame	nullable, boolean	Will update a permitted value as the has step frame of the Asset's properties.
properties.trailer_axle_type_id	nullable, integer, exists:TrailerAxleType	Will update a permitted value as the trailer axle type id of the Asset's properties.
properties.trailer_body_type_id	nullable, integer, exists:TrailerBodyType	Will update a permitted value as the trailer body type id of the Asset's properties.
properties.trailer_frame_type_id	nullable, integer, exists:TrailerFrameType	Will update a permitted value as the trailer frame type id of the Asset's properties.
properties.trailer_deck_type_id	nullable, integer, exists:TrailerDeckType	Will update a permitted value as the trailer deck type id of the Asset's properties.
properties.fridge_type_id	nullable, integer, exists:FridgeType	Will update a permitted value as the fridge type id of the Asset's properties.
properties.fridge_layout_type_id	nullable, integer, exists:FridgeLayoutType	Will update a permitted value as the fridge layout type id of the Asset's properties.
properties.fridge_manufacturer_id	nullable, integer, exists:FridgeManufacturer	Will update a permitted value as the fridge manufacturer id of the Asset's properties.
properties.fridge_model	nullable, string	Will update a permitted value as the fridge model of the Asset's properties.
properties.fridge_chassis_number	nullable, string	Will update a permitted value as the fridge chassis number of the Asset's properties.
properties.fridge_date_of_manufacture	nullable, date	Will update a permitted value as the fridge date of manufacture of the Asset's properties.
properties.fridge_warranty_months	nullable, integer	Will update a permitted value as the fridge warranty months of the Asset's properties.
properties.tractor_unit_axle_type_id	nullable, integer, exists:TractorUnitAxleType	Will update a permitted value as the tractor unit axle type id of the Asset's properties.
properties.transmission_type_id	nullable, integer, exists:TransmissionType	Will update a permitted value as the transmission type id of the Asset's properties.
properties.van_body_type_id	nullable, integer, exists:VanBodyType	Will update a permitted value as the van body type id of the Asset's properties.
properties.car_body_type_id	nullable, integer, exists:CarBodyType	Will update a permitted value as the car body type id of the Asset's properties.
properties.moffett_support_fitting_type_id	nullable, integer, exists:MoffettSupportFittingType	Will update a permitted value as the moffett support fitting type id of the Asset's properties.
properties.rigid_body_manufacturer_id	nullable, integer, exists:CompanyRigidBodyManufacturer	Will update a permitted value as the rigid body manufacturer id of the Asset's properties.
properties.mhe_type_id	nullable, integer, exists:MheType	Will update a permitted value as the mhe type id of the Asset's properties.
properties.number_of_batteries	nullable, integer, min:0	Will update a permitted value as the number of batteries of the Asset's properties.
properties.battery_serial_number_1	nullable, string	Will update a permitted value as the battery serial number 1 of the Asset's properties.
properties.battery_serial_number_2	nullable, string	Will update a permitted value as the battery serial number 2 of the Asset's properties.
properties.working_hours_per_year	nullable, integer, min:0	Will update a permitted value as the working hours per year of the Asset's properties.
properties.total_height_of_elevation_m	nullable, numeric, min:0	Will update a permitted value as the total height of elevation (in Metres) of the Asset's properties.
properties.mast_type_id	nullable, integer, exists:MastType	Will update a permitted value as the mast type id of the Asset's properties.
properties.mast_height_retracted_m	nullable, numeric, min:0	Will update a permitted value as the mast height retracted (in Metres) of the Asset's properties.
properties.mast_lift_height_m	nullable, numeric, min:0	Will update a permitted value as the mast lift height (in Metres) of the Asset's properties.
properties.capacity_kg	nullable, numeric, min:0	Will update a permitted value as the capacity (in Kg) of the Asset's properties.
properties.capacity_at_maximum_height_kg	nullable, numeric, min:0	Will update a permitted value as the capacity at maximum height (in Kg) of the Asset's properties.
properties.number_of_wheels	nullable, numeric, min:0	Will update a permitted value as the number of wheels of the Asset's properties.
properties.length_of_forks_mm	nullable, numeric, min:0	Will update a permitted value as the length of forks (in Mm) of the Asset's properties.
properties.width_of_forks_mm	nullable, numeric, min:0	Will update a permitted value as the width of forks (in Mm) of the Asset's properties.
properties.aisle_width_mm	nullable, numeric, min:0	Will update a permitted value as the aisle width (in Mm) of the Asset's properties.
properties.side_shift_availability_type_id	nullable, integer, exists:SideShiftAvailabilityType	Will update a permitted value as the side shift availability type id of the Asset's properties.
properties.side_protections	nullable, boolean	Will update a permitted value as the side protections of the Asset's properties.
properties.platform	nullable, boolean	Will update a permitted value as the platform of the Asset's properties.
properties.aspect_ratio_percent	nullable, integer, min:0	Will update a permitted value as the aspect ratio percent of the Asset's properties.
properties.section_width_mm	nullable, integer, min:0	Will update a permitted value as the section width (in Mm) of the Asset's properties.
properties.rim_diameter_in	nullable, numeric	Will update a permitted value as the rim diameter in of the Asset's properties.
properties.mhe_attachment	array	Will update a permitted value as the mhe attachment of the Asset's properties.
properties.mhe_attachment.*.id	integer, exists:MheAttachment	Will update a permitted value as the mhe attachment of the Asset's properties.
tyre_types	nullable, array	Will update a permitted value as the tyre types of the Asset.
tyre_types.*.id	nullable, integer, exists:TyreType	Will update a permitted value as the * of the Asset's tyre types.
tyre_types.*.count	nullable, integer, min:0	Will update a permitted value as the * of the Asset's tyre types.

Asset Record

Asset Record Index Request

Request

URL	asset-records/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-records/

Parameters

Filters

KEY	TYPE	DESCRIPTION
maintenance	boolean	Filter by whether the Asset Record is maintenance. If true, will return all Asset Records which are maintenance. If false, will return all Asset Records which are not maintenance.
maintenance_without_defect	boolean	Filter by whether the Asset Record is maintenance without defect. If true, will return all Asset Records which are maintenance without defect. If false, will return all Asset Records which are not maintenance without defect.
defect	boolean	Filter by whether the Asset Record is defect. If true, will return all Asset Records which are defect. If false, will return all Asset Records which are not defect.
scheduled	boolean	Filter by whether the Asset Record is scheduled. If true, will return all Asset Records which are scheduled. If false, will return all Asset Records which are not scheduled.
delivered	boolean	Filter by whether the Asset Record is delivered. If true, will return all Asset Records which are delivered. If false, will return all Asset Records which are not delivered.
completed	boolean	Filter by whether the Asset Record is completed. If true, will return all Asset Records which are completed. If false, will return all Asset Records which are not completed.
limit	integer, gt:0	Filter by the Asset Record's limit. Will return all Asset Records that have a limit that contains the given integer, gt:0
asset_id	exists:Asset	Filter by the Asset Record's asset id. Will return all Asset Records with the given asset id. You can see what asset ids you have access to (including the associated objects) by calling the asset index route.
asset_ids	array. Each item in the array must be an integer.	Filter by the Asset Record's asset id. Will return all Asset Records that have an asset id within the given array.
asset_record_ids	array. Each item in the array must be an integer.	Filter by the Asset Record's asset record id. Will return all Asset Records that have an asset record id within the given array.
asset_record_type_id	exists:AssetRecordType	Filter by the Asset Record's asset record type id. Will return all Asset Records with the given asset record type id. You can see what asset record type ids you have access to (including the associated objects) by calling the asset record type index route.
booked	boolean	Filter by whether the Asset Record is booked. If true, will return all Asset Records which are booked. If false, will return all Asset Records which are not booked.
missed	boolean	Filter by whether the Asset Record is missed. If true, will return all Asset Records which are missed. If false, will return all Asset Records which are not missed.
missed_maintenance	boolean	Filter by whether the Asset Record is missed maintenance. If true, will return all Asset Records which are missed maintenance. If false, will return all Asset Records which are not missed maintenance.
invalid_defects	boolean	Filter by whether the Asset Record is invalid defect. If true, will return all Asset Records which are invalid defect. If false, will return all Asset Records which are not invalid defect.
documentation_completed	boolean	Filter by whether the Asset Record is documentation completed. If true, will return all Asset Records which are documentation completed. If false, will return all Asset Records which are not documentation completed.
signed_off	boolean	Filter by whether the Asset Record is signed off. If true, will return all Asset Records which are signed off. If false, will return all Asset Records which are not signed off.
signed_off_or_documentation_completed	nullable, boolean	Filter by whether the Asset Record is signed off or documentation completed. If true, will return all Asset Records which are signed off or documentation completed. If false, will return all Asset Records which are not signed off or documentation completed.
pass_first_time	boolean	Filter by whether the Asset Record is pass first time. If true, will return all Asset Records which are pass first time. If false, will return all Asset Records which are not pass first time.
complete	boolean	Filter by whether the Asset Record is complete. If true, will return all Asset Records which are complete. If false, will return all Asset Records which are not complete.
has_attachments	boolean	Filter by whether the Asset Record has attachment monitoring enabled. If true, will return all Asset Records which have attachment monitoring enabled. If false, will return all Asset Records which do not have attachment monitoring enabled.
late	boolean	Filter by whether the Asset Record is late. If true, will return all Asset Records which are late. If false, will return all Asset Records which are not late.
created_at_before	date	Filter by the Asset Record's created at before. Will return all Asset Records that have a created at before that contains the given date
created_at_after	date	Filter by the Asset Record's created at after. Will return all Asset Records that have a created at after that contains the given date
scheduled_date_before	date	Filter by the Asset Record's scheduled date before. Will return all Asset Records that have a scheduled date before that contains the given date
scheduled_date_before_interval	integer	Filter by the Asset Record's scheduled date before interval. Will return all Asset Records that have a scheduled date before interval that contains the given integer
scheduled_date_before_interval_unit	string, in:DAY,WEEK,MONTH,YEAR	Filter by the Asset Record's scheduled date before interval unit. Will return all Asset Records that have a scheduled date before interval unit that contains the given string, in:DAY,WEEK,MONTH,YEAR
scheduled_date_after	date	Filter by the Asset Record's scheduled date after. Will return all Asset Records that have a scheduled date after that contains the given date
scheduled_date_after_interval	integer	Filter by the Asset Record's scheduled date after interval. Will return all Asset Records that have a scheduled date after interval that contains the given integer
scheduled_date_after_interval_unit	string, in:DAY,WEEK,MONTH,YEAR	Filter by the Asset Record's scheduled date after interval unit. Will return all Asset Records that have a scheduled date after interval unit that contains the given string, in:DAY,WEEK,MONTH,YEAR
delivered_date_before	date	Filter by the Asset Record's delivered date before. Will return all Asset Records that have a delivered date before that contains the given date
delivered_date_before_interval	integer	Filter by the Asset Record's delivered date before interval. Will return all Asset Records that have a delivered date before interval that contains the given integer
delivered_date_before_interval_unit	string, in:DAY,WEEK,MONTH,YEAR	Filter by the Asset Record's delivered date before interval unit. Will return all Asset Records that have a delivered date before interval unit that contains the given string, in:DAY,WEEK,MONTH,YEAR
delivered_date_after	date	Filter by the Asset Record's delivered date after. Will return all Asset Records that have a delivered date after that contains the given date
delivered_date_after_interval	integer	Filter by the Asset Record's delivered date after interval. Will return all Asset Records that have a delivered date after interval that contains the given integer
delivered_date_after_interval_unit	string, in:DAY,WEEK,MONTH,YEAR	Filter by the Asset Record's delivered date after interval unit. Will return all Asset Records that have a delivered date after interval unit that contains the given string, in:DAY,WEEK,MONTH,YEAR
booked_date_before	date	Filter by the Asset Record's booked date before. Will return all Asset Records that have a booked date before that contains the given date
booked_date_before_interval	integer	Filter by the Asset Record's booked date before interval. Will return all Asset Records that have a booked date before interval that contains the given integer
booked_date_before_interval_unit	string, in:DAY,WEEK,MONTH,YEAR	Filter by the Asset Record's booked date before interval unit. Will return all Asset Records that have a booked date before interval unit that contains the given string, in:DAY,WEEK,MONTH,YEAR
booked_date_after	date	Filter by the Asset Record's booked date after. Will return all Asset Records that have a booked date after that contains the given date
booked_date_after_interval	integer	Filter by the Asset Record's booked date after interval. Will return all Asset Records that have a booked date after interval that contains the given integer
booked_date_after_interval_unit	string, in:DAY,WEEK,MONTH,YEAR	Filter by the Asset Record's booked date after interval unit. Will return all Asset Records that have a booked date after interval unit that contains the given string, in:DAY,WEEK,MONTH,YEAR
completed_date_before	date	Filter by the Asset Record's completed date before. Will return all Asset Records that have a completed date before that contains the given date
completed_date_before_interval	integer	Filter by the Asset Record's completed date before interval. Will return all Asset Records that have a completed date before interval that contains the given integer
completed_date_before_interval_unit	string, in:DAY,WEEK,MONTH,YEAR	Filter by the Asset Record's completed date before interval unit. Will return all Asset Records that have a completed date before interval unit that contains the given string, in:DAY,WEEK,MONTH,YEAR
completed_date_after	date	Filter by the Asset Record's completed date after. Will return all Asset Records that have a completed date after that contains the given date
completed_date_after_interval	integer	Filter by the Asset Record's completed date after interval. Will return all Asset Records that have a completed date after interval that contains the given integer
completed_date_after_interval_unit	string, in:DAY,WEEK,MONTH,YEAR	Filter by the Asset Record's completed date after interval unit. Will return all Asset Records that have a completed date after interval unit that contains the given string, in:DAY,WEEK,MONTH,YEAR
min_mileage	integer	Filter by the Asset Record's min mileage. Will return all Asset Records that have a min mileage that contains the given integer
max_mileage	integer	Filter by the Asset Record's max mileage. Will return all Asset Records that have a max mileage that contains the given integer
has_uploaded_documentation	boolean	Filter by whether the Asset Record has uploaded documentation monitoring enabled. If true, will return all Asset Records which have uploaded documentation monitoring enabled. If false, will return all Asset Records which do not have uploaded documentation monitoring enabled.
calendar_record	boolean	Filter by whether the Asset Record is calendar record. If true, will return all Asset Records which are calendar record. If false, will return all Asset Records which are not calendar record.
rental	boolean	Filter by whether the Asset Record is rental. If true, will return all Asset Records which are rental. If false, will return all Asset Records which are not rental.
mot	boolean	Filter by whether the Asset Record is mot. If true, will return all Asset Records which are mot. If false, will return all Asset Records which are not mot.
inspection	boolean	Filter by whether the Asset Record is inspection. If true, will return all Asset Records which are inspection. If false, will return all Asset Records which are not inspection.
tyre_inspection	boolean	Filter by whether the Asset Record is tyre inspection. If true, will return all Asset Records which are tyre inspection. If false, will return all Asset Records which are not tyre inspection.
adr_inspection	boolean	Filter by whether the Asset Record is adr inspection. If true, will return all Asset Records which are adr inspection. If false, will return all Asset Records which are not adr inspection.
tacho_calibration	boolean	Filter by whether the Asset Record is tacho calibration. If true, will return all Asset Records which are tacho calibration. If false, will return all Asset Records which are not tacho calibration.
loler_inspection	boolean	Filter by whether the Asset Record is loler inspection. If true, will return all Asset Records which are loler inspection. If false, will return all Asset Records which are not loler inspection.
brake_test	boolean	Filter by whether the Asset Record is brake test. If true, will return all Asset Records which are brake test. If false, will return all Asset Records which are not brake test.
weight_test	boolean	Filter by whether the Asset Record is weight test. If true, will return all Asset Records which are weight test. If false, will return all Asset Records which are not weight test.
fridge_service	boolean	Filter by whether the Asset Record is fridge service. If true, will return all Asset Records which are fridge service. If false, will return all Asset Records which are not fridge service.
road_fund_licence	boolean	Filter by whether the Asset Record is road fund licence. If true, will return all Asset Records which are road fund licence. If false, will return all Asset Records which are not road fund licence.
sanitation	boolean	Filter by whether the Asset Record is sanitation. If true, will return all Asset Records which are sanitation. If false, will return all Asset Records which are not sanitation.
tail_lift_inspection	boolean	Filter by whether the Asset Record is tail lift inspection. If true, will return all Asset Records which are tail lift inspection. If false, will return all Asset Records which are not tail lift inspection.
insurance	boolean	Filter by whether the Asset Record is insurance. If true, will return all Asset Records which are insurance. If false, will return all Asset Records which are not insurance.
strop_swap	boolean	Filter by whether the Asset Record is strop swap. If true, will return all Asset Records which are strop swap. If false, will return all Asset Records which are not strop swap.
crane_test	boolean	Filter by whether the Asset Record is crane test. If true, will return all Asset Records which are crane test. If false, will return all Asset Records which are not crane test.
tank_pressure_test	boolean	Filter by whether the Asset Record is tank pressure test. If true, will return all Asset Records which are tank pressure test. If false, will return all Asset Records which are not tank pressure test.
f_gas_certificate	boolean	Filter by whether the Asset Record is f gas certificate. If true, will return all Asset Records which are f gas certificate. If false, will return all Asset Records which are not f gas certificate.
wheel_alignment	boolean	Filter by whether the Asset Record is wheel alignment. If true, will return all Asset Records which are wheel alignment. If false, will return all Asset Records which are not wheel alignment.
winch_inspection	boolean	Filter by whether the Asset Record is winch inspection. If true, will return all Asset Records which are winch inspection. If false, will return all Asset Records which are not winch inspection.
fire_extinguisher_check	boolean	Filter by whether the Asset Record is fire extinguisher check. If true, will return all Asset Records which are fire extinguisher check. If false, will return all Asset Records which are not fire extinguisher check.
laden_brake_test	boolean	Filter by whether the Asset Record is laden brake test. If true, will return all Asset Records which are laden brake test. If false, will return all Asset Records which are not laden brake test.
search	nullable, string	Filter by the Asset Record's search. Will return all Asset Records that have a search that contains the given nullable, string
last_iso_week	boolean	Filter by whether the Asset Record is last iso week. If true, will return all Asset Records which are last iso week. If false, will return all Asset Records which are not last iso week.
has_finance_record	boolean	Filter by whether the Asset Record has finance record monitoring enabled. If true, will return all Asset Records which have finance record monitoring enabled. If false, will return all Asset Records which do not have finance record monitoring enabled.
poi_ids	array. Each item in the array must be exists:Poi.	Filter by the Asset Record's poi id. Will return all Asset Records that have a poi id within the given array.
asset_record_type_ids	array. Each item in the array must be exists:AssetRecordType.	Filter by the Asset Record's asset record type id. Will return all Asset Records that have an asset record type id within the given array.
defect_type_ids	array. Each item in the array must be exists:DefectType.	Filter by the Asset Record's defect type id. Will return all Asset Records that have a defect type id within the given array.
defect_action_ids	array. Each item in the array must be exists:DefectAction.	Filter by the Asset Record's defect action id. Will return all Asset Records that have a defect action id within the given array.
defect_cause_ids	array. Each item in the array must be exists:DefectCause.	Filter by the Asset Record's defect cause id. Will return all Asset Records that have a defect cause id within the given array.
violation_type_ids	array. Each item in the array must be exists:ViolationType.	Filter by the Asset Record's violation type id. Will return all Asset Records that have a violation type id within the given array.
reference_number	string	Filter by the Asset Record's reference number. Will return all Asset Records that have a reference number that contains the given string
reference_numbers	array. Each item in the array must be a string.	Filter by the Asset Record's reference number. Will return all Asset Records that have a reference number within the given array.
company_id	exists:Company	Filter by the Asset Record's company id. Will return all Asset Records with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
company_ids	array. Each item in the array must be exists:Company.	Filter by the Asset Record's company id. Will return all Asset Records that have a company id within the given array.
group_ids	array. Each item in the array must be exists:Group.	Filter by the Asset Record's group id. Will return all Asset Records that have a group id within the given array.
site_id	exists:Site	Filter by the Asset Record's site id. Will return all Asset Records with the given site id. You can see what site ids you have access to (including the associated objects) by calling the site index route.
site_ids	array. Each item in the array must be exists:Site.	Filter by the Asset Record's site id. Will return all Asset Records that have a site id within the given array.
order_by	string	Filter by the Asset Record's order by. Will return all Asset Records that have an order by that contains the given string
order_direction	required with:order_by	Filter by the Asset Record's order direction. Will return all Asset Records that have an order direction that contains the given required with:order_by
group_by	string	Group Asset Record's by the given string.
page	integer:gt:0	Filter by the Asset Record's page. Will return all Asset Records that have a page that contains the given integer:gt:0
query_timeout	nullable, integer, min:1000	Set the timeout value through the given string.
response_delivery_email	boolean	Filter by whether the Asset Record is response delivery email. If true, will return all Asset Records which are response delivery email. If false, will return all Asset Records which are not response delivery email.
response_type	in:csv,csv-data,pdf,json,count	Return the response corresponding to required format as per the given string.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_site_id	boolean	If true, includes the site id of an Asset Record.	site_id
with_site_name	boolean	If true, includes the site name of an Asset Record.	site_name
with_group_name	boolean	If true, includes the group name of an Asset Record.	group_name
with_defect_type_name	boolean	If true, includes the defect type name of an Asset Record.	defect_type_name
with_reference_number	boolean	If true, includes the reference number of an Asset Record.	reference_number
with_original_scheduled_date	boolean	If true, includes the original scheduled date of an Asset Record.	original_scheduled_date
with_scheduled_date	boolean	If true, includes the scheduled date of an Asset Record.	scheduled_date
with_completed_date	boolean	If true, includes the completed date of an Asset Record.	completed_date
with_delivered_date	boolean	If true, includes the delivered date of an Asset Record.	delivered_date
with_missed	boolean	If true, includes the missed of an Asset Record.	missed
with_documentation_completed	boolean	If true, includes the documentation completed of an Asset Record.	documentation_completed
with_signed_off	boolean	If true, includes the signed off of an Asset Record.	signed_off
with_pass_first_time	boolean	If true, includes the pass first time of an Asset Record.	pass_first_time
with_mileage	boolean	If true, includes the mileage of an Asset Record.	mileage
with_driver_name	boolean	If true, includes the driver name of an Asset Record.	driver_name
with_inspector_name	boolean	If true, includes the inspector name of an Asset Record.	inspector_name
with_booked_date	boolean	If true, includes the booked date of an Asset Record.	booked_date
with_workshop_name	boolean	If true, includes the workshop name of an Asset Record.	workshop_name
with_description	boolean	If true, includes the description of an Asset Record.	description
with_comments	boolean	If true, includes the comments of an Asset Record.	comments
with_title	boolean	If true, includes the title of an Asset Record.	title
with_created_at	boolean	If true, includes the created at of an Asset Record.	created_at
with_asset_record_type_id	boolean	If true, includes the asset record type id of an Asset Record.	asset_record_type_id
with_has_attachments	boolean	If true, includes the has attachments field of an Asset Record.	has_attachments
with_attachment_count	boolean	If true, includes the attachment count of an Asset Record.	attachment_count
with_estimated_cost	boolean	If true, includes the estimated cost of an Asset Record.	estimated_cost
with_user	boolean	If true, includes the user of an Asset Record.	user
with_maintenance_overdue_period	boolean	If true, includes the maintenance overdue period of an Asset Record.	maintenance_overdue_period
with_maintenance_status	boolean	If true, includes the maintenance status of an Asset Record.	maintenance_status
with_asset	boolean	If true, includes the asset of an Asset Record.	asset
with_asset_id	boolean	If true, includes the asset id of an Asset Record.	asset_id
with_asset_name	boolean	If true, includes the asset name of an Asset Record.	asset_name
with_asset_note	boolean	If true, includes the asset note of an Asset Record.	asset_note
with_asset_type	boolean	If true, includes the asset type of an Asset Record.	asset_type
with_chassis_number	boolean	If true, includes the chassis number of an Asset Record.	chassis_number
with_asset_business_unit	boolean	If true, includes the asset business unit of an Asset Record.	asset_business_unit
with_asset_company	boolean	If true, includes the asset company of an Asset Record.	asset_company
with_asset_cost_centre	boolean	If true, includes the asset cost centre of an Asset Record.	asset_cost_centre
with_asset_country	boolean	If true, includes the asset country of an Asset Record.	asset_country
with_asset_customer	boolean	If true, includes the asset customer of an Asset Record.	asset_customer
with_asset_group	boolean	If true, includes the asset group of an Asset Record.	asset_group
with_asset_operating_centre	boolean	If true, includes the asset operating centre of an Asset Record.	asset_operating_centre
with_asset_operator_licence	boolean	If true, includes the asset operator licence of an Asset Record.	asset_operator_licence
with_asset_owner	boolean	If true, includes the asset owner of an Asset Record.	asset_owner
with_asset_site	boolean	If true, includes the asset site of an Asset Record.	asset_site
with_asset_icon	boolean	If true, includes the asset icon of an Asset Record.	asset_icon
with_type	boolean	If true, includes the type of an Asset Record.	type
with_schedule	boolean	If true, includes the schedule of an Asset Record.	schedule
with_defect_type	boolean	If true, includes the defect type of an Asset Record.	defect_type
with_defect_action	boolean	If true, includes the defect action of an Asset Record.	defect_action
with_defect_cause	boolean	If true, includes the defect cause of an Asset Record.	defect_cause
with_violation_type	boolean	If true, includes the violation type of an Asset Record.	violation_type
with_vor_statuses	boolean	If true, includes the vor statuses of an Asset Record.	vor_statuses
with_poi	boolean	If true, includes the poi of an Asset Record.	poi
with_files	boolean	If true, includes the files of an Asset Record.	files
with_summarised_estimated_costs	boolean	If true, includes the summarised estimated costs of an Asset Record.	summarised_estimated_costs
with_actual_cost	boolean	If true, includes the actual cost of an Asset Record.	actual_cost

Pagination

KEY	TYPE	DESCRIPTION
per_page	integer:gt:0	Limits the amount of Asset Record's sent back in the request to the given value. Must be greater than 0. Does nothing without ‘current_page’ also being set.

Asset Record Store Request

Request

URL	asset-records/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-records/

Parameters

KEY	TYPE	DESCRIPTION
updateSchedule	boolean	Will store the updateSchedule value of the Asset Record as either true or false depending on the value passed.
updateScheduleByCompletion	boolean	Will store the updateScheduleByCompletion value of the Asset Record as either true or false depending on the value passed.
updateScheduleByCompletionMaintainISODay	boolean	Will store the updateScheduleByCompletionMaintainISODay value of the Asset Record as either true or false depending on the value passed.
updateOnlyScheduleByCompletion	boolean	Will store the updateOnlyScheduleByCompletion value of the Asset Record as either true or false depending on the value passed.
updateOnlyScheduleByCompletionMaintainISODay	boolean	Will store the updateOnlyScheduleByCompletionMaintainISODay value of the Asset Record as either true or false depending on the value passed.
vor_asset_for_damage	boolean	Will store the vor asset for damage value of the Asset Record as either true or false depending on the value passed.
vor_asset_for_wear_and_tear	boolean	Will store the vor asset for wear and tear value of the Asset Record as either true or false depending on the value passed.
asset_id	required, exists:Asset	Will store a permitted value as the asset id of the Asset Record.
asset_record_type_id	required, exists:AssetRecordType	Will store a permitted value as the asset record type id of the Asset Record.
title	nullable, string, max:128	Will store a permitted value as the title of the Asset Record.
description	nullable, string, max:256	Will store a permitted value as the description of the Asset Record.
comments	nullable, string	Will store a permitted value as the comments of the Asset Record.
reference_number	nullable, string, max:64	Will store a permitted value as the reference number of the Asset Record.
driver_name	nullable, string, max:64	Will store a permitted value as the driver name of the Asset Record.
inspector_name	nullable, string, max:64	Will store a permitted value as the inspector name of the Asset Record.
workshop_name	nullable, string, max:255	Will store a permitted value as the workshop name of the Asset Record.
booked_date	nullable, date	Will store a permitted value as the booked date of the Asset Record.
mileage_km	nullable, numeric	Will store a permitted value as the mileage km of the Asset Record.
cost_centre_id	nullable, exists:CostCentre	Will store a permitted value as the cost centre id of the Asset Record.
estimated_cost_currency_id	nullable, exists:Currency	Will store a permitted value as the estimated cost currency id of the Asset Record.
estimated_cost	nullable, numeric	Will store a permitted value as the estimated cost of the Asset Record.
poi_id	nullable, exists:Poi	Will store a permitted value as the poi id of the Asset Record.
asset_schedule_id	nullable, exists:AssetSchedule	Will store a permitted value as the asset schedule id of the Asset Record.
original_scheduled_date	nullable, date	Will store a permitted value as the original scheduled date of the Asset Record.
scheduled_date	nullable, date	Will store a permitted value as the scheduled date of the Asset Record.
delivered_date	nullable, date	Will store a permitted value as the delivered date of the Asset Record.
completed_date	nullable, date	Will store a permitted value as the completed date of the Asset Record.
missed	nullable, boolean	Will store the missed value of the Asset Record as either true or false depending on the value passed.
pass_first_time	nullable, boolean	Will store the pass first time value of the Asset Record as either true or false depending on the value passed.
documentation_completed	nullable, boolean	Will store the documentation completed value of the Asset Record as either true or false depending on the value passed.
signed_off	nullable, boolean	Will store the signed off value of the Asset Record as either true or false depending on the value passed.
operator_signed_off	nullable, boolean	Will store the operator signed off value of the Asset Record as either true or false depending on the value passed.
transaction_user_id	nullable, exists:User	Will store a permitted value as the transaction user id of the Asset Record.
defect_type_id	nullable, exists:DefectType	Will store a permitted value as the defect type id of the Asset Record.
defect_action_id	nullable, exists:DefectAction	Will store a permitted value as the defect action id of the Asset Record.
violation_type_id	nullable, exists:ViolationType	Will store a permitted value as the violation type id of the Asset Record.
defect_cause_id	nullable, exists:DefectCause	Will store a permitted value as the defect cause id of the Asset Record.
driver_id	nullable, integer	Will store a permitted value as the driver id of the Asset Record.
driver_agency_id	nullable, exists:DriverAgency	Will store a permitted value as the driver agency id of the Asset Record.

Asset Record Show Request

Request

URL	asset-records/{assetrecord}
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-records/{assetrecord}
{assetrecord}	Replace with the ID of the required Assetrecord.

Parameters

Filters

KEY	TYPE	DESCRIPTION
response_type	String	Return the response corresponding to required format as per the given string.
pdf_type	String	Filter by the Asset Record's pdf type. Will return all Asset Records that have a pdf type that contains the given String

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_asset	boolean	If true, includes the asset of an Asset Record.	asset
with_asset_business_unit	boolean	If true, includes the asset business unit of an Asset Record.	asset_business_unit
with_asset_company	boolean	If true, includes the asset company of an Asset Record.	asset_company
with_asset_cost_centre	boolean	If true, includes the asset cost centre of an Asset Record.	asset_cost_centre
with_asset_country	boolean	If true, includes the asset country of an Asset Record.	asset_country
with_asset_customer	boolean	If true, includes the asset customer of an Asset Record.	asset_customer
with_asset_group	boolean	If true, includes the asset group of an Asset Record.	asset_group
with_asset_icon	boolean	If true, includes the asset icon of an Asset Record.	asset_icon
with_asset_name	boolean	If true, includes the asset name of an Asset Record.	asset_name
with_asset_operating_centre	boolean	If true, includes the asset operating centre of an Asset Record.	asset_operating_centre
with_asset_operator_licence	boolean	If true, includes the asset operator licence of an Asset Record.	asset_operator_licence
with_asset_owner	boolean	If true, includes the asset owner of an Asset Record.	asset_owner
with_asset_site	boolean	If true, includes the asset site of an Asset Record.	asset_site
with_asset_type	boolean	If true, includes the asset type of an Asset Record.	asset_type
with_chassis_number	boolean	If true, includes the chassis number of an Asset Record.	chassis_number
with_defect_action	boolean	If true, includes the defect action of an Asset Record.	defect_action
with_defect_type	boolean	If true, includes the defect type of an Asset Record.	defect_type
with_files	boolean	If true, includes the files of an Asset Record.	files
with_finance_records	boolean	If true, includes the finance records of an Asset Record.	finance_records
with_poi	boolean	If true, includes the poi of an Asset Record.	poi
with_schedule	boolean	If true, includes the schedule of an Asset Record.	schedule
with_type	boolean	If true, includes the type of an Asset Record.	type
with_violation_type	boolean	If true, includes the violation type of an Asset Record.	violation_type
with_estimated_cost_currency	boolean	If true, includes the estimated cost currency of an Asset Record.	estimated_cost_currency
with_vor_statuses	boolean	If true, includes the vor statuses of an Asset Record.	vor_statuses
with_maintenance_overdue_period	boolean	If true, includes the maintenance overdue period of an Asset Record.	maintenance_overdue_period

Asset Record Update Request

Request

URL	asset-records/{assetrecord}
Method	PUT
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-records/{assetrecord}
{assetrecord}	Replace with the ID of the required Assetrecord.

Parameters

KEY	TYPE	DESCRIPTION
updateSchedule	boolean	Will update the updateSchedule value of the Asset Record as either true or false depending on the value passed.
updateScheduleByCompletion	boolean	Will update the updateScheduleByCompletion value of the Asset Record as either true or false depending on the value passed.
updateScheduleByCompletionMaintainISODay	boolean	Will update the updateScheduleByCompletionMaintainISODay value of the Asset Record as either true or false depending on the value passed.
updateOnlyScheduleByCompletion	boolean	Will update the updateOnlyScheduleByCompletion value of the Asset Record as either true or false depending on the value passed.
updateOnlyScheduleByCompletionMaintainISODay	boolean	Will update the updateOnlyScheduleByCompletionMaintainISODay value of the Asset Record as either true or false depending on the value passed.
vor_asset_for_damage	boolean	Will update the vor asset for damage value of the Asset Record as either true or false depending on the value passed.
vor_asset_for_wear_and_tear	boolean	Will update the vor asset for wear and tear value of the Asset Record as either true or false depending on the value passed.
asset_id	exists:Asset	Will update a permitted value as the asset id of the Asset Record.
asset_record_type_id	required, exists:AssetRecordType	Will update a permitted value as the asset record type id of the Asset Record.
title	nullable, string, max:128	Will update a permitted value as the title of the Asset Record.
description	nullable, string, max:256	Will update a permitted value as the description of the Asset Record.
comments	nullable, string	Will update a permitted value as the comments of the Asset Record.
reference_number	nullable, string, max:64	Will update a permitted value as the reference number of the Asset Record.
driver_name	nullable, string, max:64	Will update a permitted value as the driver name of the Asset Record.
inspector_name	nullable, string, max:64	Will update a permitted value as the inspector name of the Asset Record.
workshop_name	nullable, string, max:255	Will update a permitted value as the workshop name of the Asset Record.
booked_date	nullable, date	Will update a permitted value as the booked date of the Asset Record.
mileage_km	nullable, numeric	Will update a permitted value as the mileage km of the Asset Record.
cost_centre_id	nullable, exists:CostCentre	Will update a permitted value as the cost centre id of the Asset Record.
estimated_cost_currency_id	nullable, exists:Currency	Will update a permitted value as the estimated cost currency id of the Asset Record.
estimated_cost	nullable, numeric	Will update a permitted value as the estimated cost of the Asset Record.
poi_id	nullable, exists:Poi	Will update a permitted value as the poi id of the Asset Record.
asset_schedule_id	nullable, exists:AssetSchedule	Will update a permitted value as the asset schedule id of the Asset Record.
original_scheduled_date	nullable, date	Will update a permitted value as the original scheduled date of the Asset Record.
scheduled_date	nullable, date	Will update a permitted value as the scheduled date of the Asset Record.
delivered_date	nullable, date	Will update a permitted value as the delivered date of the Asset Record.
completed_date	nullable, date	Will update a permitted value as the completed date of the Asset Record.
missed	nullable, boolean	Will update the missed value of the Asset Record as either true or false depending on the value passed.
pass_first_time	nullable, boolean	Will update the pass first time value of the Asset Record as either true or false depending on the value passed.
documentation_completed	nullable, boolean	Will update the documentation completed value of the Asset Record as either true or false depending on the value passed.
signed_off	nullable, boolean	Will update the signed off value of the Asset Record as either true or false depending on the value passed.
operator_signed_off	nullable, boolean	Will update the operator signed off value of the Asset Record as either true or false depending on the value passed.
transaction_user_id	nullable, exists:User	Will update a permitted value as the transaction user id of the Asset Record.
defect_type_id	nullable, exists:DefectType	Will update a permitted value as the defect type id of the Asset Record.
defect_action_id	nullable, exists:DefectAction	Will update a permitted value as the defect action id of the Asset Record.
violation_type_id	nullable, exists:ViolationType	Will update a permitted value as the violation type id of the Asset Record.
defect_cause_id	nullable, exists:DefectCause	Will update a permitted value as the defect cause id of the Asset Record.
driver_id	nullable, integer	Will update a permitted value as the driver id of the Asset Record.
driver_agency_id	nullable, exists:DriverAgency	Will update a permitted value as the driver agency id of the Asset Record.

Asset Record Attachment Type

Asset Record Attachment Type Index Request

Request

URL	asset-record-attachment-types/
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/asset-record-attachment-types/

Asset Record File

Asset Record File Index Request

Request

URL	asset-record-files/
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/asset-record-files/

Asset Record File Store Request

Request

URL	asset-record-files/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-record-files/

Parameters

KEY	TYPE	DESCRIPTION
assetRecordId	required, exists:AssetRecord	Will store a permitted value as the assetRecordId of the Asset Record File.
recordAttachmentTypeId	exists:AssetRecordAttachmentType	Will store a permitted value as the recordAttachmentTypeId of the Asset Record File.
file	required, file, min:0.001, max:20000	Will store a permitted value as the file of the Asset Record File.
filename	required, string	Will store a permitted value as the filename of the Asset Record File.
notes	nullable, string	Will store a permitted value as the notes of the Asset Record File.

Asset Record File Show Request

Request

URL	asset-record-files/{assetrecordfile}
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-record-files/{assetrecordfile}
{assetrecordfile}	Replace with the ID of the required Assetrecordfile.

Parameters

Filters

KEY	TYPE	DESCRIPTION
download_file	boolean	Filter by whether the Asset Record File is download file. If true, will return all Asset Record Files which are download file. If false, will return all Asset Record Files which are not download file.

Asset Record Type

Asset Record Type Index Request

Request

URL	asset-record-types/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-record-types/

Parameters

Filters

KEY	TYPE	DESCRIPTION
asset_record_type_id	integer, exists:AssetRecordType	Filter by the Asset Record Type's ID. Will return all Asset Record Types that have an ID that contains the given integer, exists:AssetRecordType
company_id	integer, exists:Company	Filter by the Asset Record Type's company id. Will return all Asset Record Types with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
name	string	Filter by the Asset Record Type's name. Will return all Asset Record Types that have a name that contains the given string
maintenance	boolean	Filter by whether the Asset Record Type is maintenance. If true, will return all Asset Record Types which are maintenance. If false, will return all Asset Record Types which are not maintenance.
maintenance_without_defect	boolean	Filter by whether the Asset Record Type is maintenance without defect. If true, will return all Asset Record Types which are maintenance without defect. If false, will return all Asset Record Types which are not maintenance without defect.
system	boolean	Filter by whether the Asset Record Type is system. If true, will return all Asset Record Types which are system. If false, will return all Asset Record Types which are not system.
calendar_record_types	boolean	Filter by whether the Asset Record Type is calendar record type. If true, will return all Asset Record Types which are calendar record type. If false, will return all Asset Record Types which are not calendar record type.
default_calendar_record_types	boolean	Filter by whether the Asset Record Type is default calendar record type. If true, will return all Asset Record Types which are default calendar record type. If false, will return all Asset Record Types which are not default calendar record type.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of an Asset Record Type.	company
with_maintenance	boolean	If true, includes the maintenance of an Asset Record Type.	maintenance
with_asset_types	boolean	If true, includes the asset types of an Asset Record Type.	asset_types
with_auto_vor_status	boolean	If true, includes the auto vor status of an Asset Record Type.	auto_vor_status

Asset Schedule

Asset Schedule Index Request

Request

URL	asset-schedules/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-schedules/

Parameters

Filters

KEY	TYPE	DESCRIPTION
asset_schedule_id	exists:AssetSchedule	Filter by the Asset Schedule's ID. Will return all Asset Schedules that have an ID that contains the given exists:AssetSchedule
asset_id	exists:Asset	Filter by the Asset Schedule's asset id. Will return all Asset Schedules with the given asset id. You can see what asset ids you have access to (including the associated objects) by calling the asset index route.
asset_ids	array. Each item in the array must be exists:Asset.	Filter by the Asset Schedule's asset id. Will return all Asset Schedules that have an asset id within the given array.
asset_schedule_type_ids	array. Each item in the array must be exists:AssetScheduleType.	Filter by the Asset Schedule's asset schedule type id. Will return all Asset Schedules that have an asset schedule type id within the given array.
enabled	boolean, nullable	Filter by whether the Asset Schedule is enabled. If true, will return all Asset Schedules which are enabled. If false, will return all Asset Schedules which are not enabled.
limit	integer	Filter by the Asset Schedule's limit. Will return all Asset Schedules that have a limit that contains the given integer
schedules_initial_dated_after	nullable, date	Filter by the Asset Schedule's schedules initial dated after. Will return all Asset Schedules that have a schedules initial dated after that contains the given nullable, date
schedules_initial_dated_before	nullable, date	Filter by the Asset Schedule's schedules initial dated before. Will return all Asset Schedules that have a schedules initial dated before that contains the given nullable, date
schedules_next_dated_after	nullable, date	Filter by the Asset Schedule's schedules next dated after. Will return all Asset Schedules that have a schedules next dated after that contains the given nullable, date
schedules_next_dated_before	nullable, date	Filter by the Asset Schedule's schedules next dated before. Will return all Asset Schedules that have a schedules next dated before that contains the given nullable, date
default_maintenance_provider_ids	array. Each item in the array must be exists:MaintenanceProvider.	Filter by the Asset Schedule's default maintenance provider id. Will return all Asset Schedules that have a default maintenance provider id within the given array.
query_timeout	nullable, integer, min:1000	Set the timeout value through the given string.
response_delivery_email	boolean	Filter by whether the Asset Schedule is response delivery email. If true, will return all Asset Schedules which are response delivery email. If false, will return all Asset Schedules which are not response delivery email.
response_type	in:csv,csv-data,json	Return the response corresponding to required format as per the given string.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_asset	boolean	If true, includes the asset of an Asset Schedule.	asset
with_asset_schedule_type	boolean	If true, includes the asset schedule type of an Asset Schedule.	asset_schedule_type
with_asset_id	boolean	If true, includes the asset id of an Asset Schedule.	asset_id
with_asset_name	boolean	If true, includes the asset name of an Asset Schedule.	asset_name
with_asset_note	boolean	If true, includes the asset note of an Asset Schedule.	asset_note
with_asset_schedule_type_id	boolean	If true, includes the asset schedule type id of an Asset Schedule.	asset_schedule_type_id
with_asset_type	boolean	If true, includes the asset type of an Asset Schedule.	asset_type
with_auto_vor_clear_on_zero_substatus	boolean	If true, includes the auto vor clear on zero substatus of an Asset Schedule.	auto_vor_clear_on_zero_substatus
with_auto_vor_offset_days	boolean	If true, includes the auto vor offset days of an Asset Schedule.	auto_vor_offset_days
with_auto_vor_sub_status	boolean	If true, includes the auto vor sub status of an Asset Schedule.	auto_vor_sub_status
with_created_at	boolean	If true, includes the created at of an Asset Schedule.	created_at
with_enabled	boolean	If true, includes the enabled of an Asset Schedule.	enabled
with_frequency_days	boolean	If true, includes the frequency days of an Asset Schedule.	frequency_days
with_frequency_months	boolean	If true, includes the frequency months of an Asset Schedule.	frequency_months
with_frequency_years	boolean	If true, includes the frequency years of an Asset Schedule.	frequency_years
with_initial_date	boolean	If true, includes the initial date of an Asset Schedule.	initial_date
with_next_date	boolean	If true, includes the next date of an Asset Schedule.	next_date
with_warning_days	boolean	If true, includes the warning days of an Asset Schedule.	warning_days
with_window_days	boolean	If true, includes the window days of an Asset Schedule.	window_days
with_default_maintenance_provider	boolean	If true, includes the default maintenance provider of an Asset Schedule.	default_maintenance_provider
with_next_available_date	boolean	If true, includes the next available date of an Asset Schedule.	next_available_date
with_next_inspection_date	boolean	If true, includes the next inspection date of an Asset Schedule.	next_inspection_date
with_next_comment	boolean	If true, includes the next comment of an Asset Schedule.	next_comment
with_next_scheduled_date	boolean	If true, includes the next scheduled date of an Asset Schedule.	next_scheduled_date
with_next_booked_date	boolean	If true, includes the next booked date of an Asset Schedule.	next_booked_date
with_notes	boolean	If true, includes the notes of an Asset Schedule.	notes
with_previous_available_date	boolean	If true, includes the previous available date of an Asset Schedule.	previous_available_date
with_previous_inspection_date	boolean	If true, includes the previous inspection date of an Asset Schedule.	previous_inspection_date
with_previous_comment	boolean	If true, includes the previous comment of an Asset Schedule.	previous_comment
with_previous_scheduled_date	boolean	If true, includes the previous scheduled date of an Asset Schedule.	previous_scheduled_date
with_previous_booked_date	boolean	If true, includes the previous booked date of an Asset Schedule.	previous_booked_date

Asset Schedule Create Request

Request

URL	asset-schedules/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/asset-schedules/create

Asset Schedule Store Request

Request

URL	asset-schedules/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-schedules/

Parameters

KEY	TYPE	DESCRIPTION
asset_id	required, integer, exists:Asset	Will store a permitted value as the asset id of the Asset Schedule.
asset_schedule_type_id	required, integer, exists:AssetScheduleType	Will store a permitted value as the asset schedule type id of the Asset Schedule.
default_maintenance_provider_id	nullable, integer, exists:MaintenanceProvider	Will store a permitted value as the default maintenance provider id of the Asset Schedule.
initial_date	required, date, after:2021-07-17, before:2029-07-17	Will store a permitted value as the initial date of the Asset Schedule.
next_date	nullable, date	Will store a permitted value as the next date of the Asset Schedule.
frequency_days	required, integer, ScheduleFrequencyPeriod	Will store a permitted value as the frequency days of the Asset Schedule.
frequency_months	required, integer	Will store a permitted value as the frequency months of the Asset Schedule.
frequency_years	required, integer	Will store a permitted value as the frequency years of the Asset Schedule.
warning_days	required, integer	Will store a permitted value as the warning days of the Asset Schedule.
window_days	required, integer	Will store a permitted value as the window days of the Asset Schedule.
auto_vor_offset_days	nullable, integer	Will store a permitted value as the auto vor offset days of the Asset Schedule.
preparation_days	nullable, integer	Will store a permitted value as the preparation days of the Asset Schedule.
auto_vor_sub_status	required, integer	Will store a permitted value as the auto vor sub status of the Asset Schedule.
auto_vor_clear_on_zero_substatus	nullable, boolean	Will store the auto vor clear on zero substatus value of the Asset Schedule as either true or false depending on the value passed.
enabled	nullable, boolean	Will store the enabled value of the Asset Schedule as either true or false depending on the value passed.
notes	nullable, string	Will store a permitted value as the notes of the Asset Schedule.

Asset Schedule Update Request

Request

URL	asset-schedules/{assetschedule}
Method	PUT
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-schedules/{assetschedule}
{assetschedule}	Replace with the ID of the required Assetschedule.

Parameters

KEY	TYPE	DESCRIPTION
asset_id	required, integer, exists:Asset	Will update a permitted value as the asset id of the Asset Schedule.
asset_schedule_type_id	required, integer, exists:AssetScheduleType	Will update a permitted value as the asset schedule type id of the Asset Schedule.
default_maintenance_provider_id	nullable, integer, exists:MaintenanceProvider	Will update a permitted value as the default maintenance provider id of the Asset Schedule.
initial_date	required, date	Will update a permitted value as the initial date of the Asset Schedule.
next_date	nullable, date	Will update a permitted value as the next date of the Asset Schedule.
frequency_days	required, integer, ScheduleFrequencyPeriod	Will update a permitted value as the frequency days of the Asset Schedule.
frequency_months	required, integer	Will update a permitted value as the frequency months of the Asset Schedule.
frequency_years	required, integer	Will update a permitted value as the frequency years of the Asset Schedule.
warning_days	required, integer	Will update a permitted value as the warning days of the Asset Schedule.
window_days	required, integer	Will update a permitted value as the window days of the Asset Schedule.
auto_vor_offset_days	nullable, integer	Will update a permitted value as the auto vor offset days of the Asset Schedule.
preparation_days	nullable, integer	Will update a permitted value as the preparation days of the Asset Schedule.
auto_vor_sub_status	required, integer	Will update a permitted value as the auto vor sub status of the Asset Schedule.
auto_vor_clear_on_zero_substatus	nullable, boolean	Will update the auto vor clear on zero substatus value of the Asset Schedule as either true or false depending on the value passed.
enabled	nullable, boolean	Will update the enabled value of the Asset Schedule as either true or false depending on the value passed.
notes	nullable, string	Will update a permitted value as the notes of the Asset Schedule.

Asset Schedule Type

Asset Schedule Type Index Request

Request

URL	asset-schedule-types/
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/asset-schedule-types/

Asset Type

Asset types are a list of types that a vehicle can be categorized as. They are mainly used throughout the system as another method of sorting/ grouping assets. There are a pre-defined list of types which all users are given access to (default types), however a company may have its own specific types to meet its needs.

Asset Type Index Request

Request

URL	new/asset-types/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/new/asset-types/

Parameters

Filters

KEY	TYPE	DESCRIPTION
asset_type_id	integer, exists:AssetType	Filter by the Asset Type's ID. Will return all Asset Types that have an ID that contains the given integer, exists:AssetType
name	string	Filter by the Asset Type's name. Will return all Asset Types that have a name that contains the given string
company_id	integer, exists:Company	Filter by the Asset Type's company id. Will return all Asset Types with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
generic_type	in:TRAILER,VAN,CAR,CONTAINER,MOTORCYCLE,TRACTOR_UNIT,RIGID,EQUIPMENT	Filter by the Asset Type's generic type. Will return all Asset Types that have a generic type that contains the given in:TRAILER,VAN,CAR,CONTAINER,MOTORCYCLE,TRACTOR_UNIT,RIGID,EQUIPMENT
default	boolean	Filter by whether the Asset Type is default. If true, will return all Asset Types which are default. If false, will return all Asset Types which are not default.
rental_option	boolean	Filter by whether the Asset Type has rentals as an option. If true, will return all Asset Types which have a rental option. If false, will return all Asset Types which do not have a rental option.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of an Asset Type.	company
with_generic_type	boolean	If true, includes the generic type of an Asset Type.	generic_type
with_sub_types	boolean	If true, includes the sub types of an Asset Type.	sub_types

Axle Manufacturer

Axle Manufacturer Index Request

Request

URL	axle-manufacturers/
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/axle-manufacturers/

Business Unit

Business Unit Index Request

Request

URL	business-units/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/business-units/

Parameters

Filters

KEY	TYPE	DESCRIPTION
business_unit_id	integer, exists:BusinessUnit	Filter by the Business Unit's ID. Will return all Business Units that have an ID that contains the given integer, exists:BusinessUnit
company_id	integer, exists:Company	Filter by the Business Unit's company id. Will return all Business Units with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
name	string	Filter by the Business Unit's name. Will return all Business Units that have a name that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of a Business Unit.	company

Business Unit Create Request

Request

URL	business-units/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/business-units/create

Business Unit Store Request

Request

URL	business-units/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/business-units/

Parameters

KEY	TYPE	DESCRIPTION
name	required, string	Will store a permitted value as the name of the Business Unit.
company_id	required, integer, exists:Company	Will store a permitted value as the company id of the Business Unit.
hidden	required, boolean	Will store the Business Unit as hidden if the value is set to true.

Business Unit Show Request

Request

URL	business-units/{businessunit}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/business-units/{businessunit}
{businessunit}	Replace with the ID of the required Businessunit.

Business Unit Edit Request

Request

URL	business-units/{businessunit}/edit
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/business-units/{businessunit}/edit
{businessunit}	Replace with the ID of the required Businessunit.

Business Unit Update Request

Request

URL	business-units/{businessunit}
Method	PUT
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/business-units/{businessunit}
{businessunit}	Replace with the ID of the required Businessunit.

Company

Companies represent the business’ that Axscend serves. They are mainly used throughout the system as another method of sorting/ grouping other objects such as assets and groups. Most users will only be associated with a single company.

Company Index Request

Request

URL	companies/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/companies/

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	integer, exists:Company	Filter by the Company's ID. Will return all Companies that have an Id that contains the given integer.
feature_id	integer, exists:Feature	Filter by the Company's feature id. Will return all Companies with the given feature id. You can see what feature ids you have access to (including the associated objects) by calling the feature index route.
has_assets	boolean	Filter by whether the Company has asset monitoring enabled. If true, will return all Companies which have asset monitoring enabled. If false, will return all Companies which do not have asset monitoring enabled.
has_users	boolean	Filter by whether the Company has user monitoring enabled. If true, will return all Companies which have user monitoring enabled. If false, will return all Companies which do not have user monitoring enabled.
name	string	Filter by the Company's name. Will return all Companies that have a name that contains the given string
status	string	Filter by the Company's status. Will return all Companies that have a status that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_app_settings	boolean	If true, includes the app settings of a Company.	app_settings
with_asset_builds	boolean	If true, includes the asset builds of a Company.	asset_builds
with_asset_tags	boolean	If true, includes the asset tags of a Company.	asset_tags
with_assets	boolean	If true, includes the assets of a Company.	assets
with_branding	boolean	If true, includes the branding of a Company.	branding
with_business_units	boolean	If true, includes the business units of a Company.	business_units
with_company_lighting_looms	boolean	If true, includes the company lighting looms of a Company.	company_lighting_looms
with_contracts	boolean	If true, includes the contracts of a Company.	contracts
with_country	boolean	If true, includes the country of a Company.	country
with_customers	boolean	If true, includes the customers of a Company.	customers
with_earned_recognition	boolean	If true, includes the earned recognition of a Company.	earned_recognition
with_er_alerts	boolean	If true, includes the er alerts of a Company.	er_alerts
with_features	boolean	If true, includes the features of a Company.	features
with_finance_approval_requires_attachments	boolean	If true, includes the finance approval requires attachments of a Company.	finance_approval_requires_attachments
with_fleet_grid_views	boolean	If true, includes the fleet grid views of a Company.	fleet_grid_views
with_fuel_card_email	boolean	If true, includes the fuel card email of a Company.	fuel_card_email
with_fuel_cards	boolean	If true, includes the fuel cards of a Company.	fuel_cards
with_installation_companies	boolean	If true, includes the installation companies of a Company.	installation_companies
with_inter_company_transfer_mappings	boolean	If true, includes the inter company transfer mappings of a Company.	inter_company_transfer_mappings
with_invoice_types	boolean	If true, includes the invoice types of a Company.	invoice_types
with_liveries	boolean	If true, includes the liveries of a Company.	liveries
with_mandatory_asset_fields	boolean	If true, includes the mandatory asset fields of a Company.	mandatory_asset_fields
with_manufacturers	boolean	If true, includes the manufacturers of a Company.	manufacturers
with_rigid_body_manufacturers	boolean	If true, includes the rigid body manufacturers of a Company.	rigid_body_manufacturers
with_mileage_pools	boolean	If true, includes the mileage pools of a Company.	mileage_pools
with_operator_code	boolean	If true, includes the operator code of a Company.	operator_code
with_operator_licences	boolean	If true, includes the operator licences of a Company.	operator_licences
with_owners	boolean	If true, includes the owners of a Company.	owners
with_period_settings	boolean	If true, includes the period settings of a Company.	period_settings
with_pois	boolean	If true, includes the POIs of a Company.	pois
with_primary_users	boolean	If true, includes the primary users of a Company.	primary_users
with_questionnaires	boolean	If true, includes the questionnaires of a Company.	questionnaires
with_rental_customers	boolean	If true, includes the rental customers of a Company.	rental_customers
with_rental_providers	boolean	If true, includes the rental providers of a Company.	rental_providers
with_roles	boolean	If true, includes the roles of a Company.	roles
with_searches	boolean	If true, includes the searches of a Company.	searches
with_settings	boolean	If true, includes the settings of a Company.	settings
with_sso_provider	boolean	If true, includes the sso provider of a Company.	sso_provider
with_status	boolean	If true, includes the status of a Company.	status
with_tyre_types	boolean	If true, includes the tyre types of a Company.	tyre_types
with_yard_locations	boolean	If true, includes the yard locations of a Company.	yard_locations
with_unhired_rental_group	boolean	If true, includes the unhired rental group of a Company.	unhired_rental_group
with_default_ebpms_max_age_days	boolean	If true, includes the default ebpms max age days of a Company.	default_ebpms_max_age_days

Company Show Request

Request

URL	companies/{company}
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/companies/{company}
{company}	Replace with the ID of the required Company.

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	integer, exists:Company	Filter by the Company's ID. Will return all Companies that have an Id that contains the given integer.
name	string	Filter by the Company's name. Will return all Companies that have a name that contains the given string
status	string	Filter by the Company's status. Will return all Companies that have a status that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_asset_builds	boolean	If true, includes the asset builds of a Company.	asset_builds
with_asset_tags	boolean	If true, includes the asset tags of a Company.	asset_tags
with_assets	boolean	If true, includes the assets of a Company.	assets
with_business_units	boolean	If true, includes the business units of a Company.	business_units
with_company_lighting_looms	boolean	If true, includes the company lighting looms of a Company.	company_lighting_looms
with_contracts	boolean	If true, includes the contracts of a Company.	contracts
with_country	boolean	If true, includes the country of a Company.	country
with_customers	boolean	If true, includes the customers of a Company.	customers
with_er_alerts	boolean	If true, includes the er alerts of a Company.	er_alerts
with_features	boolean	If true, includes the features of a Company.	features
with_finance_approval_requires_attachments	boolean	If true, includes the finance approval requires attachments of a Company.	finance_approval_requires_attachments
with_fleet_grid_views	boolean	If true, includes the fleet grid views of a Company.	fleet_grid_views
with_fuel_cards	boolean	If true, includes the fuel cards of a Company.	fuel_cards
with_installation_companies	boolean	If true, includes the installation companies of a Company.	installation_companies
with_inter_company_transfer_mappings	boolean	If true, includes the inter company transfer mappings of a Company.	inter_company_transfer_mappings
with_invoice_types	boolean	If true, includes the invoice types of a Company.	invoice_types
with_liveries	boolean	If true, includes the liveries of a Company.	liveries
with_mandatory_asset_fields	boolean	If true, includes the mandatory asset fields of a Company.	mandatory_asset_fields
with_manufacturers	boolean	If true, includes the manufacturers of a Company.	manufacturers
with_rigid_body_manufacturers	boolean	If true, includes the rigid body manufacturers of a Company.	rigid_body_manufacturers
with_mileage_pools	boolean	If true, includes the mileage pools of a Company.	mileage_pools
with_netsuite	boolean	If true, includes the netsuite settings of a Company	netsuite
with_operator_licences	boolean	If true, includes the operator licences of a Company.	operator_licences
with_owners	boolean	If true, includes the owners of a Company.	owners
with_pois	boolean	If true, includes the POIs of a Company.	pois
with_primary_users	boolean	If true, includes the primary users of a Company.	primary_users
with_questionnaires	boolean	If true, includes the questionnaires of a Company.	questionnaires
with_rental_customers	boolean	If true, includes the rental customers of a Company.	rental_customers
with_rental_provider_asset_types	boolean	If true, includes the rental provider asset types of a Company.	rental_provider_asset_types
with_rental_providers	boolean	If true, includes the rental providers of a Company.	rental_providers
with_roles	boolean	If true, includes the roles of a Company.	roles
with_searches	boolean	If true, includes the searches of a Company.	searches
with_sso_provider	boolean	If true, includes the sso provider of a Company.	sso_provider
with_tyre_types	boolean	If true, includes the tyre types of a Company.	tyre_types
with_yard_locations	boolean	If true, includes the yard locations of a Company.	yard_locations

Cost Centre

Cost Centre Index Request

Request

URL	cost-centres/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/cost-centres/

Parameters

Filters

KEY	TYPE	DESCRIPTION
hidden	boolean	Filter by whether the Cost Centre is hidden. If true, will return all Cost Centres which are hidden. If false, will return all Cost Centres which are not hidden.
code	string	Filter by the Cost Centre's code. Will return all Cost Centres that have a code that contains the given string
company_id	integer, exists:Company	Filter by the Cost Centre's company id. Will return all Cost Centres with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
cost_centre_id	integer, exists:CostCentre	Filter by the Cost Centre's ID. Will return all Cost Centres that have an ID that contains the given integer, exists:CostCentre
name	string	Filter by the Cost Centre's name. Will return all Cost Centres that have a name that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_hidden	boolean	If true, shows whether a Cost Centre is hidden.	hidden
with_company	boolean	If true, includes the company of a Cost Centre.	company

Cost Centre Create Request

Request

URL	cost-centres/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/cost-centres/create

Cost Centre Store Request

Request

URL	cost-centres/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/cost-centres/

Parameters

KEY	TYPE	DESCRIPTION
name	required, string	Will store a permitted value as the name of the Cost Centre.
company_id	required, integer, exists:Company	Will store a permitted value as the company id of the Cost Centre.
code	nullable, string	Will store a permitted value as the code of the Cost Centre.
hidden	boolean	Will store the Cost Centre as hidden if the value is set to true.

Cost Centre Show Request

Request

URL	cost-centres/{costcentre}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/cost-centres/{costcentre}
{costcentre}	Replace with the ID of the required Costcentre.

Cost Centre Edit Request

Request

URL	cost-centres/{costcentre}/edit
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/cost-centres/{costcentre}/edit
{costcentre}	Replace with the ID of the required Costcentre.

Cost Centre Update Request

Request

URL	cost-centres/{costcentre}
Method	PUT
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/cost-centres/{costcentre}
{costcentre}	Replace with the ID of the required Costcentre.

Country

Country Index Request

Request

URL	countries/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/countries/

Parameters

Filters

KEY	TYPE	DESCRIPTION
country_id	integer, exists:Country	Filter by the Country's ID. Will return all Countries that have an ID that contains the given integer, exists:Country
iso_code	string	Filter by the Country's ISO Code. Will return all Countries that have an ISO Code that contains the given string
name	string	Filter by the Country's name. Will return all Countries that have a name that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_currency	boolean	If true, includes the currency of a Country.	currency

Country Show Request

Request

URL	countries/{country}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/countries/{country}
{country}	Replace with the ID of the required Country.

Customer

Customer Index Request

Request

URL	customers/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/customers/

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	integer, exists:Company	Filter by the Customer's company id. Will return all Customers with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
customer_id	integer, exists:Customer	Filter by the Customer's ID. Will return all Customers that have an ID that contains the given integer, exists:Customer
name	string	Filter by the Customer's name. Will return all Customers that have a name that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of a Customer.	company

Customer Create Request

Request

URL	customers/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/customers/create

Customer Store Request

Request

URL	customers/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/customers/

Parameters

KEY	TYPE	DESCRIPTION
name	required, string	Will store a permitted value as the name of the Customer.
hidden	required, boolean	Will store the Customer as hidden if the value is set to true.
company_id	required, integer, exists:Company	Will store a permitted value as the company id of the Customer.

Customer Show Request

Request

URL	customers/{customer}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/customers/{customer}
{customer}	Replace with the ID of the required Customer.

Customer Edit Request

Request

URL	customers/{customer}/edit
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/customers/{customer}/edit
{customer}	Replace with the ID of the required Customer.

Customer Update Request

Request

URL	customers/{customer}
Method	PUT
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/customers/{customer}
{customer}	Replace with the ID of the required Customer.

Defect

An asset can have defects logged against them during driver checks, or 'walkarounds'. These Defect records store information about the issue, as well as any questions, actions to be taken or resolutions.

Defect Index Request

Request

URL	defects/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/defects/

Parameters

Filters

KEY	TYPE	DESCRIPTION
asset_group_id	exists:Group	Filter by the Defect's asset group id. Will return all Defects with the given asset group id. You can see what asset group ids you have access to (including the associated objects) by calling the asset group index route.
asset_id	exists:Asset	Filter by the Defect's asset id. Will return all Defects with the given asset id. You can see what asset ids you have access to (including the associated objects) by calling the asset index route.
asset_record_id	exists:AssetRecord	Filter by the Defect's asset record id. Will return all Defects with the given asset record id. You can see what asset record ids you have access to (including the associated objects) by calling the asset record index route.
company_ids	array. Each item in the array must be integer, exists:Company.	Filter by the Defect's company id. Will return all Defects that have a company id within the given array.
site_ids	array. Each item in the array must be integer, exists:Site.	Filter by the Defect's site id. Will return all Defects that have a site id within the given array.
defect_ids	array. Each item in the array must be an integer.	Filter by the Defect's ID. Will return all Defects that have an ID within the given array.
defect_resolution_id	exists:DefectResolution	Filter by the Defect's resolution ID. Will return all Defects with the given resolution ID.
driver_id	exists:Driver	Filter by the Defect's driver id. Will return all Defects with the given driver id.
has_incomplete_maintenance	boolean	Filter by whether the Defect has incomplete maintenance. If true, will return all Defects which have incomplete maintenance. If false, will return all Defects which do not have incomplete maintenance.
is_resolved	boolean	Filter by whether the Defect is resolved. If true, will return all Defects which are resolved. If false, will return all Defects which are not resolved.
reported_after	date	Filter by the Defect's reported at date. Will return all Defects that have a reported at date after the given date.
reported_before	date	Filter by the Defect's reported at date. Will return all Defects that have a reported at date before the given date.
resolution_id	exists:DefectResolution	Filter by the Defect's resolution ID. Will return all Defects with the given resolution ID.
search	nullable, string	Acts as a wildcard parameter. Filter defects which contain, or are associated with the given string.
order_by	string	Order results by the selected parameter.
order_direction	string, required with:order_by	Order results in the selected direction.
simple_paginate	boolean	Filter by whether the Defect is simple paginate. If true, will return all Defects which are simple paginate. If false, will return all Defects which are not simple paginate.
page	integer	Offsets the Defect sent back in the request by the current page multiplied by the amount of Defects per page. Indexed from 0. Must be equal to or greater than 0. Does nothing without 'per_page' also being set.
response_type	in:csv	Return the response corresponding to required format as per the given string.
group_by	in:group_name,type,reported_at_date,status	Group Defect's by the given string.
company_id	exists:Company	Filter by the Defect's company id. Will return all Defects with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_resolution	boolean	If true, includes the resolution of a Defect.	resolution
with_resolving_user	boolean	If true, includes the resolving user of a Defect.	resolving_user
with_closed_defect_count	boolean	If true, includes the closed defect count of a Defect.	closed_defect_count
with_open_defect_count	boolean	If true, includes the open defect count of a Defect.	open_defect_count
with_defect_count	boolean	If true, includes the defect count of a Defect.	defect_count

Pagination

KEY	TYPE	DESCRIPTION
per_page	integer	Limits the amount of Defect's sent back in the request to the given value. Must be greater than 0. Does nothing without 'page' also being set.

Defect Create Request

Request

URL	defects/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/defects/create

Defect Store Request

Request

URL	defects/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/defects/

Parameters

KEY	TYPE	DESCRIPTION
driver_name	string, nullable	Will store a permitted value as the driver name of the Defect.
asset_id	required, exists:Asset	Will store a permitted value as the asset id of the Defect.
action_id	nullable, integer, exists:DefectAction	Will store a permitted value as the action id of the Defect.
type_id	required, exists:DefectType	Will store a permitted value as the type id of the Defect.
description	nullable, string	Will store a permitted value as the An asset can have defects logged against them during driver checks, or 'walkarounds'. These Defect records store information about the issue, as well as any questions, actions to be taken or resolutions. of the Defect.
reference_number	nullable, string	Will store a permitted value as the reference number of the Defect.
odo_km	nullable, integer	Will store a permitted value as the odo km of the Defect.
images	nullable, array	Will store a permitted value as the images of the Defect.
guid	string	Will store a permitted value as the guid of the Defect.
reported_at	required	Will store a permitted value as the reported at of the Defect.

Defect Show Request

Request

URL	defects/{defect}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/defects/{defect}
{defect}	Replace with the ID of the required Defect.

Defect Edit Request

Request

URL	defects/{defect}/edit
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/defects/{defect}/edit
{defect}	Replace with the ID of the required Defect.

Defect Update Request

Request

URL	defects/{defect}
Method	PUT
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/defects/{defect}
{defect}	Replace with the ID of the required Defect.

Parameters

KEY	TYPE	DESCRIPTION
validated	boolean	Will update the validated value of the Defect as either true or false depending on the value passed.
asset_record_id	exists:AssetRecord	Will update a permitted value as the asset record id of the Defect.
defect_action_id	nullable, exists:DefectAction	Will update a permitted value as the defect action id of the Defect.
vor_asset	boolean	Will update the vor asset value of the Defect as either true or false depending on the value passed.
vor_asset_for_damage	boolean	Will update the vor asset for damage value of the Defect as either true or false depending on the value passed.
vor_asset_for_wear_and_tear	boolean	Will update the vor asset for wear and tear value of the Defect as either true or false depending on the value passed.
mark_completed	boolean	Will update the mark completed value of the Defect as either true or false depending on the value passed.
archive	boolean	Will update the archive value of the Defect as either true or false depending on the value passed.
unarchive	boolean	Will update the unarchive value of the Defect as either true or false depending on the value passed.
reference_number	string	Will update a permitted value as the reference number of the Defect.
archived_reason	nullable, string	Will update a permitted value as the archived reason of the Defect.
poi_id	nullable, exists:Poi	Will update a permitted value as the poi id of the Defect.

Emission Standard

Asset Emission Standard Index Request

Request

URL	asset-emission-standards/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-emission-standards/

Parameters

KEY	TYPE	DESCRIPTION
asset_emission_standard_id	integer, exists:AssetEmissionStandard	Will store a permitted value as the ID of the Emission Standard.
name	string	Will store a permitted value as the name of the Emission Standard.

Asset Emission Standard Show Request

Request

URL	asset-emission-standards/
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/asset-emission-standards/

Finance Type

Asset Finance Type Index Request

Request

URL	asset-finance-types/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-finance-types/

Parameters

Filters

KEY	TYPE	DESCRIPTION
asset_finance_type_id	integer, exists:AssetFinanceType	Filter by the Finance Type's ID. Will return all Finance Types with the given ID.
name	string	Filter by the Finance Type's name. Will return all Finance Types that have a name that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of a Finance Type.	company

Asset Finance Type Show Request

Request

URL	asset-finance-types/
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/asset-finance-types/

Fuel Card Provider

Fuel Card Provider Index Request

Request

URL	fuel-card-providers/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/fuel-card-providers/

Parameters

Filters

KEY	TYPE	DESCRIPTION
fuel_card_provider_id	integer, exists:FuelCardProvider	Filter by the Fuel Card Provider's ID. Will return all Fuel Card Providers that have an ID that contains the given integer, exists:FuelCardProvider
name	string	Filter by the Fuel Card Provider's name. Will return all Fuel Card Providers that have a name that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_fuel_cards	boolean	If true, includes the fuel cards of a Fuel Card Provider.	fuel_cards
with_logo	boolean	If true, includes the logo of a Fuel Card Provider.	logo

Fuel Card Provider Show Request

Request

URL	fuel-card-providers/{fuelcardprovider}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/fuel-card-providers/{fuelcardprovider}
{fuelcardprovider}	Replace with the ID of the required Fuelcardprovider.

Fuel Type

Fuel Type Index Request

Request

URL	fuel-types/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/fuel-types/

Parameters

Filters

KEY	TYPE	DESCRIPTION
fuel_type_id	integer, exists:FuelType	Filter by the Fuel Type's ID. Will return all Fuel Types that have an ID that contains the given integer, exists:FuelType
name	string	Filter by the Fuel Type's name. Will return all Fuel Types that have a name that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_assets	boolean	If true, includes the assets of a Fuel Type.	assets

Fuel Type Show Request

Request

URL	fuel-types/{fueltype}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/fuel-types/{fueltype}
{fueltype}	Replace with the ID of the required Fueltype.

Group

Groups are user-definable collections of assets, which allow for fast sorting and filtering of assets. What the group represents is definable by each business, however it is common for groups to represent individual operations within a business. Groups sit in a ‘tree’ hierarchy, with each business being automatically assigned a ‘root’ group representing the entire business’ fleet. Any user that has access to a group will get access to all assets in that group, as well as all assets in that group’s ‘child’ groups. This is nested, so it also grants access to ‘grand-child’ groups, etc.

Group Index Request

Request

URL	groups/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/groups/

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	exists:Company	Filter by the Group's company id. Will return all Groups with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
name	string	Filter by the Group's name. Will return all Groups that have a name that contains the given string
group_id	exists:Group	Filter by the Group's ID. Will return all Groups that have an ID that contains the given exists:Group
is_root	boolean	Filter by whether the Group is is root. If true, will return all Groups which are is root. If false, will return all Groups which are not is root.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_children	boolean	If true, includes the children of a Group.	children
with_company	boolean	If true, includes the company of a Group.	company
with_parent	boolean	If true, includes the parent of a Group.	parent
with_root_status	boolean	If true, includes the root status of a Group.	root_status
with_site	boolean	If true, includes the site of a Group.	site
with_site_details	boolean	If true, includes the site details of a Group.	site_details

Group Create Request

Request

URL	groups/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/groups/create

Group Store Request

Request

URL	groups/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/groups/

Parameters

KEY	TYPE	DESCRIPTION
name	required, String	Will store a permitted value as the name of the Group.
company_id	required, integer, exists:Company	Will store a permitted value as the company id of the Group.
manager_id	nullable, integer, exists:User	Will store a permitted value as the manager id of the Group.
site_id	nullable, integer, exists:Site	Will store a permitted value as the site id of the Group.
parent_id	required, integer, exists:Group	Will store a permitted value as the parent id of the Group.

Group Show Request

Request

URL	groups/{group}
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/groups/{group}
{group}	Replace with the ID of the required Group.

Parameters

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_children	boolean	If true, includes the children of a Group.	children
with_company	boolean	If true, includes the company of a Group.	company
with_root_status	boolean	If true, includes the root status of a Group.	root_status
with_site	boolean	If true, includes the site of a Group.	site
with_site_details	boolean	If true, includes the site details of a Group.	site_details
with_parent	boolean	If true, includes the parent of a Group.	parent

Group Edit Request

Request

URL	groups/{group}/edit
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/groups/{group}/edit
{group}	Replace with the ID of the required Group.

Group Update Request

Request

URL	groups/{group}
Method	PUT
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/groups/{group}
{group}	Replace with the ID of the required Group.

Parameters

KEY	TYPE	DESCRIPTION
name	required, String	Will update a permitted value as the name of the Group.
company_id	required, integer, exists:Company	Will update a permitted value as the company id of the Group.
manager_id	nullable, integer, exists:User	Will update a permitted value as the manager id of the Group.
site_id	nullable, integer, exists:Site	Will update a permitted value as the site id of the Group.

Insurance Category

Insurance Category Index Request

Request

URL	insurance-categories/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/insurance-categories/

Parameters

Filters

KEY	TYPE	DESCRIPTION
insurance_category_id	integer, exists:InsuranceCategory	Filter by the Insurance Category's ID. Will return all Insurance Categories that have an ID that contains the given integer, exists:InsuranceCategory
name	string	Filter by the Insurance Category's name. Will return all Insurance Categories that have a name that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_assets	boolean	If true, includes the assets of an Insurance Category.	assets

Insurance Type

Insurance Type Index Request

Request

URL	insurance-types/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/insurance-types/

Parameters

Filters

KEY	TYPE	DESCRIPTION
insurance_type_id	integer, exists:InsuranceType	Filter by the Insurance Type's ID. Will return all Insurance Types that have an ID that contains the given integer, exists:InsuranceType
name	string	Filter by the Insurance Type's name. Will return all Insurance Types that have a name that contains the given string

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_assets	boolean	If true, includes the assets of an Insurance Type.	assets

Insurance Type Show Request

Request

URL	insurance-types/{insurancetype}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/insurance-types/{insurancetype}
{insurancetype}	Replace with the ID of the required Insurancetype.

Livery

Livery Index Request

Request

URL	liveries/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/liveries/

Parameters

Filters

KEY	TYPE	DESCRIPTION
livery_id	integer, exists:Livery	Filter by the Livery's ID. Will return all Liveries that have an ID that contains the given integer, exists:Livery
name	string	Filter by the Livery's name. Will return all Liveries that have a name that contains the given string
company_id	integer, exists:Company	Filter by the Livery's company id. Will return all Liveries with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_image	boolean	If true, includes the image of a Livery.	image
with_asset_count	boolean	If true, includes the asset count of a Livery.	asset_count
with_company	boolean	If true, includes the company of a Livery.	company

Livery Create Request

Request

URL	liveries/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/liveries/create

Livery Store Request

Request

URL	liveries/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/liveries/

Parameters

KEY	TYPE	DESCRIPTION
name	required, string	Will store a permitted value as the name of the Livery.
company_id	required, integer, exists:Company	Will store a permitted value as the company id of the Livery.

Livery Show Request

Request

URL	liveries/{livery}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/liveries/{livery}
{livery}	Replace with the ID of the required Livery.

Livery Edit Request

Request

URL	liveries/{livery}/edit
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/liveries/{livery}/edit
{livery}	Replace with the ID of the required Livery.

Parameters

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_image	boolean	If true, includes the image of a Livery.	image

Livery Update Request

Request

URL	liveries/{livery}
Method	PUT
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/liveries/{livery}
{livery}	Replace with the ID of the required Livery.

Maintenance Provider

Maintenance Provider Index Request

Request

URL	maintenance-providers/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/maintenance-providers/

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	integer, exists:Company	Filter by the Maintenance Provider's company id. Will return all Maintenance Providers with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
maintenance_provider_id	integer, exists:MaintenanceProvider	Filter by the Maintenance Provider's ID. Will return all Maintenance Providers that have an ID that contains the given integer, exists:MaintenanceProvider
name	string	Filter by the Maintenance Provider's name. Will return all Maintenance Providers that have a name that contains the given string
site_id	integer, exists:Site	Filter by the Maintenance Provider's site id. Will return all Maintenance Providers with the given site id. You can see what site ids you have access to (including the associated objects) by calling the site index route.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of a Maintenance Provider.	company
with_poi	boolean	If true, includes the poi of a Maintenance Provider.	poi

Maintenance Provider Show Request

Request

URL	maintenance-providers/{maintenanceprovider}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/maintenance-providers/{maintenanceprovider}
{maintenanceprovider}	Replace with the ID of the required Maintenanceprovider.

Manufacturer

Manufacturer Index Request

Request

URL	manufacturers/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/manufacturers/

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	exists:Company	Filter by the Manufacturer's company id. Will return all Manufacturers with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
manufacturer_id	exists:Company	Filter by the Manufacturer's ID. Will return all Manufacturers that have an ID that contains the given exists:Company

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of a Manufacturer.	company

Operating Centre

Operating Centre Index Request

Request

URL	operating-centres/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/operating-centres/

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	integer, exists:Company	Filter by the Operating Centre's company id. Will return all Operating Centres with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
name	string	Filter by the Operating Centre's name. Will return all Operating Centres that have a name that contains the given string
operating_centre_id	integer, exists:OperatingCentre	Filter by the Operating Centre's ID. Will return all Operating Centres that have an ID that contains the given integer, exists:OperatingCentre

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of an Operating Centre.	company
with_poi	boolean	If true, includes the poi of an Operating Centre.	poi

Operating Centre Create Request

Request

URL	operating-centres/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/operating-centres/create

Operating Centre Store Request

Request

URL	operating-centres/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/operating-centres/

Parameters

KEY	TYPE	DESCRIPTION
name	required, string	Will store a permitted value as the name of the Operating Centre.
company_id	required, integer, exists:Company	Will store a permitted value as the company id of the Operating Centre.
operator_licence_id	nullable, integer, exists:OperatorLicence	Will store a permitted value as the operator licence id of the Operating Centre.
poi_id	nullable, integer, exists:Poi	Will store a permitted value as the poi id of the Operating Centre.

Operating Centre Show Request

Request

URL	operating-centres/{operatingcentre}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/operating-centres/{operatingcentre}
{operatingcentre}	Replace with the ID of the required Operatingcentre.

Operating Centre Edit Request

Request

URL	operating-centres/{operatingcentre}/edit
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/operating-centres/{operatingcentre}/edit
{operatingcentre}	Replace with the ID of the required Operatingcentre.

Operating Centre Update Request

Request

URL	operating-centres/{operatingcentre}
Method	PUT
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/operating-centres/{operatingcentre}
{operatingcentre}	Replace with the ID of the required Operatingcentre.

Operator Licence

Operator Licence Index Request

Request

URL	operator-licences/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/operator-licences/

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	integer, exists:Company	Filter by the Operator Licence's company id. Will return all Operator Licences with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
licence_holder_id	integer, exists:User	Filter by the Operator Licence's licence holder id. Will return all Operator Licences with the given licence holder id.
name	string	Filter by the Operator Licence's name. Will return all Operator Licences that have a name that contains the given string
operator_licence_id	integer, exists:OperatorLicence	Filter by the Operator Licence's ID. Will return all Operator Licences that have an ID that contains the given integer, exists:OperatorLicence

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_assets_counts	boolean	If true, includes the assets counts of an Operator Licence.	assets_counts
with_company	boolean	If true, includes the company of an Operator Licence.	company
with_expiry_date	boolean	If true, includes the expiry date of an Operator Licence.	expiry_date
with_licence_holders	boolean	If true, includes the licence holders of an Operator Licence.	licence_holders

Operator Licence Create Request

Request

URL	operator-licences/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/operator-licences/create

Operator Licence Store Request

Request

URL	operator-licences/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/operator-licences/

Parameters

KEY	TYPE	DESCRIPTION
name	required, string	Will store a permitted value as the name of the Operator Licence.
company_id	required, integer, exists:Company	Will store a permitted value as the company id of the Operator Licence.
max_vehicles	nullable, integer, min:0	Will store a permitted value as the max vehicles of the Operator Licence.
max_trailers	nullable, integer, min:0	Will store a permitted value as the max trailers of the Operator Licence.
expiry_date	nullable, date format:Y-m-d	Will store a permitted value as the expiry date of the Operator Licence.

Operator Licence Show Request

Request

URL	operator-licences/{operatorlicence}
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/operator-licences/{operatorlicence}
{operatorlicence}	Replace with the ID of the required Operatorlicence.

Parameters

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_assets	boolean	If true, includes the assets of an Operator Licence.	assets
with_assets_counts	boolean	If true, includes the assets counts of an Operator Licence.	assets_counts
with_company	boolean	If true, includes the company of an Operator Licence.	company
with_licence_holders	boolean	If true, includes the licence holders of an Operator Licence.	licence_holders

Operator Licence Edit Request

Request

URL	operator-licences/{operatorlicence}/edit
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/operator-licences/{operatorlicence}/edit
{operatorlicence}	Replace with the ID of the required Operatorlicence.

Operator Licence Update Request

Request

URL	operator-licences/{operatorlicence}
Method	PUT
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/operator-licences/{operatorlicence}
{operatorlicence}	Replace with the ID of the required Operatorlicence.

Owner

Owner Index Request

Request

URL	owners/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/owners/

Parameters

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of an Owner.	company

Poi

Poi Index Request

Request

URL	pois/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/pois/

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	integer, exists:Company	Filter by the Poi's company id. Will return all Pois with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
name	string	Filter by the Poi's name. Will return all Pois that have a name that contains the given string
only_depots	boolean	Filter by whether the Poi is Only a Depot. If true, will return all Pois which are Only a Depot. If false, will return all Pois which are not Only a Depot.
poi_id	integer, exists:Poi	Filter by the Poi's ID. Will return all Pois that have an ID that contains the given integer, exists:Poi
poi_type_id	integer, exists:PoiType	Filter by the Poi's poi type id. Will return all Pois with the given poi type id. You can see what poi type ids you have access to (including the associated objects) by calling the poi type index route.
latitude	between:-90,90	Filter by the Poi's latitude. Will return all Pois that have a latitude that contains the given between:-90,90
longitude	between:-180,180	Filter by the Poi's longitude. Will return all Pois that have a longitude that contains the given between:-180,180
distance_to	array	Filter by the Poi's distance to. Will return all Pois that have a distance to within the given array.
distance_to.latitude	required with:with_distance, between:-90,90	Filter by the Poi's distance tolatitude. Will return all Pois that have a distance tolatitude that contains the given required with:with_distance, between:-90,90
distance_to.longitude	required with:with_distance, between:-90,90	Filter by the Poi's distance tolongitude. Will return all Pois that have a distance tolongitude that contains the given required with:with_distance, between:-90,90
group_by	string	Group Poi's by the given string.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_company	boolean	If true, includes the company of a Poi.	company
with_poi_type	boolean	If true, includes the poi type of a Poi.	poi_type
with_latitude	boolean	If true, includes the latitude of a Poi.	latitude
with_longitude	boolean	If true, includes the longitude of a Poi.	longitude
with_radius_m	boolean	If true, includes the radius (in Metres) of a Poi.	radius_m
with_vector_type	boolean	If true, includes the vector type of a Poi.	vector_type
with_polygon	boolean	If true, includes the polygon of a Poi.	polygon
with_point	boolean	If true, includes the point of a Poi.	point
with_distance	boolean	If true, includes the distance of a Poi.	distance

Poi Create Request

Request

URL	pois/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/pois/create

Poi Store Request

Request

URL	pois/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/pois/

Parameters

KEY	TYPE	DESCRIPTION
name	nullable, string	Will store a permitted value as the name of the Poi.
geographical_reference	nullable, string	Will store a permitted value as the geographical reference of the Poi.
short_description	nullable, string	Will store a permitted value as the short description of the Poi.
use_generated_name	nullable, boolean	Will store whether to use the generated name of the Poi depending on the value passed.
address1	nullable, string	Will store a permitted value as the first address line of the Poi.
address2	nullable, string	Will store a permitted value as the second address line of the Poi.
town	nullable, string	Will store a permitted value as the town of the Poi.
country	nullable, string	Will store a permitted value as the country of the Poi.
postcode	nullable, string	Will store a permitted value as the postcode of the Poi.
contact_name	nullable, string	Will store a permitted value as the contact name of the Poi.
contact_number	nullable, string	Will store a permitted value as the contact number of the Poi.
vector_type	required, Enum	Will store a permitted value as the vector type of the Poi.
latitude	required, numeric	Will store a permitted value as the latitude of the Poi.
longitude	required, numeric	Will store a permitted value as the longitude of the Poi.
radius_m	required if:vector_type,circle, nullable, integer	Will store a permitted value as the radius (in Metres) of the Poi.
company_id	required, integer, exists:Company	Will store a permitted value as the company id of the Poi.
poi_type_id	nullable, integer, exists:PoiType	Will store a permitted value as the poi type id of the Poi.
operator_licence_id	nullable, integer, exists:OperatorLicence	Will store a permitted value as the operator licence id of the Poi.
resolved	nullable, boolean	Will store the resolved value of the Poi as either true or false depending on the value passed.
polygon	nullable, required if:vector_type,polygon	Will store a permitted value as the polygon of the Poi.
point	nullable	Will store a permitted value as the point of the Poi.

Poi Show Request

Request

URL	pois/{poi}
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/pois/{poi}
{poi}	Replace with the ID of the required Poi.

Poi Edit Request

Request

URL	pois/{poi}/edit
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/pois/{poi}/edit
{poi}	Replace with the ID of the required Poi.

Poi Update Request

Request

URL	pois/{poi}
Method	PUT
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/pois/{poi}
{poi}	Replace with the ID of the required Poi.

Repair Arrangement

Repair Arrangement Index Request

Request

URL	repair-arrangements/
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/repair-arrangements/

Site

Site Index Request

Request

URL	sites/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/sites/

Parameters

Filters

KEY	TYPE	DESCRIPTION
company_id	integer, exists:Company	Filter by the Site's company id. Will return all Sites with the given company id. You can see what company ids you have access to (including the associated objects) by calling the company index route.
business_unit_id	integer, exists:BusinessUnit	Filter by the Site's business unit id. Will return all Sites with the given business unit id. You can see what business unit ids you have access to (including the associated objects) by calling the business unit index route.
cost_centre_id	integer, exists:CostCentre	Filter by the Site's cost centre id. Will return all Sites with the given cost centre id. You can see what cost centre ids you have access to (including the associated objects) by calling the cost centre index route.
customer_id	integer, exists:Customer	Filter by the Site's customer id. Will return all Sites with the given customer id. You can see what customer ids you have access to (including the associated objects) by calling the customer index route.
maintenance_provider_id	integer, exists:MaintenanceProvider	Filter by the Site's maintenance provider id. Will return all Sites with the given maintenance provider id.
name	string	Filter by the Site's name. Will return all Sites that have a name that contains the given string
operating_centre_id	integer, exists:OperatingCentre	Filter by the Site's operating centre id. Will return all Sites with the given operating centre id. You can see what operating centre ids you have access to (including the associated objects) by calling the operating centre index route.
site_id	integer, exists:Site	Filter by the Site's ID. Will return all Sites that have an ID that contains the given integer, exists:Site
site_manager_id	integer, exists:User	Filter by the Site's site manager id. Will return all Sites with the given site manager id.
company_ids	array. Each item in the array must be integer, exists:Company.	Filter by the Site's company id. Will return all Sites that have a company id within the given array.
business_unit_ids	array. Each item in the array must be integer, exists:BusinessUnit.	Filter by the Site's business unit id. Will return all Sites that have a business unit id within the given array.
cost_centre_ids	array. Each item in the array must be integer, exists:CostCentre.	Filter by the Site's cost centre id. Will return all Sites that have a cost centre id within the given array.
site_ids	array. Each item in the array must be integer, exists:Site.	Filter by the Site's site id. Will return all Sites that have a site id within the given array.
customer_ids	array. Each item in the array must be integer, exists:Customer.	Filter by the Site's customer id. Will return all Sites that have a customer id within the given array.
insurance_category_ids	array. Each item in the array must be integer, exists:InsuranceCategory.	Filter by the Site's insurance category id. Will return all Sites that have an insurance category id within the given array.
insurance_type_ids	array. Each item in the array must be integer, exists:InsuranceType.	Filter by the Site's insurance type id. Will return all Sites that have an insurance type id within the given array.
operating_centre_ids	array. Each item in the array must be integer, exists:OperatingCentre.	Filter by the Site's operating centre id. Will return all Sites that have an operating centre id within the given array.
operator_licence_ids	array. Each item in the array must be integer, exists:OperatorLicence.	Filter by the Site's operator licence id. Will return all Sites that have an operator licence id within the given array.
response_type	in:csv,csv-data	Return the response corresponding to required format as per the given string.
response_delivery_email	boolean	Filter by whether the Site is response delivery email. If true, will return all Sites which are response delivery email. If false, will return all Sites which are not response delivery email.
limit	integer, gt:0	Filter by the Site's limit. Will return all Sites that have a limit that contains the given integer, gt:0
query_timeout	nullable, integer, min:1000	Set the timeout value through the given string.

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_assets	boolean	If true, includes the assets of a Site.	assets
with_authorized_trailer_limit	boolean	If true, includes the authorized trailer limit of a Site.	authorized_trailer_limit
with_authorized_vehicle_limit	boolean	If true, includes the authorized vehicle limit of a Site.	authorized_vehicle_limit
with_business_unit	boolean	If true, includes the business unit of a Site.	business_unit
with_company	boolean	If true, includes the company of a Site.	company
with_cost_centre	boolean	If true, includes the cost centre of a Site.	cost_centre
with_customer	boolean	If true, includes the customer of a Site.	customer
with_default_contract_visibility_type	boolean	If true, includes the default contract visibility type of a Site.	default_contract_visibility_type
with_default_insurance_category	boolean	If true, includes the default insurance category of a Site.	default_insurance_category
with_default_insurance_type	boolean	If true, includes the default insurance type of a Site.	default_insurance_type
with_maintenance_providers	boolean	If true, includes the maintenance providers of a Site.	maintenance_providers
with_operating_centre	boolean	If true, includes the operating centre of a Site.	operating_centre
with_operator_licence	boolean	If true, includes the operator licence of a Site.	operator_licence
with_site_manager	boolean	If true, includes the site manager of a Site.	site_manager
with_trailer_count	boolean	If true, includes the trailer count of a Site.	trailer_count
with_vehicle_count	boolean	If true, includes the vehicle count of a Site.	vehicle_count

Site Create Request

Request

URL	sites/create
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/sites/create

Site Store Request

Request

URL	sites/
Method	POST
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/sites/

Parameters

KEY	TYPE	DESCRIPTION
name	required, string	Will store a permitted value as the name of the Site.
company_id	required, integer, exists:Company	Will store a permitted value as the company id of the Site.
legal_entity_id	nullable, integer, exists:LegalEntity	Will store a permitted value as the legal entity id of the Site.
business_unit_id	nullable, integer, exists:BusinessUnit	Will store a permitted value as the business unit id of the Site.
cost_centre_id	nullable, integer, exists:CostCentre	Will store a permitted value as the cost centre id of the Site.
customer_id	nullable, integer, exists:Customer	Will store a permitted value as the customer id of the Site.
operating_centre_id	nullable, integer, exists:OperatingCentre	Will store a permitted value as the operating centre id of the Site.
site_manager_id	nullable, integer, exists:User	Will store a permitted value as the site manager id of the Site.
default_insurance_category_id	nullable, integer, exists:InsuranceCategory	Will store a permitted value as the default insurance category id of the Site.
default_insurance_type_id	nullable, integer, exists:InsuranceType	Will store a permitted value as the default insurance type id of the Site.
default_contract_visibility_type_id	nullable, integer, exists:ContractVisibilityType	Will store a permitted value as the default contract visibility type id of the Site.
authorized_vehicle_limit	nullable, integer	Will store a permitted value as the authorized vehicle limit of the Site.
authorized_trailer_limit	nullable, integer	Will store a permitted value as the authorized trailer limit of the Site.

Site Show Request

Request

URL	sites/{site}
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/sites/{site}
{site}	Replace with the ID of the required Site.

Parameters

Includes

KEY	TYPE	DESCRIPTION	RETURNS
with_assets	boolean	If true, includes the assets of a Site.	assets
with_assets_count	boolean	If true, includes the assets count of a Site.	assets_count
with_operator_licence	boolean	If true, includes the operator licence of a Site.	operator_licence
with_vehicle_count	boolean	If true, includes the vehicle count of a Site.	vehicle_count
with_trailer_count	boolean	If true, includes the trailer count of a Site.	trailer_count

Site Edit Request

Request

URL	sites/{site}/edit
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/sites/{site}/edit
{site}	Replace with the ID of the required Site.

Site Update Request

Request

URL	sites/{site}
Method	PUT
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/sites/{site}
{site}	Replace with the ID of the required Site.

Use Class

Asset Use Class Index Request

Request

URL	asset-use-classes/
Method	GET
Options	See Parameters Below
Example Request URL	https://api.staging.axscend.com/v3/asset-use-classes/

Parameters

KEY	TYPE	DESCRIPTION
asset_use_class_id	integer, exists:AssetUseClass	Will store a permitted value as the ID of the Use Class.
company_id	integer, exists:Company	Will store a permitted value as the company id of the Use Class.
name	string	Will store a permitted value as the name of the Use Class.
with_company	boolean	Will store the company value of the Use Class as either true or false depending on the value passed.

Asset Use Class Show Request

Request

URL	asset-use-classes/
Method	GET
Options	N/A
Example Request URL	https://api.staging.axscend.com/v3/asset-use-classes/