Trendsic Platform Service

<back to all web services

EquipmentVehicleStatusRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/Equipment/{EquipmentID}/vehicle/status
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentVehicle:
    equipment_vehicle_i_d: int = 0
    equipment_i_d: int = 0
    unit_number: Optional[str] = None
    vehicle_type: Optional[str] = None
    capacity_text: Optional[str] = None
    capacity_tons: Optional[Decimal] = None
    deck_feet: Optional[Decimal] = None
    plate: Optional[str] = None
    vin: Optional[str] = None
    gps_unit: Optional[str] = None
    insurance_expires: Optional[datetime.datetime] = None
    inspection_due: Optional[datetime.datetime] = None
    capabilities: Optional[str] = None
    vehicle_status: Optional[str] = None
    vendor_i_d: Optional[int] = None
    equipment_name: Optional[str] = None
    ownership: Optional[str] = None
    rental_vendor: Optional[str] = None
    truck_code: Optional[str] = None
    rig_code: Optional[str] = None
    board_module: Optional[str] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentVehicleResponse:
    vehicle: Optional[EquipmentVehicle] = None
    fleet: List[EquipmentVehicle] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentVehicleStatusRequest:
    equipment_i_d: int = 0
    vehicle_status: Optional[str] = None

Python EquipmentVehicleStatusRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/Equipment/{EquipmentID}/vehicle/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EquipmentVehicleStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <EquipmentID>0</EquipmentID>
  <VehicleStatus>String</VehicleStatus>
</EquipmentVehicleStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EquipmentVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Fleet>
    <EquipmentVehicle>
      <BoardModule>String</BoardModule>
      <Capabilities>String</Capabilities>
      <CapacityText>String</CapacityText>
      <CapacityTons>0</CapacityTons>
      <DeckFeet>0</DeckFeet>
      <EquipmentID>0</EquipmentID>
      <EquipmentName>String</EquipmentName>
      <EquipmentVehicleID>0</EquipmentVehicleID>
      <GpsUnit>String</GpsUnit>
      <InspectionDue>0001-01-01T00:00:00</InspectionDue>
      <InsuranceExpires>0001-01-01T00:00:00</InsuranceExpires>
      <Ownership>String</Ownership>
      <Plate>String</Plate>
      <RentalVendor>String</RentalVendor>
      <RigCode>String</RigCode>
      <TruckCode>String</TruckCode>
      <UnitNumber>String</UnitNumber>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <VIN>String</VIN>
      <VehicleStatus>String</VehicleStatus>
      <VehicleType>String</VehicleType>
      <VendorID>0</VendorID>
    </EquipmentVehicle>
  </Fleet>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Vehicle>
    <BoardModule>String</BoardModule>
    <Capabilities>String</Capabilities>
    <CapacityText>String</CapacityText>
    <CapacityTons>0</CapacityTons>
    <DeckFeet>0</DeckFeet>
    <EquipmentID>0</EquipmentID>
    <EquipmentName>String</EquipmentName>
    <EquipmentVehicleID>0</EquipmentVehicleID>
    <GpsUnit>String</GpsUnit>
    <InspectionDue>0001-01-01T00:00:00</InspectionDue>
    <InsuranceExpires>0001-01-01T00:00:00</InsuranceExpires>
    <Ownership>String</Ownership>
    <Plate>String</Plate>
    <RentalVendor>String</RentalVendor>
    <RigCode>String</RigCode>
    <TruckCode>String</TruckCode>
    <UnitNumber>String</UnitNumber>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <VIN>String</VIN>
    <VehicleStatus>String</VehicleStatus>
    <VehicleType>String</VehicleType>
    <VendorID>0</VendorID>
  </Vehicle>
</EquipmentVehicleResponse>