| POST,OPTIONS | /v1/dispatch/jobs/{Code}/offer |
|---|
import Foundation
import ServiceStack
public class DispatchJobOfferRequest : Codable
{
public var code:String
public var rigCodes:String
public var expiresMin:Int?
public var clear:Bool
public var atMin:Int
public var note:String
required public init(){}
}
public class DispatchActionResponse : Codable
{
public var board:DispatchBoardView
public var message:String
public var sent:Int
public var failed:Int
public var ticketCode:String
public var ticketNet:Double
public var responseStatus:ResponseStatus
required public init(){}
}
public class DispatchBoardView : Codable
{
public var pack:DispatchPackConfigView
public var config:DispatchHaulConfigView
public var offlineWindows:[DispatchOfflineWindowView] = []
public var suppliers:[DispatchSupplierView] = []
public var trucks:[DispatchTruckView] = []
public var slots:[DispatchSlotView] = []
public var tickets:[DispatchTicketView] = []
public var log:[DispatchLogView] = []
public var autopilot:DispatchAutopilotView
public var exceptions:[DispatchExceptionView] = []
public var feed:[DispatchFeedView] = []
public var rigs:[DispatchRigView] = []
public var jobs:[DispatchJobView] = []
public var odDrivers:[DispatchOdDriverView] = []
public var odRequests:[DispatchOdRequestView] = []
public var packs:[DispatchPackView] = []
public var packTerms:[DispatchPackTermView] = []
public var packUnits:[DispatchPackUnitView] = []
required public init(){}
}
public class DispatchPackConfigView : Codable
{
public var packId:String
public var hasQuotas:Bool
public var isInverted:Bool
public var loadLimitMins:Int
public var ticketSource:String
public var payBasis:String
public var dayBoundary:String
required public init(){}
}
public class DispatchHaulConfigView : Codable
{
public var queueMax:Int
public var dumpBays:Int
public var slotCap:Int
public var paused:Bool
public var feedRate:Int
required public init(){}
}
public class DispatchOfflineWindowView : Codable
{
public var offlineWindowId:Int
public var fromHour:String
public var toHour:String
required public init(){}
}
public class DispatchSupplierView : Codable
{
public var supplierId:Int
public var code:String
public var name:String
public var region:String
public var ownHauler:Bool
public var seasonAllotment:Double
public var delivered:Double
public var weekCap:Double
public var weekDelivered:Double
public var sortOrder:Int
public var sites:[DispatchSiteView] = []
required public init(){}
}
public class DispatchSiteView : Codable
{
public var siteId:Int
public var supplierId:Int
public var supplierCode:String
public var name:String
public var acres:Int
public var standingVolume:Double
public var sortOrder:Int
required public init(){}
}
public class DispatchTruckView : Codable
{
public var truckId:Int
public var code:String
public var driverName:String
public var phone:String
public var employerCode:String
public var supplierCode:String
public var siteName:String
public var estLoad:Double
public var stage:String
public var stageSince:Int
public var cycleStart:Int?
public var stageMinsAgo:Int
public var cycleMinsAgo:Int?
public var slot:String
public var loadsToday:Int
public var netToday:Double
public var lastPingMins:Int
public var cycleMins:String
public var isInteractive:Bool
public var nextSupplierCode:String
public var nextSiteName:String
required public init(){}
}
public class DispatchSlotView : Codable
{
public var slotId:Int
public var hour:String
public var baseBooked:Int
public var sortOrder:Int
required public init(){}
}
public class DispatchTicketView : Codable
{
public var ticketId:Int
public var code:String
public var truckCode:String
public var supplierCode:String
public var netQty:Double
public var ticketedAt:Date
public var ticketedMin:Int
public var source:String
public var minsAgo:Int
required public init(){}
}
public class DispatchLogView : Codable
{
public var logId:Int
public var loggedAt:Date
public var loggedMin:Int
public var logText:String
public var kind:String
public var minsAgo:Int
required public init(){}
}
public class DispatchAutopilotView : Codable
{
public var isOn:Bool
public var ruleSlot:Bool
public var ruleRoute:Bool
public var ruleRelease:Bool
public var ruleTract:Bool
public var ruleThrottle:Bool
public var ruleOffline:Bool
public var thStaged:Int
public var thWait:Int
public var thBand:Int
public var thStall:Int
public var thFeed:Int
required public init(){}
}
public class DispatchExceptionView : Codable
{
public var code:String
public var kind:String
public var severity:String
public var truckCode:String
public var supplierCode:String
public var raisedAt:Date
public var raisedLabel:String
public var minsAgo:Int
required public init(){}
}
public class DispatchFeedView : Codable
{
public var feedId:Int
public var entryAt:Date
public var entryLabel:String
public var channel:String
public var kind:String
public var truckCode:String
public var supplierCode:String
public var overrideText:String
public var minsAgo:Int
required public init(){}
}
public class DispatchRigView : Codable
{
public var rigId:Int
public var code:String
public var name:String
public var driverName:String
public var phone:String
public var rigType:String
public var isFree:Bool
public var matchRank:Int
required public init(){}
}
public class DispatchJobView : Codable
{
public var jobId:Int
public var code:String
public var cargo:String
public var customer:String
public var customerPhone:String
public var holdContact:String
public var holdPhone:String
public var fromLoc:String
public var toLoc:String
public var miles:Int
public var windowText:String
public var stage:String
public var rate:Double?
public var requiredRig:String
public var driverLabel:String
public var etaText:String
public var offerRigIds:String
public var offerExpiresMin:Int?
public var offerExpired:Bool
public var declined:Bool
required public init(){}
}
public class DispatchOdDriverView : Codable
{
public var driverId:Int
public var code:String
public var name:String
public var zone:String
public var phone:String
public var status:String
public var tier:String
public var distanceMi:Double
public var capabilities:String
required public init(){}
}
public class DispatchOdRequestView : Codable
{
public var requestId:Int
public var code:String
public var address:String
public var zone:String
public var bags:Int
public var stage:String
public var driverCode:String
public var needs:String
public var note:String
public var pingExpiresMin:Int?
public var triedCodes:String
public var candidateCodes:String
public var etaText:String
public var noDriver:String
required public init(){}
}
public class DispatchPackView : Codable
{
public var packId:String
public var hasQuotas:Bool
public var isInverted:Bool
public var loadLimitMins:Int
public var dayBoundary:String
public var ticketSource:String
public var payBasis:String
public var sortOrder:Int
required public init(){}
}
public class DispatchPackTermView : Codable
{
public var packId:String
public var lang:String
public var modeName:String
public var facility:String
public var facilityShort:String
public var sourceSite:String
public var supplier:String
public var supplierPlural:String
public var unloadVerb:String
public var ticketNoun:String
public var dayNoun:String
public var fleetLabel:String
public var pageSubtitle:String
public var seasonChip:String
public var campaignNoun:String
public var bayNoun:String
public var assignTarget:String
required public init(){}
}
public class DispatchPackUnitView : Codable
{
public var packId:String
public var unit:String
public var loadQty:Double
public var volumeLow:Int
public var volumeHigh:Int
public var seasonMultiple:Double
public var weeklyFraction:Double
required public init(){}
}
Swift DispatchJobOfferRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/dispatch/jobs/{Code}/offer HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DispatchJobOfferRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AtMin>0</AtMin>
<Clear>false</Clear>
<Code>String</Code>
<ExpiresMin>0</ExpiresMin>
<Note>String</Note>
<RigCodes>String</RigCodes>
</DispatchJobOfferRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DispatchActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Board>
<Autopilot>
<IsOn>false</IsOn>
<RuleOffline>false</RuleOffline>
<RuleRelease>false</RuleRelease>
<RuleRoute>false</RuleRoute>
<RuleSlot>false</RuleSlot>
<RuleThrottle>false</RuleThrottle>
<RuleTract>false</RuleTract>
<ThBand>0</ThBand>
<ThFeed>0</ThFeed>
<ThStaged>0</ThStaged>
<ThStall>0</ThStall>
<ThWait>0</ThWait>
</Autopilot>
<Config>
<DumpBays>0</DumpBays>
<FeedRate>0</FeedRate>
<Paused>false</Paused>
<QueueMax>0</QueueMax>
<SlotCap>0</SlotCap>
</Config>
<Exceptions>
<DispatchExceptionView>
<Code>String</Code>
<Kind>String</Kind>
<MinsAgo>0</MinsAgo>
<RaisedAt>0001-01-01T00:00:00</RaisedAt>
<RaisedLabel>String</RaisedLabel>
<Severity>String</Severity>
<SupplierCode>String</SupplierCode>
<TruckCode>String</TruckCode>
</DispatchExceptionView>
</Exceptions>
<Feed>
<DispatchFeedView>
<Channel>String</Channel>
<EntryAt>0001-01-01T00:00:00</EntryAt>
<EntryLabel>String</EntryLabel>
<FeedId>0</FeedId>
<Kind>String</Kind>
<MinsAgo>0</MinsAgo>
<OverrideText>String</OverrideText>
<SupplierCode>String</SupplierCode>
<TruckCode>String</TruckCode>
</DispatchFeedView>
</Feed>
<Jobs>
<DispatchJobView>
<Cargo>String</Cargo>
<Code>String</Code>
<Customer>String</Customer>
<CustomerPhone>String</CustomerPhone>
<Declined>false</Declined>
<DriverLabel>String</DriverLabel>
<EtaText>String</EtaText>
<FromLoc>String</FromLoc>
<HoldContact>String</HoldContact>
<HoldPhone>String</HoldPhone>
<JobId>0</JobId>
<Miles>0</Miles>
<OfferExpired>false</OfferExpired>
<OfferExpiresMin>0</OfferExpiresMin>
<OfferRigIds>String</OfferRigIds>
<Rate>0</Rate>
<RequiredRig>String</RequiredRig>
<Stage>String</Stage>
<ToLoc>String</ToLoc>
<WindowText>String</WindowText>
</DispatchJobView>
</Jobs>
<Log>
<DispatchLogView>
<Kind>String</Kind>
<LogId>0</LogId>
<LogText>String</LogText>
<LoggedAt>0001-01-01T00:00:00</LoggedAt>
<LoggedMin>0</LoggedMin>
<MinsAgo>0</MinsAgo>
</DispatchLogView>
</Log>
<OdDrivers>
<DispatchOdDriverView>
<Capabilities>String</Capabilities>
<Code>String</Code>
<DistanceMi>0</DistanceMi>
<DriverId>0</DriverId>
<Name>String</Name>
<Phone>String</Phone>
<Status>String</Status>
<Tier>String</Tier>
<Zone>String</Zone>
</DispatchOdDriverView>
</OdDrivers>
<OdRequests>
<DispatchOdRequestView>
<Address>String</Address>
<Bags>0</Bags>
<CandidateCodes>String</CandidateCodes>
<Code>String</Code>
<DriverCode>String</DriverCode>
<EtaText>String</EtaText>
<Needs>String</Needs>
<NoDriver>String</NoDriver>
<Note>String</Note>
<PingExpiresMin>0</PingExpiresMin>
<RequestId>0</RequestId>
<Stage>String</Stage>
<TriedCodes>String</TriedCodes>
<Zone>String</Zone>
</DispatchOdRequestView>
</OdRequests>
<OfflineWindows>
<DispatchOfflineWindowView>
<FromHour>String</FromHour>
<OfflineWindowId>0</OfflineWindowId>
<ToHour>String</ToHour>
</DispatchOfflineWindowView>
</OfflineWindows>
<Pack>
<DayBoundary>String</DayBoundary>
<HasQuotas>false</HasQuotas>
<IsInverted>false</IsInverted>
<LoadLimitMins>0</LoadLimitMins>
<PackId>String</PackId>
<PayBasis>String</PayBasis>
<TicketSource>String</TicketSource>
</Pack>
<PackTerms>
<DispatchPackTermView>
<AssignTarget>String</AssignTarget>
<BayNoun>String</BayNoun>
<CampaignNoun>String</CampaignNoun>
<DayNoun>String</DayNoun>
<Facility>String</Facility>
<FacilityShort>String</FacilityShort>
<FleetLabel>String</FleetLabel>
<Lang>String</Lang>
<ModeName>String</ModeName>
<PackId>String</PackId>
<PageSubtitle>String</PageSubtitle>
<SeasonChip>String</SeasonChip>
<SourceSite>String</SourceSite>
<Supplier>String</Supplier>
<SupplierPlural>String</SupplierPlural>
<TicketNoun>String</TicketNoun>
<UnloadVerb>String</UnloadVerb>
</DispatchPackTermView>
</PackTerms>
<PackUnits>
<DispatchPackUnitView>
<LoadQty>0</LoadQty>
<PackId>String</PackId>
<SeasonMultiple>0</SeasonMultiple>
<Unit>String</Unit>
<VolumeHigh>0</VolumeHigh>
<VolumeLow>0</VolumeLow>
<WeeklyFraction>0</WeeklyFraction>
</DispatchPackUnitView>
</PackUnits>
<Packs>
<DispatchPackView>
<DayBoundary>String</DayBoundary>
<HasQuotas>false</HasQuotas>
<IsInverted>false</IsInverted>
<LoadLimitMins>0</LoadLimitMins>
<PackId>String</PackId>
<PayBasis>String</PayBasis>
<SortOrder>0</SortOrder>
<TicketSource>String</TicketSource>
</DispatchPackView>
</Packs>
<Rigs>
<DispatchRigView>
<Code>String</Code>
<DriverName>String</DriverName>
<IsFree>false</IsFree>
<MatchRank>0</MatchRank>
<Name>String</Name>
<Phone>String</Phone>
<RigId>0</RigId>
<RigType>String</RigType>
</DispatchRigView>
</Rigs>
<Slots>
<DispatchSlotView>
<BaseBooked>0</BaseBooked>
<Hour>String</Hour>
<SlotId>0</SlotId>
<SortOrder>0</SortOrder>
</DispatchSlotView>
</Slots>
<Suppliers>
<DispatchSupplierView>
<Code>String</Code>
<Delivered>0</Delivered>
<Name>String</Name>
<OwnHauler>false</OwnHauler>
<Region>String</Region>
<SeasonAllotment>0</SeasonAllotment>
<Sites>
<DispatchSiteView>
<Acres>0</Acres>
<Name>String</Name>
<SiteId>0</SiteId>
<SortOrder>0</SortOrder>
<StandingVolume>0</StandingVolume>
<SupplierCode>String</SupplierCode>
<SupplierId>0</SupplierId>
</DispatchSiteView>
</Sites>
<SortOrder>0</SortOrder>
<SupplierId>0</SupplierId>
<WeekCap>0</WeekCap>
<WeekDelivered>0</WeekDelivered>
</DispatchSupplierView>
</Suppliers>
<Tickets>
<DispatchTicketView>
<Code>String</Code>
<MinsAgo>0</MinsAgo>
<NetQty>0</NetQty>
<Source>String</Source>
<SupplierCode>String</SupplierCode>
<TicketId>0</TicketId>
<TicketedAt>0001-01-01T00:00:00</TicketedAt>
<TicketedMin>0</TicketedMin>
<TruckCode>String</TruckCode>
</DispatchTicketView>
</Tickets>
<Trucks>
<DispatchTruckView>
<Code>String</Code>
<CycleMins>String</CycleMins>
<CycleMinsAgo>0</CycleMinsAgo>
<CycleStart>0</CycleStart>
<DriverName>String</DriverName>
<EmployerCode>String</EmployerCode>
<EstLoad>0</EstLoad>
<IsInteractive>false</IsInteractive>
<LastPingMins>0</LastPingMins>
<LoadsToday>0</LoadsToday>
<NetToday>0</NetToday>
<NextSiteName>String</NextSiteName>
<NextSupplierCode>String</NextSupplierCode>
<Phone>String</Phone>
<SiteName>String</SiteName>
<Slot>String</Slot>
<Stage>String</Stage>
<StageMinsAgo>0</StageMinsAgo>
<StageSince>0</StageSince>
<SupplierCode>String</SupplierCode>
<TruckId>0</TruckId>
</DispatchTruckView>
</Trucks>
</Board>
<Failed>0</Failed>
<Message>String</Message>
<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>
<Sent>0</Sent>
<TicketCode>String</TicketCode>
<TicketNet>0</TicketNet>
</DispatchActionResponse>