Trendsic Platform Service

<back to all web services

DispatchPayPlanSaveRequest

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 DispatchRateConfigView:
    fuel_surcharge_pct: Decimal = decimal.Decimal(0)
    transport_per_mile: Decimal = decimal.Decimal(0)
    transport_job_min: Decimal = decimal.Decimal(0)
    transport_enclosed_uplift_pct: Decimal = decimal.Decimal(0)
    od_base: Decimal = decimal.Decimal(0)
    od_per_bag: Decimal = decimal.Decimal(0)
    od_premium_uplift_pct: Decimal = decimal.Decimal(0)
    haul_basis: Optional[str] = None
    facility: Optional[str] = None
    unit: Optional[str] = None
    load_qty: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchLaneRateView:
    dispatch_site_i_d: Optional[int] = None
    dispatch_supplier_i_d: Optional[int] = None
    source_label: Optional[str] = None
    supplier_name: Optional[str] = None
    dispatch_lane_rate_i_d: Optional[int] = None
    miles: Optional[Decimal] = None
    rate_per_ton: Optional[Decimal] = None
    rate_per_load: Optional[Decimal] = None
    rate_per_ton_mile: Optional[Decimal] = None
    rate_per_hour: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchZoneRateView:
    zone: Optional[str] = None
    dispatch_zone_rate_i_d: Optional[int] = None
    base: Optional[Decimal] = None
    per_bag: Optional[Decimal] = None
    premium_uplift_pct: Optional[Decimal] = None
    drivers: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPayPlanView:
    dispatch_pay_plan_i_d: int = 0
    name: Optional[str] = None
    basis: Optional[str] = None
    rate: Decimal = decimal.Decimal(0)
    rate2: Optional[Decimal] = None
    effective_date: Optional[datetime.datetime] = None
    is_active: bool = False
    drivers: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchRatesResponse:
    config: Optional[DispatchRateConfigView] = None
    lanes: List[DispatchLaneRateView] = field(default_factory=list)
    zones: List[DispatchZoneRateView] = field(default_factory=list)
    plans: List[DispatchPayPlanView] = field(default_factory=list)
    repriced: Optional[int] = None
    still_no_revenue: Optional[int] = None
    still_no_pay: Optional[int] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPayPlanSaveRequest:
    plan: Optional[DispatchPayPlanView] = None

Python DispatchPayPlanSaveRequest DTOs

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

<DispatchPayPlanSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Plan>
    <Basis>String</Basis>
    <DispatchPayPlanID>0</DispatchPayPlanID>
    <Drivers>0</Drivers>
    <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
    <IsActive>false</IsActive>
    <Name>String</Name>
    <Rate>0</Rate>
    <Rate2>0</Rate2>
  </Plan>
</DispatchPayPlanSaveRequest>

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

<DispatchRatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Config>
    <Facility>String</Facility>
    <FuelSurchargePct>0</FuelSurchargePct>
    <HaulBasis>String</HaulBasis>
    <LoadQty>0</LoadQty>
    <OdBase>0</OdBase>
    <OdPerBag>0</OdPerBag>
    <OdPremiumUpliftPct>0</OdPremiumUpliftPct>
    <TransportEnclosedUpliftPct>0</TransportEnclosedUpliftPct>
    <TransportJobMin>0</TransportJobMin>
    <TransportPerMile>0</TransportPerMile>
    <Unit>String</Unit>
  </Config>
  <Lanes>
    <DispatchLaneRateView>
      <DispatchLaneRateID>0</DispatchLaneRateID>
      <DispatchSiteID>0</DispatchSiteID>
      <DispatchSupplierID>0</DispatchSupplierID>
      <Miles>0</Miles>
      <RatePerHour>0</RatePerHour>
      <RatePerLoad>0</RatePerLoad>
      <RatePerTon>0</RatePerTon>
      <RatePerTonMile>0</RatePerTonMile>
      <SourceLabel>String</SourceLabel>
      <SupplierName>String</SupplierName>
    </DispatchLaneRateView>
  </Lanes>
  <Plans>
    <DispatchPayPlanView>
      <Basis>String</Basis>
      <DispatchPayPlanID>0</DispatchPayPlanID>
      <Drivers>0</Drivers>
      <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
      <IsActive>false</IsActive>
      <Name>String</Name>
      <Rate>0</Rate>
      <Rate2>0</Rate2>
    </DispatchPayPlanView>
  </Plans>
  <Repriced>0</Repriced>
  <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>
  <StillNoPay>0</StillNoPay>
  <StillNoRevenue>0</StillNoRevenue>
  <Zones>
    <DispatchZoneRateView>
      <Base>0</Base>
      <DispatchZoneRateID>0</DispatchZoneRateID>
      <Drivers>0</Drivers>
      <PerBag>0</PerBag>
      <PremiumUpliftPct>0</PremiumUpliftPct>
      <Zone>String</Zone>
    </DispatchZoneRateView>
  </Zones>
</DispatchRatesResponse>