Trendsic Platform Service

<back to all web services

DispatchQuotaRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/haul/suppliers/{SupplierCode}/quota
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 DispatchActionResponse
    {
        public virtual DispatchBoardView Board { get; set; }
        public virtual string Message { get; set; }
        public virtual int Sent { get; set; }
        public virtual int Failed { get; set; }
        public virtual string TicketCode { get; set; }
        public virtual decimal TicketNet { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DispatchAutopilotView
    {
        public virtual bool IsOn { get; set; }
        public virtual bool RuleSlot { get; set; }
        public virtual bool RuleRoute { get; set; }
        public virtual bool RuleRelease { get; set; }
        public virtual bool RuleTract { get; set; }
        public virtual bool RuleThrottle { get; set; }
        public virtual bool RuleOffline { get; set; }
        public virtual int ThStaged { get; set; }
        public virtual int ThWait { get; set; }
        public virtual int ThBand { get; set; }
        public virtual int ThStall { get; set; }
        public virtual int ThFeed { get; set; }
    }

    public partial class DispatchBoardView
    {
        public virtual DispatchPackConfigView Pack { get; set; }
        public virtual DispatchHaulConfigView Config { get; set; }
        public virtual List<DispatchOfflineWindowView> OfflineWindows { get; set; } = [];
        public virtual List<DispatchSupplierView> Suppliers { get; set; } = [];
        public virtual List<DispatchTruckView> Trucks { get; set; } = [];
        public virtual List<DispatchSlotView> Slots { get; set; } = [];
        public virtual List<DispatchTicketView> Tickets { get; set; } = [];
        public virtual List<DispatchLogView> Log { get; set; } = [];
        public virtual DispatchAutopilotView Autopilot { get; set; }
        public virtual List<DispatchExceptionView> Exceptions { get; set; } = [];
        public virtual List<DispatchFeedView> Feed { get; set; } = [];
        public virtual List<DispatchRigView> Rigs { get; set; } = [];
        public virtual List<DispatchJobView> Jobs { get; set; } = [];
        public virtual List<DispatchOdDriverView> OdDrivers { get; set; } = [];
        public virtual List<DispatchOdRequestView> OdRequests { get; set; } = [];
        public virtual List<DispatchPackView> Packs { get; set; } = [];
        public virtual List<DispatchPackTermView> PackTerms { get; set; } = [];
        public virtual List<DispatchPackUnitView> PackUnits { get; set; } = [];
    }

    public partial class DispatchExceptionView
    {
        public virtual string Code { get; set; }
        public virtual string Kind { get; set; }
        public virtual string Severity { get; set; }
        public virtual string TruckCode { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual DateTime RaisedAt { get; set; }
        public virtual string RaisedLabel { get; set; }
        public virtual int MinsAgo { get; set; }
    }

    public partial class DispatchFeedView
    {
        public virtual int FeedId { get; set; }
        public virtual DateTime EntryAt { get; set; }
        public virtual string EntryLabel { get; set; }
        public virtual string Channel { get; set; }
        public virtual string Kind { get; set; }
        public virtual string TruckCode { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual string OverrideText { get; set; }
        public virtual int MinsAgo { get; set; }
    }

    public partial class DispatchHaulConfigView
    {
        public virtual int QueueMax { get; set; }
        public virtual int DumpBays { get; set; }
        public virtual int SlotCap { get; set; }
        public virtual bool Paused { get; set; }
        public virtual int FeedRate { get; set; }
    }

    public partial class DispatchJobView
    {
        public virtual int JobId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Cargo { get; set; }
        public virtual string Customer { get; set; }
        public virtual string CustomerPhone { get; set; }
        public virtual string HoldContact { get; set; }
        public virtual string HoldPhone { get; set; }
        public virtual string FromLoc { get; set; }
        public virtual string ToLoc { get; set; }
        public virtual int Miles { get; set; }
        public virtual string WindowText { get; set; }
        public virtual string Stage { get; set; }
        public virtual decimal? Rate { get; set; }
        public virtual string RequiredRig { get; set; }
        public virtual string DriverLabel { get; set; }
        public virtual string EtaText { get; set; }
        public virtual string OfferRigIds { get; set; }
        public virtual int? OfferExpiresMin { get; set; }
        public virtual bool OfferExpired { get; set; }
        public virtual bool Declined { get; set; }
    }

    public partial class DispatchLogView
    {
        public virtual int LogId { get; set; }
        public virtual DateTime LoggedAt { get; set; }
        public virtual int LoggedMin { get; set; }
        public virtual string LogText { get; set; }
        public virtual string Kind { get; set; }
        public virtual int MinsAgo { get; set; }
    }

    public partial class DispatchOdDriverView
    {
        public virtual int DriverId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Zone { get; set; }
        public virtual string Phone { get; set; }
        public virtual string Status { get; set; }
        public virtual string Tier { get; set; }
        public virtual decimal DistanceMi { get; set; }
        public virtual string Capabilities { get; set; }
    }

    public partial class DispatchOdRequestView
    {
        public virtual int RequestId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Address { get; set; }
        public virtual string Zone { get; set; }
        public virtual int Bags { get; set; }
        public virtual string Stage { get; set; }
        public virtual string DriverCode { get; set; }
        public virtual string Needs { get; set; }
        public virtual string Note { get; set; }
        public virtual int? PingExpiresMin { get; set; }
        public virtual string TriedCodes { get; set; }
        public virtual string CandidateCodes { get; set; }
        public virtual string EtaText { get; set; }
        public virtual string NoDriver { get; set; }
    }

    public partial class DispatchOfflineWindowView
    {
        public virtual int OfflineWindowId { get; set; }
        public virtual string FromHour { get; set; }
        public virtual string ToHour { get; set; }
    }

    public partial class DispatchPackConfigView
    {
        public virtual string PackId { get; set; }
        public virtual bool HasQuotas { get; set; }
        public virtual bool IsInverted { get; set; }
        public virtual int LoadLimitMins { get; set; }
        public virtual string TicketSource { get; set; }
        public virtual string PayBasis { get; set; }
        public virtual string DayBoundary { get; set; }
    }

    public partial class DispatchPackTermView
    {
        public virtual string PackId { get; set; }
        public virtual string Lang { get; set; }
        public virtual string ModeName { get; set; }
        public virtual string Facility { get; set; }
        public virtual string FacilityShort { get; set; }
        public virtual string SourceSite { get; set; }
        public virtual string Supplier { get; set; }
        public virtual string SupplierPlural { get; set; }
        public virtual string UnloadVerb { get; set; }
        public virtual string TicketNoun { get; set; }
        public virtual string DayNoun { get; set; }
        public virtual string FleetLabel { get; set; }
        public virtual string PageSubtitle { get; set; }
        public virtual string SeasonChip { get; set; }
        public virtual string CampaignNoun { get; set; }
        public virtual string BayNoun { get; set; }
        public virtual string AssignTarget { get; set; }
    }

    public partial class DispatchPackUnitView
    {
        public virtual string PackId { get; set; }
        public virtual string Unit { get; set; }
        public virtual decimal LoadQty { get; set; }
        public virtual int VolumeLow { get; set; }
        public virtual int VolumeHigh { get; set; }
        public virtual decimal SeasonMultiple { get; set; }
        public virtual decimal WeeklyFraction { get; set; }
    }

    public partial class DispatchPackView
    {
        public virtual string PackId { get; set; }
        public virtual bool HasQuotas { get; set; }
        public virtual bool IsInverted { get; set; }
        public virtual int LoadLimitMins { get; set; }
        public virtual string DayBoundary { get; set; }
        public virtual string TicketSource { get; set; }
        public virtual string PayBasis { get; set; }
        public virtual int SortOrder { get; set; }
    }

    public partial class DispatchQuotaRequest
    {
        public virtual string SupplierCode { get; set; }
        public virtual decimal WeekCapDelta { get; set; }
        public virtual string Note { get; set; }
        public virtual int AtMin { get; set; }
    }

    public partial class DispatchRigView
    {
        public virtual int RigId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string DriverName { get; set; }
        public virtual string Phone { get; set; }
        public virtual string RigType { get; set; }
        public virtual bool IsFree { get; set; }
        public virtual int MatchRank { get; set; }
    }

    public partial class DispatchSiteView
    {
        public virtual int SiteId { get; set; }
        public virtual int SupplierId { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual string Name { get; set; }
        public virtual int Acres { get; set; }
        public virtual decimal StandingVolume { get; set; }
        public virtual int SortOrder { get; set; }
    }

    public partial class DispatchSlotView
    {
        public virtual int SlotId { get; set; }
        public virtual string Hour { get; set; }
        public virtual int BaseBooked { get; set; }
        public virtual int SortOrder { get; set; }
    }

    public partial class DispatchSupplierView
    {
        public virtual int SupplierId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Region { get; set; }
        public virtual bool OwnHauler { get; set; }
        public virtual decimal SeasonAllotment { get; set; }
        public virtual decimal Delivered { get; set; }
        public virtual decimal WeekCap { get; set; }
        public virtual decimal WeekDelivered { get; set; }
        public virtual int SortOrder { get; set; }
        public virtual List<DispatchSiteView> Sites { get; set; } = [];
    }

    public partial class DispatchTicketView
    {
        public virtual int TicketId { get; set; }
        public virtual string Code { get; set; }
        public virtual string TruckCode { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual decimal NetQty { get; set; }
        public virtual DateTime TicketedAt { get; set; }
        public virtual int TicketedMin { get; set; }
        public virtual string Source { get; set; }
        public virtual int MinsAgo { get; set; }
    }

    public partial class DispatchTruckView
    {
        public virtual int TruckId { get; set; }
        public virtual string Code { get; set; }
        public virtual string DriverName { get; set; }
        public virtual string Phone { get; set; }
        public virtual string EmployerCode { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual string SiteName { get; set; }
        public virtual decimal EstLoad { get; set; }
        public virtual string Stage { get; set; }
        public virtual int StageSince { get; set; }
        public virtual int? CycleStart { get; set; }
        public virtual int StageMinsAgo { get; set; }
        public virtual int? CycleMinsAgo { get; set; }
        public virtual string Slot { get; set; }
        public virtual int LoadsToday { get; set; }
        public virtual decimal NetToday { get; set; }
        public virtual int LastPingMins { get; set; }
        public virtual string CycleMins { get; set; }
        public virtual bool IsInteractive { get; set; }
        public virtual string NextSupplierCode { get; set; }
        public virtual string NextSiteName { get; set; }
    }

}

C# DispatchQuotaRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dispatch/haul/suppliers/{SupplierCode}/quota HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SupplierCode":"String","WeekCapDelta":0,"Note":"String","AtMin":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Board":{"Pack":{"PackId":"String","HasQuotas":false,"IsInverted":false,"LoadLimitMins":0,"TicketSource":"String","PayBasis":"String","DayBoundary":"String"},"Config":{"QueueMax":0,"DumpBays":0,"SlotCap":0,"Paused":false,"FeedRate":0},"OfflineWindows":[{"OfflineWindowId":0,"FromHour":"String","ToHour":"String"}],"Suppliers":[{"SupplierId":0,"Code":"String","Name":"String","Region":"String","OwnHauler":false,"SeasonAllotment":0,"Delivered":0,"WeekCap":0,"WeekDelivered":0,"SortOrder":0,"Sites":[{"SiteId":0,"SupplierId":0,"SupplierCode":"String","Name":"String","Acres":0,"StandingVolume":0,"SortOrder":0}]}],"Trucks":[{"TruckId":0,"Code":"String","DriverName":"String","Phone":"String","EmployerCode":"String","SupplierCode":"String","SiteName":"String","EstLoad":0,"Stage":"String","StageSince":0,"CycleStart":0,"StageMinsAgo":0,"CycleMinsAgo":0,"Slot":"String","LoadsToday":0,"NetToday":0,"LastPingMins":0,"CycleMins":"String","IsInteractive":false,"NextSupplierCode":"String","NextSiteName":"String"}],"Slots":[{"SlotId":0,"Hour":"String","BaseBooked":0,"SortOrder":0}],"Tickets":[{"TicketId":0,"Code":"String","TruckCode":"String","SupplierCode":"String","NetQty":0,"TicketedAt":"0001-01-01T00:00:00.0000000","TicketedMin":0,"Source":"String","MinsAgo":0}],"Log":[{"LogId":0,"LoggedAt":"0001-01-01T00:00:00.0000000","LoggedMin":0,"LogText":"String","Kind":"String","MinsAgo":0}],"Autopilot":{"IsOn":false,"RuleSlot":false,"RuleRoute":false,"RuleRelease":false,"RuleTract":false,"RuleThrottle":false,"RuleOffline":false,"ThStaged":0,"ThWait":0,"ThBand":0,"ThStall":0,"ThFeed":0},"Exceptions":[{"Code":"String","Kind":"String","Severity":"String","TruckCode":"String","SupplierCode":"String","RaisedAt":"0001-01-01T00:00:00.0000000","RaisedLabel":"String","MinsAgo":0}],"Feed":[{"FeedId":0,"EntryAt":"0001-01-01T00:00:00.0000000","EntryLabel":"String","Channel":"String","Kind":"String","TruckCode":"String","SupplierCode":"String","OverrideText":"String","MinsAgo":0}],"Rigs":[{"RigId":0,"Code":"String","Name":"String","DriverName":"String","Phone":"String","RigType":"String","IsFree":false,"MatchRank":0}],"Jobs":[{"JobId":0,"Code":"String","Cargo":"String","Customer":"String","CustomerPhone":"String","HoldContact":"String","HoldPhone":"String","FromLoc":"String","ToLoc":"String","Miles":0,"WindowText":"String","Stage":"String","Rate":0,"RequiredRig":"String","DriverLabel":"String","EtaText":"String","OfferRigIds":"String","OfferExpiresMin":0,"OfferExpired":false,"Declined":false}],"OdDrivers":[{"DriverId":0,"Code":"String","Name":"String","Zone":"String","Phone":"String","Status":"String","Tier":"String","DistanceMi":0,"Capabilities":"String"}],"OdRequests":[{"RequestId":0,"Code":"String","Address":"String","Zone":"String","Bags":0,"Stage":"String","DriverCode":"String","Needs":"String","Note":"String","PingExpiresMin":0,"TriedCodes":"String","CandidateCodes":"String","EtaText":"String","NoDriver":"String"}],"Packs":[{"PackId":"String","HasQuotas":false,"IsInverted":false,"LoadLimitMins":0,"DayBoundary":"String","TicketSource":"String","PayBasis":"String","SortOrder":0}],"PackTerms":[{"PackId":"String","Lang":"String","ModeName":"String","Facility":"String","FacilityShort":"String","SourceSite":"String","Supplier":"String","SupplierPlural":"String","UnloadVerb":"String","TicketNoun":"String","DayNoun":"String","FleetLabel":"String","PageSubtitle":"String","SeasonChip":"String","CampaignNoun":"String","BayNoun":"String","AssignTarget":"String"}],"PackUnits":[{"PackId":"String","Unit":"String","LoadQty":0,"VolumeLow":0,"VolumeHigh":0,"SeasonMultiple":0,"WeeklyFraction":0}]},"Message":"String","Sent":0,"Failed":0,"TicketCode":"String","TicketNet":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}