Executes the Add action for the Equipment data object.

post

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

Adds a new equipment record

Recent Requests

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

EMCo

integer

required

1 to 255

Key to em/equipment(EMCo, Equipment).

Equipment

string

required

length ≤ 10

Key to em/equipment(EMCo, Equipment).

Type

string

length ≤ 1

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

Manufacturer

string | null

Optional. If omitted, null will be defaulted.

Model

string | null

Optional. If omitted, null will be defaulted.

ModelYr

string | null

Optional. If omitted, null will be defaulted.

VINNumber

string | null

Optional. If omitted, null will be defaulted.

Description

string | null

Optional. If omitted, null will be defaulted.

Status

string

length ≤ 1

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

Department

string | null

required

Key to em/departments(EMCo, Department).

Category

string | null

required

Key to em/categories(EMCo, Category).

Location

string | null

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

Shop

string | null

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

RevenueCode

string | null

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

PRCo

integer | null

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

Operator

integer | null

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

JCCo

integer | null

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

Job

string | null

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

UsageCostType

integer | null

Optional. If omitted, defaulted based on Vista defaults.

CrossReferenceUsage

string

enum

Optional. If omitted, N will be defaulted.

Allowed:

LastUsedDate

date | null

^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

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

LicensePlateNo

string | null

Optional. If omitted, null will be defaulted.

LicensePlateState

string | null

Optional. If omitted, null will be defaulted.

LicensePlateExpDate

date | null

^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

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

IRPFleet

string | null

Optional. If omitted, null will be defaulted.

IFTAState

string | null

Optional. If omitted, null will be defaulted.

FuelType

string

length ≤ 1

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

FuelMatlCode

string | null

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

FuelCostCode

string | null

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

FuelCostType

integer | null

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

FuelCapacity

string

^[-+]?[0-9]{1,8}(?:.[0-9]{0,2})?$

Optional. If omitted, 0.00 will be defaulted.

FuelCapUM

string | null

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

WeightUM

string | null

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

WeightCapacity

string

^[-+]?[0-9]{1,8}(?:.[0-9]{0,2})?$

Optional. If omitted, 0.00 will be defaulted.

VolumeUM

string | null

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

VolumeCapacity

string

^[-+]?[0-9]{1,8}(?:.[0-9]{0,2})?$

Optional. If omitted, 0.00 will be defaulted.

MSTruckType

string | null

Optional. If omitted, null will be defaulted.

GrossVehicleWeight

string

^[-+]?[0-9]{1,8}(?:.[0-9]{0,2})?$

Optional. If omitted, 0.00 will be defaulted.

TareWeight

string

^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$

Optional. If omitted, 0.000 will be defaulted.

Height

string | null

Optional. If omitted, null will be defaulted.

Wheelbase

string | null

Optional. If omitted, null will be defaulted.

NoAxles

integer

Optional. If omitted, 0 will be defaulted.

Width

string | null

Optional. If omitted, null will be defaulted.

OverallLength

string | null

Optional. If omitted, null will be defaulted.

HorsePower

string | null

Optional. If omitted, null will be defaulted.

TireSize

string | null

Optional. If omitted, null will be defaulted.

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. If omitted, null will be defaulted. Input is ignored if .Type != E.

AttachPostRevenue

string

enum

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

Allowed:

CompOfEquip

string | null

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.

ComponentTypeCode

string | null

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

string

enum

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

Allowed:

CompUpdateMiles

string

enum

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

Allowed:

CompUpdateFuel

string

enum

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

Allowed:

PostCostToComp

string

enum

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

Allowed:

Notes

string | null

Optional. If omitted, null will be defaulted.

MechanicNotes

string | null

Optional. If omitted, null will be defaulted.

__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

Loading…

Response

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

application/json

200Success

400Describes issues with the request.