Trendsic Platform Service

DispatchRatesRequest

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

**DispatchRatesResponse** Parameters:
Name	Parameter	Data Type	Required
Config	form	DispatchRateConfigView	No
Lanes	form	List<DispatchLaneRateView>	No
Zones	form	List<DispatchZoneRateView>	No
Plans	form	List<DispatchPayPlanView>	No
Repriced	form	int?	No
StillNoRevenue	form	int?	No
StillNoPay	form	int?	No
ResponseStatus	form	ResponseStatus	No

**DispatchRateConfigView** Parameters:
Name	Parameter	Data Type	Required
FuelSurchargePct	form	decimal	No
TransportPerMile	form	decimal	No
TransportJobMin	form	decimal	No
TransportEnclosedUpliftPct	form	decimal	No
OdBase	form	decimal	No
OdPerBag	form	decimal	No
OdPremiumUpliftPct	form	decimal	No
HaulBasis	form	string	No
Facility	form	string	No
Unit	form	string	No
LoadQty	form	decimal	No

**DispatchLaneRateView** Parameters:
Name	Parameter	Data Type	Required
DispatchSiteID	form	int?	No
DispatchSupplierID	form	int?	No
SourceLabel	form	string	No
SupplierName	form	string	No
DispatchLaneRateID	form	int?	No
Miles	form	decimal?	No
RatePerTon	form	decimal?	No
RatePerLoad	form	decimal?	No
RatePerTonMile	form	decimal?	No
RatePerHour	form	decimal?	No

**DispatchZoneRateView** Parameters:
Name	Parameter	Data Type	Required
Zone	form	string	No
DispatchZoneRateID	form	int?	No
Base	form	decimal?	No
PerBag	form	decimal?	No
PremiumUpliftPct	form	decimal?	No
Drivers	form	int	No

**DispatchPayPlanView** Parameters:
Name	Parameter	Data Type	Required
DispatchPayPlanID	form	int	No
Name	form	string	No
Basis	form	string	No
Rate	form	decimal	No
Rate2	form	decimal?	No
EffectiveDate	form	DateTime?	No
IsActive	form	bool	No
Drivers	form	int	No

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/rates HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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>