v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Equipment

Executes the Add action for the Equipment data object.

Adds a new equipment record

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

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

EMCointeger required

Key to em/equipment(EMCo, Equipment).

Equipmentstring required

Key to em/equipment(EMCo, Equipment).

Typestring

Options: E-Equipment, C-Component. Optional. If omitted, E will be defaulted.

Manufacturerstring nullable

Optional. If omitted, null will be defaulted.

Modelstring nullable

Optional. If omitted, null will be defaulted.

ModelYrstring nullable

Optional. If omitted, null will be defaulted.

VINNumberstring nullable

Optional. If omitted, null will be defaulted.

Descriptionstring nullable

Optional. If omitted, null will be defaulted.

Statusstring

Options: A-Active, I-Inactive, D-Down. Optional. If omitted, A will be defaulted.

Departmentstring nullable required

Key to em/departments(EMCo, Department).

Categorystring nullable required

Key to em/categories(EMCo, Category).

Locationstring nullable

Key to em/locations(EMCo, EMLoc). Optional. If omitted, null will be defaulted.

Shopstring nullable

Key to em/shops(ShopGroup, Shop). ShopGroup based on EMCo. Optional. If omitted, null will be defaulted.

RevenueCodestring nullable

Key to em/rev_codes(EMGroup, RevCode). EMGroup based on EMCo. Optional. If omitted, null will be defaulted.

PRCointeger nullable

Key to pr/employees(PRCo, Employee). Optional. If omitted, defaulted based on Vista defaults.

Operatorinteger nullable

Key to pr/employees(PRCo, Employee). Optional. If omitted, null will be defaulted.

JCCointeger nullable

Key to jc/jobs(JCCo, Job). Optional. If omitted, defaulted based on Vista defaults.

Jobstring nullable

Key to jc/jobs(JCCo, Job). Optional. If omitted, null will be defaulted.

UsageCostTypeinteger nullable

Optional. If omitted, defaulted based on Vista defaults.

CrossReferenceUsage'Y' | 'N'

Optional. If omitted, N will be defaulted.

LastUsedDatestring date nullable

Format: YYYY-MM-DD. Optional. If omitted, null will be defaulted.

LicensePlateNostring nullable

Optional. If omitted, null will be defaulted.

LicensePlateStatestring nullable

Optional. If omitted, null will be defaulted.

LicensePlateExpDatestring date nullable

Format: YYYY-MM-DD. Optional. If omitted, null will be defaulted.

IRPFleetstring nullable

Optional. If omitted, null will be defaulted.

IFTAStatestring nullable

Optional. If omitted, null will be defaulted.

FuelTypestring

Options: D-Diesel, G-Gas, O-Other, N-None. Optional. If omitted, N will be defaulted.

FuelMatlCodestring nullable

Key to hq/materials(MatlGroup, Material). MatlGroup determined by .EMCo. Optional. If omitted, null will be defaulted.

FuelCostCodestring nullable

Key to em/cost_codes(EMGroup, CostCode). EMGroup determined by .EMCo. Optional. If omitted, null will be defaulted.

FuelCostTypeinteger nullable

Key to em/cost_types(EMGroup, CostType). EMGroup determined by .EMCo. Optional. If omitted, null will be defaulted.

FuelCapacitystring

Optional. If omitted, 0.00 will be defaulted.

FuelCapUMstring nullable

Key hq/unit_of_measures(UM). Optional. If omitted, null will be defaulted. A non null value is required if .FuelType != N.

WeightUMstring nullable

Key hq/unit_of_measures(UM). Optional. If omitted, null will be defaulted.

WeightCapacitystring

Optional. If omitted, 0.00 will be defaulted.

VolumeUMstring nullable

Key hq/unit_of_measures(UM). Optional. If omitted, null will be defaulted.

VolumeCapacitystring

Optional. If omitted, 0.00 will be defaulted.

MSTruckTypestring nullable

Optional. If omitted, null will be defaulted.

GrossVehicleWeightstring

Optional. If omitted, 0.00 will be defaulted.

TareWeightstring

Optional. If omitted, 0.000 will be defaulted.

Heightstring nullable

Optional. If omitted, null will be defaulted.

Wheelbasestring nullable

Optional. If omitted, null will be defaulted.

NoAxlesinteger

Optional. If omitted, 0 will be defaulted.

Widthstring nullable

Optional. If omitted, null will be defaulted.

OverallLengthstring nullable

Optional. If omitted, null will be defaulted.

HorsePowerstring nullable

Optional. If omitted, null will be defaulted.

TireSizestring nullable

Optional. If omitted, null will be defaulted.

AttachToEquipstring nullable

Key em/equipment(EMCo, Equipment). Optional. If omitted, null will be defaulted. Input is ignored if .Type != E.

AttachPostRevenue'Y' | 'N'

Optional. If omitted, N will be defaulted. 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. If omitted, it will be defaulted ot $.CompUnattachedEquip value in em/company_parameters for the provided EMCo. Input is ignored if .Type != C.

ComponentTypeCodestring nullable

Key em/component_types(EMGroup, ComponentTypeCode). EMGroup based on .EMCo. A value is required to be provided for .Type = C. Optional. If omitted, null will be defaulted. Input is ignored if .Type != C.

CompUpdateHrs'Y' | 'N'

Optional. If omitted, N will be defaulted. Input is ignored if .Type != C.

CompUpdateMiles'Y' | 'N'

Optional. If omitted, N will be defaulted. Input is ignored if .Type != C.

CompUpdateFuel'Y' | 'N'

Optional. If omitted, N will be defaulted. Input is ignored if .Type != C.

PostCostToComp'Y' | 'N'

Optional. If omitted, defaulted based on Vista defaulting. Input is ignored if .Type != C.

Notesstring nullable

Optional. If omitted, null will be defaulted.

MechanicNotesstring nullable

Optional. If omitted, null will be defaulted.

__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