| POST,OPTIONS | /v1/dispatch/message |
|---|
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 DispatchActionResponse
Public Overridable Property Board As DispatchBoardView
Public Overridable Property Message As String
Public Overridable Property Sent As Integer
Public Overridable Property Failed As Integer
Public Overridable Property TicketCode As String
Public Overridable Property TicketNet As Decimal
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class DispatchAutopilotView
Public Overridable Property IsOn As Boolean
Public Overridable Property RuleSlot As Boolean
Public Overridable Property RuleRoute As Boolean
Public Overridable Property RuleRelease As Boolean
Public Overridable Property RuleTract As Boolean
Public Overridable Property RuleThrottle As Boolean
Public Overridable Property RuleOffline As Boolean
Public Overridable Property ThStaged As Integer
Public Overridable Property ThWait As Integer
Public Overridable Property ThBand As Integer
Public Overridable Property ThStall As Integer
Public Overridable Property ThFeed As Integer
End Class
Public Partial Class DispatchBoardView
Public Overridable Property Pack As DispatchPackConfigView
Public Overridable Property Config As DispatchHaulConfigView
Public Overridable Property OfflineWindows As List(Of DispatchOfflineWindowView) = New List(Of DispatchOfflineWindowView)
Public Overridable Property Suppliers As List(Of DispatchSupplierView) = New List(Of DispatchSupplierView)
Public Overridable Property Trucks As List(Of DispatchTruckView) = New List(Of DispatchTruckView)
Public Overridable Property Slots As List(Of DispatchSlotView) = New List(Of DispatchSlotView)
Public Overridable Property Tickets As List(Of DispatchTicketView) = New List(Of DispatchTicketView)
Public Overridable Property Log As List(Of DispatchLogView) = New List(Of DispatchLogView)
Public Overridable Property Autopilot As DispatchAutopilotView
Public Overridable Property Exceptions As List(Of DispatchExceptionView) = New List(Of DispatchExceptionView)
Public Overridable Property Feed As List(Of DispatchFeedView) = New List(Of DispatchFeedView)
Public Overridable Property Rigs As List(Of DispatchRigView) = New List(Of DispatchRigView)
Public Overridable Property Jobs As List(Of DispatchJobView) = New List(Of DispatchJobView)
Public Overridable Property OdDrivers As List(Of DispatchOdDriverView) = New List(Of DispatchOdDriverView)
Public Overridable Property OdRequests As List(Of DispatchOdRequestView) = New List(Of DispatchOdRequestView)
Public Overridable Property Packs As List(Of DispatchPackView) = New List(Of DispatchPackView)
Public Overridable Property PackTerms As List(Of DispatchPackTermView) = New List(Of DispatchPackTermView)
Public Overridable Property PackUnits As List(Of DispatchPackUnitView) = New List(Of DispatchPackUnitView)
End Class
Public Partial Class DispatchExceptionView
Public Overridable Property Code As String
Public Overridable Property Kind As String
Public Overridable Property Severity As String
Public Overridable Property TruckCode As String
Public Overridable Property SupplierCode As String
Public Overridable Property RaisedAt As Date
Public Overridable Property RaisedLabel As String
Public Overridable Property MinsAgo As Integer
End Class
Public Partial Class DispatchFeedView
Public Overridable Property FeedId As Integer
Public Overridable Property EntryAt As Date
Public Overridable Property EntryLabel As String
Public Overridable Property Channel As String
Public Overridable Property Kind As String
Public Overridable Property TruckCode As String
Public Overridable Property SupplierCode As String
Public Overridable Property OverrideText As String
Public Overridable Property MinsAgo As Integer
End Class
Public Partial Class DispatchHaulConfigView
Public Overridable Property QueueMax As Integer
Public Overridable Property DumpBays As Integer
Public Overridable Property SlotCap As Integer
Public Overridable Property Paused As Boolean
Public Overridable Property FeedRate As Integer
End Class
Public Partial Class DispatchJobView
Public Overridable Property JobId As Integer
Public Overridable Property Code As String
Public Overridable Property Cargo As String
Public Overridable Property Customer As String
Public Overridable Property CustomerPhone As String
Public Overridable Property HoldContact As String
Public Overridable Property HoldPhone As String
Public Overridable Property FromLoc As String
Public Overridable Property ToLoc As String
Public Overridable Property Miles As Integer
Public Overridable Property WindowText As String
Public Overridable Property Stage As String
Public Overridable Property Rate As Decimal?
Public Overridable Property RequiredRig As String
Public Overridable Property DriverLabel As String
Public Overridable Property EtaText As String
Public Overridable Property OfferRigIds As String
Public Overridable Property OfferExpiresMin As Integer?
Public Overridable Property OfferExpired As Boolean
Public Overridable Property Declined As Boolean
End Class
Public Partial Class DispatchLogView
Public Overridable Property LogId As Integer
Public Overridable Property LoggedAt As Date
Public Overridable Property LoggedMin As Integer
Public Overridable Property LogText As String
Public Overridable Property Kind As String
Public Overridable Property MinsAgo As Integer
End Class
Public Partial Class DispatchMessageRequest
Public Overridable Property TruckCodes As String
Public Overridable Property Phones As String
Public Overridable Property Body As String
Public Overridable Property Channel As String
Public Overridable Property Label As String
Public Overridable Property AtMin As Integer
End Class
Public Partial Class DispatchOdDriverView
Public Overridable Property DriverId As Integer
Public Overridable Property Code As String
Public Overridable Property Name As String
Public Overridable Property Zone As String
Public Overridable Property Phone As String
Public Overridable Property Status As String
Public Overridable Property Tier As String
Public Overridable Property DistanceMi As Decimal
Public Overridable Property Capabilities As String
End Class
Public Partial Class DispatchOdRequestView
Public Overridable Property RequestId As Integer
Public Overridable Property Code As String
Public Overridable Property Address As String
Public Overridable Property Zone As String
Public Overridable Property Bags As Integer
Public Overridable Property Stage As String
Public Overridable Property DriverCode As String
Public Overridable Property Needs As String
Public Overridable Property Note As String
Public Overridable Property PingExpiresMin As Integer?
Public Overridable Property TriedCodes As String
Public Overridable Property CandidateCodes As String
Public Overridable Property EtaText As String
Public Overridable Property NoDriver As String
End Class
Public Partial Class DispatchOfflineWindowView
Public Overridable Property OfflineWindowId As Integer
Public Overridable Property FromHour As String
Public Overridable Property ToHour As String
End Class
Public Partial Class DispatchPackConfigView
Public Overridable Property PackId As String
Public Overridable Property HasQuotas As Boolean
Public Overridable Property IsInverted As Boolean
Public Overridable Property LoadLimitMins As Integer
Public Overridable Property TicketSource As String
Public Overridable Property PayBasis As String
Public Overridable Property DayBoundary As String
End Class
Public Partial Class DispatchPackTermView
Public Overridable Property PackId As String
Public Overridable Property Lang As String
Public Overridable Property ModeName As String
Public Overridable Property Facility As String
Public Overridable Property FacilityShort As String
Public Overridable Property SourceSite As String
Public Overridable Property Supplier As String
Public Overridable Property SupplierPlural As String
Public Overridable Property UnloadVerb As String
Public Overridable Property TicketNoun As String
Public Overridable Property DayNoun As String
Public Overridable Property FleetLabel As String
Public Overridable Property PageSubtitle As String
Public Overridable Property SeasonChip As String
Public Overridable Property CampaignNoun As String
Public Overridable Property BayNoun As String
Public Overridable Property AssignTarget As String
End Class
Public Partial Class DispatchPackUnitView
Public Overridable Property PackId As String
Public Overridable Property Unit As String
Public Overridable Property LoadQty As Decimal
Public Overridable Property VolumeLow As Integer
Public Overridable Property VolumeHigh As Integer
Public Overridable Property SeasonMultiple As Decimal
Public Overridable Property WeeklyFraction As Decimal
End Class
Public Partial Class DispatchPackView
Public Overridable Property PackId As String
Public Overridable Property HasQuotas As Boolean
Public Overridable Property IsInverted As Boolean
Public Overridable Property LoadLimitMins As Integer
Public Overridable Property DayBoundary As String
Public Overridable Property TicketSource As String
Public Overridable Property PayBasis As String
Public Overridable Property SortOrder As Integer
End Class
Public Partial Class DispatchRigView
Public Overridable Property RigId As Integer
Public Overridable Property Code As String
Public Overridable Property Name As String
Public Overridable Property DriverName As String
Public Overridable Property Phone As String
Public Overridable Property RigType As String
Public Overridable Property IsFree As Boolean
Public Overridable Property MatchRank As Integer
End Class
Public Partial Class DispatchSiteView
Public Overridable Property SiteId As Integer
Public Overridable Property SupplierId As Integer
Public Overridable Property SupplierCode As String
Public Overridable Property Name As String
Public Overridable Property Acres As Integer
Public Overridable Property StandingVolume As Decimal
Public Overridable Property SortOrder As Integer
End Class
Public Partial Class DispatchSlotView
Public Overridable Property SlotId As Integer
Public Overridable Property Hour As String
Public Overridable Property BaseBooked As Integer
Public Overridable Property SortOrder As Integer
End Class
Public Partial Class DispatchSupplierView
Public Overridable Property SupplierId As Integer
Public Overridable Property Code As String
Public Overridable Property Name As String
Public Overridable Property Region As String
Public Overridable Property OwnHauler As Boolean
Public Overridable Property SeasonAllotment As Decimal
Public Overridable Property Delivered As Decimal
Public Overridable Property WeekCap As Decimal
Public Overridable Property WeekDelivered As Decimal
Public Overridable Property SortOrder As Integer
Public Overridable Property Sites As List(Of DispatchSiteView) = New List(Of DispatchSiteView)
End Class
Public Partial Class DispatchTicketView
Public Overridable Property TicketId As Integer
Public Overridable Property Code As String
Public Overridable Property TruckCode As String
Public Overridable Property SupplierCode As String
Public Overridable Property NetQty As Decimal
Public Overridable Property TicketedAt As Date
Public Overridable Property TicketedMin As Integer
Public Overridable Property Source As String
Public Overridable Property MinsAgo As Integer
End Class
Public Partial Class DispatchTruckView
Public Overridable Property TruckId As Integer
Public Overridable Property Code As String
Public Overridable Property DriverName As String
Public Overridable Property Phone As String
Public Overridable Property EmployerCode As String
Public Overridable Property SupplierCode As String
Public Overridable Property SiteName As String
Public Overridable Property EstLoad As Decimal
Public Overridable Property Stage As String
Public Overridable Property StageSince As Integer
Public Overridable Property CycleStart As Integer?
Public Overridable Property StageMinsAgo As Integer
Public Overridable Property CycleMinsAgo As Integer?
Public Overridable Property Slot As String
Public Overridable Property LoadsToday As Integer
Public Overridable Property NetToday As Decimal
Public Overridable Property LastPingMins As Integer
Public Overridable Property CycleMins As String
Public Overridable Property IsInteractive As Boolean
Public Overridable Property NextSupplierCode As String
Public Overridable Property NextSiteName As String
End Class
End Namespace
End Namespace
VB.NET DispatchMessageRequest 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/message HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"TruckCodes":"String","Phones":"String","Body":"String","Channel":"String","Label":"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"}}}