| POST,OPTIONS | /v1/dispatch/jobs/{Code}/advance |
|---|
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type DispatchPackConfigView() =
member val PackId:String = null with get,set
member val HasQuotas:Boolean = new Boolean() with get,set
member val IsInverted:Boolean = new Boolean() with get,set
member val LoadLimitMins:Int32 = new Int32() with get,set
member val TicketSource:String = null with get,set
member val PayBasis:String = null with get,set
member val DayBoundary:String = null with get,set
[<AllowNullLiteral>]
type DispatchHaulConfigView() =
member val QueueMax:Int32 = new Int32() with get,set
member val DumpBays:Int32 = new Int32() with get,set
member val SlotCap:Int32 = new Int32() with get,set
member val Paused:Boolean = new Boolean() with get,set
member val FeedRate:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchOfflineWindowView() =
member val OfflineWindowId:Int32 = new Int32() with get,set
member val FromHour:String = null with get,set
member val ToHour:String = null with get,set
[<AllowNullLiteral>]
type DispatchSiteView() =
member val SiteId:Int32 = new Int32() with get,set
member val SupplierId:Int32 = new Int32() with get,set
member val SupplierCode:String = null with get,set
member val Name:String = null with get,set
member val Acres:Int32 = new Int32() with get,set
member val StandingVolume:Decimal = new Decimal() with get,set
member val SortOrder:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchSupplierView() =
member val SupplierId:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val Name:String = null with get,set
member val Region:String = null with get,set
member val OwnHauler:Boolean = new Boolean() with get,set
member val SeasonAllotment:Decimal = new Decimal() with get,set
member val Delivered:Decimal = new Decimal() with get,set
member val WeekCap:Decimal = new Decimal() with get,set
member val WeekDelivered:Decimal = new Decimal() with get,set
member val SortOrder:Int32 = new Int32() with get,set
member val Sites:ResizeArray<DispatchSiteView> = new ResizeArray<DispatchSiteView>() with get,set
[<AllowNullLiteral>]
type DispatchTruckView() =
member val TruckId:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val DriverName:String = null with get,set
member val Phone:String = null with get,set
member val EmployerCode:String = null with get,set
member val SupplierCode:String = null with get,set
member val SiteName:String = null with get,set
member val EstLoad:Decimal = new Decimal() with get,set
member val Stage:String = null with get,set
member val StageSince:Int32 = new Int32() with get,set
member val CycleStart:Nullable<Int32> = new Nullable<Int32>() with get,set
member val StageMinsAgo:Int32 = new Int32() with get,set
member val CycleMinsAgo:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Slot:String = null with get,set
member val LoadsToday:Int32 = new Int32() with get,set
member val NetToday:Decimal = new Decimal() with get,set
member val LastPingMins:Int32 = new Int32() with get,set
member val CycleMins:String = null with get,set
member val IsInteractive:Boolean = new Boolean() with get,set
member val NextSupplierCode:String = null with get,set
member val NextSiteName:String = null with get,set
[<AllowNullLiteral>]
type DispatchSlotView() =
member val SlotId:Int32 = new Int32() with get,set
member val Hour:String = null with get,set
member val BaseBooked:Int32 = new Int32() with get,set
member val SortOrder:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchTicketView() =
member val TicketId:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val TruckCode:String = null with get,set
member val SupplierCode:String = null with get,set
member val NetQty:Decimal = new Decimal() with get,set
member val TicketedAt:DateTime = new DateTime() with get,set
member val TicketedMin:Int32 = new Int32() with get,set
member val Source:String = null with get,set
member val MinsAgo:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchLogView() =
member val LogId:Int32 = new Int32() with get,set
member val LoggedAt:DateTime = new DateTime() with get,set
member val LoggedMin:Int32 = new Int32() with get,set
member val LogText:String = null with get,set
member val Kind:String = null with get,set
member val MinsAgo:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchAutopilotView() =
member val IsOn:Boolean = new Boolean() with get,set
member val RuleSlot:Boolean = new Boolean() with get,set
member val RuleRoute:Boolean = new Boolean() with get,set
member val RuleRelease:Boolean = new Boolean() with get,set
member val RuleTract:Boolean = new Boolean() with get,set
member val RuleThrottle:Boolean = new Boolean() with get,set
member val RuleOffline:Boolean = new Boolean() with get,set
member val ThStaged:Int32 = new Int32() with get,set
member val ThWait:Int32 = new Int32() with get,set
member val ThBand:Int32 = new Int32() with get,set
member val ThStall:Int32 = new Int32() with get,set
member val ThFeed:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchExceptionView() =
member val Code:String = null with get,set
member val Kind:String = null with get,set
member val Severity:String = null with get,set
member val TruckCode:String = null with get,set
member val SupplierCode:String = null with get,set
member val RaisedAt:DateTime = new DateTime() with get,set
member val RaisedLabel:String = null with get,set
member val MinsAgo:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchFeedView() =
member val FeedId:Int32 = new Int32() with get,set
member val EntryAt:DateTime = new DateTime() with get,set
member val EntryLabel:String = null with get,set
member val Channel:String = null with get,set
member val Kind:String = null with get,set
member val TruckCode:String = null with get,set
member val SupplierCode:String = null with get,set
member val OverrideText:String = null with get,set
member val MinsAgo:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchRigView() =
member val RigId:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val Name:String = null with get,set
member val DriverName:String = null with get,set
member val Phone:String = null with get,set
member val RigType:String = null with get,set
member val IsFree:Boolean = new Boolean() with get,set
member val MatchRank:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchJobView() =
member val JobId:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val Cargo:String = null with get,set
member val Customer:String = null with get,set
member val CustomerPhone:String = null with get,set
member val HoldContact:String = null with get,set
member val HoldPhone:String = null with get,set
member val FromLoc:String = null with get,set
member val ToLoc:String = null with get,set
member val Miles:Int32 = new Int32() with get,set
member val WindowText:String = null with get,set
member val Stage:String = null with get,set
member val Rate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val RequiredRig:String = null with get,set
member val DriverLabel:String = null with get,set
member val EtaText:String = null with get,set
member val OfferRigIds:String = null with get,set
member val OfferExpiresMin:Nullable<Int32> = new Nullable<Int32>() with get,set
member val OfferExpired:Boolean = new Boolean() with get,set
member val Declined:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type DispatchOdDriverView() =
member val DriverId:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val Name:String = null with get,set
member val Zone:String = null with get,set
member val Phone:String = null with get,set
member val Status:String = null with get,set
member val Tier:String = null with get,set
member val DistanceMi:Decimal = new Decimal() with get,set
member val Capabilities:String = null with get,set
[<AllowNullLiteral>]
type DispatchOdRequestView() =
member val RequestId:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val Address:String = null with get,set
member val Zone:String = null with get,set
member val Bags:Int32 = new Int32() with get,set
member val Stage:String = null with get,set
member val DriverCode:String = null with get,set
member val Needs:String = null with get,set
member val Note:String = null with get,set
member val PingExpiresMin:Nullable<Int32> = new Nullable<Int32>() with get,set
member val TriedCodes:String = null with get,set
member val CandidateCodes:String = null with get,set
member val EtaText:String = null with get,set
member val NoDriver:String = null with get,set
[<AllowNullLiteral>]
type DispatchPackView() =
member val PackId:String = null with get,set
member val HasQuotas:Boolean = new Boolean() with get,set
member val IsInverted:Boolean = new Boolean() with get,set
member val LoadLimitMins:Int32 = new Int32() with get,set
member val DayBoundary:String = null with get,set
member val TicketSource:String = null with get,set
member val PayBasis:String = null with get,set
member val SortOrder:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type DispatchPackTermView() =
member val PackId:String = null with get,set
member val Lang:String = null with get,set
member val ModeName:String = null with get,set
member val Facility:String = null with get,set
member val FacilityShort:String = null with get,set
member val SourceSite:String = null with get,set
member val Supplier:String = null with get,set
member val SupplierPlural:String = null with get,set
member val UnloadVerb:String = null with get,set
member val TicketNoun:String = null with get,set
member val DayNoun:String = null with get,set
member val FleetLabel:String = null with get,set
member val PageSubtitle:String = null with get,set
member val SeasonChip:String = null with get,set
member val CampaignNoun:String = null with get,set
member val BayNoun:String = null with get,set
member val AssignTarget:String = null with get,set
[<AllowNullLiteral>]
type DispatchPackUnitView() =
member val PackId:String = null with get,set
member val Unit:String = null with get,set
member val LoadQty:Decimal = new Decimal() with get,set
member val VolumeLow:Int32 = new Int32() with get,set
member val VolumeHigh:Int32 = new Int32() with get,set
member val SeasonMultiple:Decimal = new Decimal() with get,set
member val WeeklyFraction:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type DispatchBoardView() =
member val Pack:DispatchPackConfigView = null with get,set
member val Config:DispatchHaulConfigView = null with get,set
member val OfflineWindows:ResizeArray<DispatchOfflineWindowView> = new ResizeArray<DispatchOfflineWindowView>() with get,set
member val Suppliers:ResizeArray<DispatchSupplierView> = new ResizeArray<DispatchSupplierView>() with get,set
member val Trucks:ResizeArray<DispatchTruckView> = new ResizeArray<DispatchTruckView>() with get,set
member val Slots:ResizeArray<DispatchSlotView> = new ResizeArray<DispatchSlotView>() with get,set
member val Tickets:ResizeArray<DispatchTicketView> = new ResizeArray<DispatchTicketView>() with get,set
member val Log:ResizeArray<DispatchLogView> = new ResizeArray<DispatchLogView>() with get,set
member val Autopilot:DispatchAutopilotView = null with get,set
member val Exceptions:ResizeArray<DispatchExceptionView> = new ResizeArray<DispatchExceptionView>() with get,set
member val Feed:ResizeArray<DispatchFeedView> = new ResizeArray<DispatchFeedView>() with get,set
member val Rigs:ResizeArray<DispatchRigView> = new ResizeArray<DispatchRigView>() with get,set
member val Jobs:ResizeArray<DispatchJobView> = new ResizeArray<DispatchJobView>() with get,set
member val OdDrivers:ResizeArray<DispatchOdDriverView> = new ResizeArray<DispatchOdDriverView>() with get,set
member val OdRequests:ResizeArray<DispatchOdRequestView> = new ResizeArray<DispatchOdRequestView>() with get,set
member val Packs:ResizeArray<DispatchPackView> = new ResizeArray<DispatchPackView>() with get,set
member val PackTerms:ResizeArray<DispatchPackTermView> = new ResizeArray<DispatchPackTermView>() with get,set
member val PackUnits:ResizeArray<DispatchPackUnitView> = new ResizeArray<DispatchPackUnitView>() with get,set
[<AllowNullLiteral>]
type DispatchActionResponse() =
member val Board:DispatchBoardView = null with get,set
member val Message:String = null with get,set
member val Sent:Int32 = new Int32() with get,set
member val Failed:Int32 = new Int32() with get,set
member val TicketCode:String = null with get,set
member val TicketNet:Decimal = new Decimal() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type DispatchJobAdvanceRequest() =
member val Code:String = null with get,set
member val ToStage:String = null with get,set
member val DriverLabel:String = null with get,set
member val EtaText:String = null with get,set
member val TakeRigCode:String = null with get,set
member val FreeRigCode:String = null with get,set
member val Declined:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val OfferExpired:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val ClearOffer:Boolean = new Boolean() with get,set
member val Note:String = null with get,set
member val AtMin:Int32 = new Int32() with get,set
F# DispatchJobAdvanceRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/dispatch/jobs/{Code}/advance HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Code":"String","ToStage":"String","DriverLabel":"String","EtaText":"String","TakeRigCode":"String","FreeRigCode":"String","Declined":false,"OfferExpired":false,"ClearOffer":false,"Note":"String","AtMin":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}