| POST,OPTIONS | /v1/dispatch/courier/runs |
|---|
import Foundation
import ServiceStack
public class CourierRunBuildRequest : Codable
{
public var profileId:Int
public var facilityCode:String
public var codes:[String] = []
public var driverContactId:Int?
public var equipmentID:Int?
required public init(){}
}
public class CourierRunResponse : Codable
{
public var runs:[CourierRunView] = []
public var run:CourierRunView
public var message:String
public var responseStatus:ResponseStatus
required public init(){}
}
public class CourierRunView : Codable
{
public var courierRunID:Int
public var code:String
public var status:String
public var courierProfileId:Int
public var profileName:String
public var courierFacilityId:Int
public var facilityName:String
public var facilityAddress:String
public var driverContactId:Int?
public var driverName:String
public var equipmentID:Int?
public var vehicleUnit:String
public var unitOne:String
public var unitMany:String
public var units:Int
public var stopCount:Int
public var stopsDone:Int
public var pay:Double?
public var builtUtc:Date?
public var startedUtc:Date?
public var completedUtc:Date?
public var toLoad:Int
public var toReturn:Int
public var stops:[CourierStopView] = []
required public init(){}
}
public class CourierStopView : Codable
{
public var sequence:Int
public var status:String
public var dispatchOdRequestID:Int
public var code:String
public var courierStep:String
public var address:String
public var unit:String
public var city:String
public var zip:String
public var lat:Double?
public var lng:Double?
public var customerName:String
public var customerPhone:String
public var handoff:String
public var gateCode:String
public var instructions:String
public var units:Int
public var dueText:String
public var note:String
public var needs:[String] = []
public var items:[CourierItemView] = []
required public init(){}
}
public class CourierItemView : Codable
{
public var courierItemID:Int
public var dispatchOdRequestID:Int
public var seq:Int
public var tagCode:String
public var custody:String
public var isOpen:Bool
public var isMissing:Bool
public var missingReason:String
public var isManual:Bool
public var reTagFlag:Bool
public var scanned:Bool
required public init(){}
}
Swift CourierRunBuildRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/dispatch/courier/runs HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ProfileId":0,"FacilityCode":"String","Codes":["String"],"DriverContactId":0,"EquipmentID":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Runs":[{"CourierRunID":0,"Code":"String","Status":"String","CourierProfileId":0,"ProfileName":"String","CourierFacilityId":0,"FacilityName":"String","FacilityAddress":"String","DriverContactId":0,"DriverName":"String","EquipmentID":0,"VehicleUnit":"String","UnitOne":"String","UnitMany":"String","Units":0,"StopCount":0,"StopsDone":0,"Pay":0,"BuiltUtc":"0001-01-01T00:00:00.0000000","StartedUtc":"0001-01-01T00:00:00.0000000","CompletedUtc":"0001-01-01T00:00:00.0000000","ToLoad":0,"ToReturn":0,"Stops":[{"Sequence":0,"Status":"String","DispatchOdRequestID":0,"Code":"String","CourierStep":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","Units":0,"DueText":"String","Note":"String","Needs":["String"],"Items":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}]}]}],"Run":{"CourierRunID":0,"Code":"String","Status":"String","CourierProfileId":0,"ProfileName":"String","CourierFacilityId":0,"FacilityName":"String","FacilityAddress":"String","DriverContactId":0,"DriverName":"String","EquipmentID":0,"VehicleUnit":"String","UnitOne":"String","UnitMany":"String","Units":0,"StopCount":0,"StopsDone":0,"Pay":0,"BuiltUtc":"0001-01-01T00:00:00.0000000","StartedUtc":"0001-01-01T00:00:00.0000000","CompletedUtc":"0001-01-01T00:00:00.0000000","ToLoad":0,"ToReturn":0,"Stops":[{"Sequence":0,"Status":"String","DispatchOdRequestID":0,"Code":"String","CourierStep":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","Units":0,"DueText":"String","Note":"String","Needs":["String"],"Items":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}]}]},"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}