Executes the Change action for the Equipment data object.

post https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/em/2/data/equipment/actions/change

Changes an existing equipment record

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

subscriber_code

string

required

The code of the subscriber that you are making this request for.

Body Params

__key

required

Type

string

length ≤ 1

Options: E-Equipment, C-Component. Optional.

Manufacturer

string | null

Optional.

Model

string | null

Optional.

ModelYr

string | null

Optional.

VINNumber

string | null

Optional.

Description

string | null

Optional.

Status

string

length ≤ 1

Options: A-Active, I-Inactive, D-Down. Optional.

Department

string | null

Key to em/departments(EMCo, Department). Optional.

Category

string | null

Key to em/categories(EMCo, Category). Optional.

Location

string | null

Key to em/locations(EMCo, EMLoc). Optional.

Shop

string | null

Key to em/shops(ShopGroup, Shop). ShopGroup based on EMCo. Optional.

RevenueCode

string | null

Key to em/rev_codes(EMGroup, RevCode). EMGroup based on EMCo. Optional.

PRCo

integer | null

Key to pr/employees(PRCo, Employee). Optional.

Operator

integer | null

Key to pr/employees(PRCo, Employee). Optional.

JCCo

integer | null

Key to jc/jobs(JCCo, Job). Optional.

Job

string | null

Key to jc/jobs(JCCo, Job). Optional.

UsageCostType

integer | null

Optional.

CrossReferenceUsage

string

Optional.

LastUsedDate

date | null

Format: YYYY-MM-DD. Optional.

LicensePlateNo

string | null

Optional.

LicensePlateState

string | null

Optional.

LicensePlateExpDate

date | null

Format: YYYY-MM-DD. Optional.

IRPFleet

string | null

Optional.

IFTAState

string | null

Optional.

FuelType

string

length ≤ 1

Options: D-Diesel, G-Gas, O-Other, N-None. Optional.

FuelMatlCode

string | null

Key to hq/materials(MatlGroup, Material). MatlGroup determined by .EMCo. Optional.

FuelCostCode

string | null

Key to em/cost_codes(EMGroup, CostCode). EMGroup determined by .EMCo. Optional.

FuelCostType

integer | null

Key to em/cost_types(EMGroup, CostType). EMGroup determined by .EMCo. Optional.

FuelCapacity

string

Optional.

FuelCapUM

string | null

Key hq/unit_of_measures(UM). Optional.

WeightUM

string | null

Key hq/unit_of_measures(UM). Optional.

WeightCapacity

string

Optional.

VolumeUM

string | null

Key hq/unit_of_measures(UM). Optional.

VolumeCapacity

string

Optional.

MSTruckType

string | null

Optional.

GrossVehicleWeight

string

Optional.

TareWeight

string

Optional.

Height

string | null

Optional.

Wheelbase

string | null

Optional.

NoAxles

integer

Optional.

Width

string | null

Optional.

OverallLength

string | null

Optional.

HorsePower

string | null

Optional.

TireSize

string | null

Optional.

Ownership

object

Optional, if omitted each property will be defaulted as noted.

Meters

object

Optional, if omitted each property will be defaulted as noted.

AttachToEquip

string | null

Key em/equipment(EMCo, Equipment). Optional. Input is ignored if .Type != E.

AttachPostRevenue

string

Optional. Input is ignored if .Type != E.

CompOfEquip

string | null

Key em/equipment(EMCo, Equipment). A value is required to be provided or defaulted for .Type = C. Optional. Input is ignored if .Type != C.

ComponentTypeCode

string | null

Key em/component_types(EMGroup, ComponentTypeCode). EMGroup based on .EMCo. Optional. Input is ignored if .Type != C.

CompUpdateHrs

string

Optional. Input is ignored if .Type != C.

CompUpdateMiles

string

Optional. Input is ignored if .Type != C.

CompUpdateFuel

string

Optional. Input is ignored if .Type != C.

PostCostToComp

string

Optional. Input is ignored if .Type != C.

Notes

string | null

Optional.

MechanicNotes

string | null

Optional.

__custom_fields

object

Add properties to this object for any custom fields you want to set as this record is added to Vista.

Headers

X-Application-Key

string

required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.xchange.trimble.com/connect/v1/direct/subscribers/subscriber_code/vista/em/2/data/equipment/actions/change \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.

x-$.result for SuccessfulObject returned at $.result from GET /direct/actions/{action_key_value} when $.status = "Successful"

x-$.result for FailedObject returned at $.result from GET /direct/actions/{action_key_value} when $.status = "Failed"