Trendsic Platform Service

<back to all web services

DispatchPayPlanSaveRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/rates/plan
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DispatchLaneRateView
            Public Overridable Property DispatchSiteID As Integer?
            Public Overridable Property DispatchSupplierID As Integer?
            Public Overridable Property SourceLabel As String
            Public Overridable Property SupplierName As String
            Public Overridable Property DispatchLaneRateID As Integer?
            Public Overridable Property Miles As Decimal?
            Public Overridable Property RatePerTon As Decimal?
            Public Overridable Property RatePerLoad As Decimal?
            Public Overridable Property RatePerTonMile As Decimal?
            Public Overridable Property RatePerHour As Decimal?
        End Class

        Public Partial Class DispatchPayPlanSaveRequest
            Public Overridable Property Plan As DispatchPayPlanView
        End Class

        Public Partial Class DispatchPayPlanView
            Public Overridable Property DispatchPayPlanID As Integer
            Public Overridable Property Name As String
            Public Overridable Property Basis As String
            Public Overridable Property Rate As Decimal
            Public Overridable Property Rate2 As Decimal?
            Public Overridable Property EffectiveDate As Date?
            Public Overridable Property IsActive As Boolean
            Public Overridable Property Drivers As Integer
        End Class

        Public Partial Class DispatchRateConfigView
            Public Overridable Property FuelSurchargePct As Decimal
            Public Overridable Property TransportPerMile As Decimal
            Public Overridable Property TransportJobMin As Decimal
            Public Overridable Property TransportEnclosedUpliftPct As Decimal
            Public Overridable Property OdBase As Decimal
            Public Overridable Property OdPerBag As Decimal
            Public Overridable Property OdPremiumUpliftPct As Decimal
            Public Overridable Property HaulBasis As String
            Public Overridable Property Facility As String
            Public Overridable Property Unit As String
            Public Overridable Property LoadQty As Decimal
        End Class

        Public Partial Class DispatchRatesResponse
            Public Overridable Property Config As DispatchRateConfigView
            Public Overridable Property Lanes As List(Of DispatchLaneRateView) = New List(Of DispatchLaneRateView)
            Public Overridable Property Zones As List(Of DispatchZoneRateView) = New List(Of DispatchZoneRateView)
            Public Overridable Property Plans As List(Of DispatchPayPlanView) = New List(Of DispatchPayPlanView)
            Public Overridable Property Repriced As Integer?
            Public Overridable Property StillNoRevenue As Integer?
            Public Overridable Property StillNoPay As Integer?
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class DispatchZoneRateView
            Public Overridable Property Zone As String
            Public Overridable Property DispatchZoneRateID As Integer?
            Public Overridable Property Base As Decimal?
            Public Overridable Property PerBag As Decimal?
            Public Overridable Property PremiumUpliftPct As Decimal?
            Public Overridable Property Drivers As Integer
        End Class
    End Namespace
End Namespace

VB.NET DispatchPayPlanSaveRequest 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/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>