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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DispatchLaneRateView
    {
        public virtual int? DispatchSiteID { get; set; }
        public virtual int? DispatchSupplierID { get; set; }
        public virtual string SourceLabel { get; set; }
        public virtual string SupplierName { get; set; }
        public virtual int? DispatchLaneRateID { get; set; }
        public virtual decimal? Miles { get; set; }
        public virtual decimal? RatePerTon { get; set; }
        public virtual decimal? RatePerLoad { get; set; }
        public virtual decimal? RatePerTonMile { get; set; }
        public virtual decimal? RatePerHour { get; set; }
    }

    public partial class DispatchPayPlanSaveRequest
    {
        public virtual DispatchPayPlanView Plan { get; set; }
    }

    public partial class DispatchPayPlanView
    {
        public virtual int DispatchPayPlanID { get; set; }
        public virtual string Name { get; set; }
        public virtual string Basis { get; set; }
        public virtual decimal Rate { get; set; }
        public virtual decimal? Rate2 { get; set; }
        public virtual DateTime? EffectiveDate { get; set; }
        public virtual bool IsActive { get; set; }
        public virtual int Drivers { get; set; }
    }

    public partial class DispatchRateConfigView
    {
        public virtual decimal FuelSurchargePct { get; set; }
        public virtual decimal TransportPerMile { get; set; }
        public virtual decimal TransportJobMin { get; set; }
        public virtual decimal TransportEnclosedUpliftPct { get; set; }
        public virtual decimal OdBase { get; set; }
        public virtual decimal OdPerBag { get; set; }
        public virtual decimal OdPremiumUpliftPct { get; set; }
        public virtual string HaulBasis { get; set; }
        public virtual string Facility { get; set; }
        public virtual string Unit { get; set; }
        public virtual decimal LoadQty { get; set; }
    }

    public partial class DispatchRatesResponse
    {
        public virtual DispatchRateConfigView Config { get; set; }
        public virtual List<DispatchLaneRateView> Lanes { get; set; } = [];
        public virtual List<DispatchZoneRateView> Zones { get; set; } = [];
        public virtual List<DispatchPayPlanView> Plans { get; set; } = [];
        public virtual int? Repriced { get; set; }
        public virtual int? StillNoRevenue { get; set; }
        public virtual int? StillNoPay { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DispatchZoneRateView
    {
        public virtual string Zone { get; set; }
        public virtual int? DispatchZoneRateID { get; set; }
        public virtual decimal? Base { get; set; }
        public virtual decimal? PerBag { get; set; }
        public virtual decimal? PremiumUpliftPct { get; set; }
        public virtual int Drivers { get; set; }
    }

}

C# 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>