Trendsic Platform Service

DispatchLoadsRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/loads

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 DispatchLoadStageView:
    stage: Optional[str] = None
    at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    note: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchLoadView:
    load_id: int = 0
    code: Optional[str] = None
    module: Optional[str] = None
    truck_label: Optional[str] = None
    driver_label: Optional[str] = None
    carrier_label: Optional[str] = None
    source_label: Optional[str] = None
    destination_label: Optional[str] = None
    qty: Optional[Decimal] = None
    unit: Optional[str] = None
    qty_text: Optional[str] = None
    ticket_code: Optional[str] = None
    rate_applied: Optional[Decimal] = None
    rate_basis: Optional[str] = None
    revenue: Optional[Decimal] = None
    pay_plan_label: Optional[str] = None
    pay: Optional[Decimal] = None
    status: Optional[str] = None
    opened_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    closed_utc: Optional[datetime.datetime] = None
    photos: int = 0
    stages: List[DispatchLoadStageView] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchLoadsResponse:
    loads: List[DispatchLoadView] = field(default_factory=list)
    hours: int = 0
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchLoadsRequest:
    hours: int = 0
    module: Optional[str] = None

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

GET /v1/dispatch/loads HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchLoadsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Hours>0</Hours>
  <Loads>
    <DispatchLoadView>
      <CarrierLabel>String</CarrierLabel>
      <ClosedUtc>0001-01-01T00:00:00</ClosedUtc>
      <Code>String</Code>
      <DestinationLabel>String</DestinationLabel>
      <DriverLabel>String</DriverLabel>
      <LoadId>0</LoadId>
      <Module>String</Module>
      <OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
      <Pay>0</Pay>
      <PayPlanLabel>String</PayPlanLabel>
      <Photos>0</Photos>
      <Qty>0</Qty>
      <QtyText>String</QtyText>
      <RateApplied>0</RateApplied>
      <RateBasis>String</RateBasis>
      <Revenue>0</Revenue>
      <SourceLabel>String</SourceLabel>
      <Stages>
        <DispatchLoadStageView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Note>String</Note>
          <Stage>String</Stage>
        </DispatchLoadStageView>
      </Stages>
      <Status>String</Status>
      <TicketCode>String</TicketCode>
      <TruckLabel>String</TruckLabel>
      <Unit>String</Unit>
    </DispatchLoadView>
  </Loads>
  <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>
</DispatchLoadsResponse>