Trendsic Platform Service

<back to all web services

CourierDriverVehicleRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/worker/dispatch/od/vehicle
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 CourierVehicleClassView:
    code: Optional[str] = None
    name: Optional[str] = None
    name_es: Optional[str] = None
    hint: Optional[str] = None
    hint_es: Optional[str] = None
    cap: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierDriverVehicleResponse:
    equipment_i_d: int = 0
    unit_number: Optional[str] = None
    is_own: bool = False
    set_by_office: bool = False
    class_code: Optional[str] = None
    class_name: Optional[str] = None
    class_name_es: Optional[str] = None
    cap: Optional[Decimal] = None
    unit_one: Optional[str] = None
    unit_many: Optional[str] = None
    unit_one_es: Optional[str] = None
    unit_many_es: Optional[str] = None
    classes: List[CourierVehicleClassView] = field(default_factory=list)
    saved: bool = False
    saved_text: Optional[str] = None
    saved_text_es: Optional[str] = None
    message_es: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierDriverVehicleRequest:
    class_code: Optional[str] = None

Python CourierDriverVehicleRequest 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.

PUT /v1/worker/dispatch/od/vehicle HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<CourierDriverVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Cap>0</Cap>
  <ClassCode>String</ClassCode>
  <ClassName>String</ClassName>
  <ClassNameEs>String</ClassNameEs>
  <Classes>
    <CourierVehicleClassView>
      <Cap>0</Cap>
      <Code>String</Code>
      <Hint>String</Hint>
      <HintEs>String</HintEs>
      <Name>String</Name>
      <NameEs>String</NameEs>
    </CourierVehicleClassView>
  </Classes>
  <EquipmentID>0</EquipmentID>
  <IsOwn>false</IsOwn>
  <MessageEs>String</MessageEs>
  <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>
  <Saved>false</Saved>
  <SavedText>String</SavedText>
  <SavedTextEs>String</SavedTextEs>
  <SetByOffice>false</SetByOffice>
  <UnitMany>String</UnitMany>
  <UnitManyEs>String</UnitManyEs>
  <UnitNumber>String</UnitNumber>
  <UnitOne>String</UnitOne>
  <UnitOneEs>String</UnitOneEs>
</CourierDriverVehicleResponse>