v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Equipment

Gets one Equipment object from the cache.

Represents data found in Vista™ EM Equipment program.

Vista views: EMEM, and EMEP

get/direct/subscribers/{subscriber_code}/vista/em/2/data/equipment/cache/{ryvitId_value}

Path parameters

subscriber_codestring required

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

ryvitId_valuestring required

The code of the data object you want to get.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Response

Success

__ryvitKeysstring[]

Array of key paths that can be used to retrieve this object.

__modifiedUTCstring

UTC timestamp of when this object was last modified in the cache.

EMCointeger required

Equipmentstring required

Locationstring nullable

Typestring required

Departmentstring nullable

Categorystring nullable

Manufacturerstring nullable

Modelstring nullable

ModelYrstring nullable

VINNumberstring nullable

Descriptionstring nullable

Statusstring required

OdoReadingstring required

OdoDatestring nullable

ReplacedOdoReadingstring required

ReplacedOdoDatestring nullable

HourReadingstring required

HourDatestring nullable

ReplacedHourReadingstring required

ReplacedHourDatestring nullable

MatlGroupinteger nullable

FuelMatlCodestring nullable

FuelCapacitystring required

FuelCapUMstring nullable

FuelUsedstring required

EMGroupinteger nullable

FuelCostCodestring nullable

FuelCostTypeinteger nullable

LastFuelDatestring nullable

AttachToEquipstring nullable

AttachPostRevenue'Y' | 'N' | 'null' nullable

JCCointeger nullable

Jobstring nullable

PhaseGrpinteger nullable

UsageCostTypeinteger nullable

WeightUMstring nullable

WeightCapacitystring required

VolumeUMstring nullable

VolumeCapacitystring required

Capitalized'Y' | 'N' | 'null' nullable

LicensePlateNostring nullable

LicensePlateStatestring nullable

LicensePlateExpDatestring nullable

IRPFleetstring nullable

CompOfEquipstring nullable

ComponentTypeCodestring nullable

CompUpdateHrs'Y' | 'N' | 'null' nullable

CompUpdateMiles'Y' | 'N' | 'null' nullable

CompUpdateFuel'Y' | 'N' | 'null' nullable

PostCostToComp'Y' | 'N' | 'null' nullable

PRCointeger nullable

Operatorinteger nullable

Shopstring nullable

GrossVehicleWeightstring required

TareWeightstring required

Heightstring nullable

Wheelbasestring nullable

NoAxlesinteger required

Widthstring nullable

OverallLengthstring nullable

HorsePowerstring nullable

TireSizestring nullable

OwnershipStatusstring nullable

InServiceDatestring nullable

ExpLifeinteger required

ReplCoststring required

CurrentAppraisalstring required

SoldDatestring nullable

SalePricestring required

PurchasedFromstring nullable

PurchasePricestring required

PurchDatestring nullable

APCointeger nullable

VendorGroupinteger nullable

LeasedFrominteger nullable

LeaseStartDatestring nullable

LeaseEndDatestring nullable

LeasePaymentstring required

LeaseResidualValuestring required

ARCointeger nullable

CustGroupinteger nullable

Customerinteger nullable

CustEquipNostring nullable

MSTruckTypestring nullable

RevenueCodestring nullable

Notesstring nullable

MechanicNotesstring nullable

JobDatestring nullable

FuelTypestring required

UpdateYN'Y' | 'N' required

ShopGroupinteger required

IFTAStatestring nullable

UniqueAttchIDstring nullable

LastUsedDatestring nullable

KeyIDinteger required

ChangeInProgress'Y' | 'N' | 'null' nullable

LastUsedEquipmentCodestring nullable

LastEquipmentChangeDatestring nullable

LastEquipmentChangeUserstring nullable

EquipmentCodeChangesinteger nullable

OriginalEquipmentCodestring nullable

ExpLifeTimeFramestring required

CrossReferenceUsage'Y' | 'N' required

__custom_fieldsobject

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

Example response

{
  "__modifiedUTC": "2020-01-01T13:01:01.1234567Z"
}