Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Equipment

Executes the Change action for the Equipment data object.

Changes an existing equipment record

post/direct/subscribers/{subscriber_code}/vista/em/2/data/equipment/actions/change

Path parameters

subscriber_codestring required

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

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

Typestring

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

Manufacturerstring nullable

Optional.

Modelstring nullable

Optional.

ModelYrstring nullable

Optional.

VINNumberstring nullable

Optional.

Descriptionstring nullable

Optional.

Statusstring

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

Departmentstring nullable

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

Categorystring nullable

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

Locationstring nullable

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

Shopstring nullable

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

RevenueCodestring nullable

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

PRCointeger nullable

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

Operatorinteger nullable

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

JCCointeger nullable

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

Jobstring nullable

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

UsageCostTypeinteger nullable

Optional.

CrossReferenceUsage'Y' | 'N'

Optional.

LastUsedDatestring date nullable

Format: YYYY-MM-DD. Optional.

LicensePlateNostring nullable

Optional.

LicensePlateStatestring nullable

Optional.

LicensePlateExpDatestring date nullable

Format: YYYY-MM-DD. Optional.

IRPFleetstring nullable

Optional.

IFTAStatestring nullable

Optional.

FuelTypestring

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

FuelMatlCodestring nullable

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

FuelCostCodestring nullable

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

FuelCostTypeinteger nullable

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

FuelCapacitystring

Optional.

FuelCapUMstring nullable

Key hq/unit_of_measures(UM). Optional.

WeightUMstring nullable

Key hq/unit_of_measures(UM). Optional.

WeightCapacitystring

Optional.

VolumeUMstring nullable

Key hq/unit_of_measures(UM). Optional.

VolumeCapacitystring

Optional.

MSTruckTypestring nullable

Optional.

GrossVehicleWeightstring

Optional.

TareWeightstring

Optional.

Heightstring nullable

Optional.

Wheelbasestring nullable

Optional.

NoAxlesinteger

Optional.

Widthstring nullable

Optional.

OverallLengthstring nullable

Optional.

HorsePowerstring nullable

Optional.

TireSizestring nullable

Optional.

AttachToEquipstring nullable

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

AttachPostRevenue'Y' | 'N'

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

CompOfEquipstring nullable

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

ComponentTypeCodestring nullable

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

CompUpdateHrs'Y' | 'N'

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

CompUpdateMiles'Y' | 'N'

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

CompUpdateFuel'Y' | 'N'

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

PostCostToComp'Y' | 'N'

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

Notesstring nullable

Optional.

MechanicNotesstring nullable

Optional.

__custom_fieldsobject

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

Response

Success

idstring
operationstring
statusstring