| POST,OPTIONS | /v1/dispatch/requests |
|---|
import Foundation
import ServiceStack
public class DispatchRequestCreateRequest : Codable
{
public var customerName:String
public var customerPhone:String
public var customerEmail:String
public var cargo:String
public var units:Int
public var fromLoc:String
public var toLoc:String
public var miles:Int?
public var windowText:String
public var isUrgent:Bool
public var notes:String
required public init(){}
}
public class DispatchRequestsResponse : Codable
{
public var requests:[DispatchRequestView] = []
public var request:DispatchRequestView
public var rigCounts:[DispatchRigCountView] = []
public var carriers:[DispatchCarrierPickView] = []
public var quoteLink:String
public var delivery:String
public var responseStatus:ResponseStatus
required public init(){}
}
public class DispatchRequestView : Codable
{
public var requestId:Int
public var code:String
public var customerName:String
public var customerPhone:String
public var customerEmail:String
public var cargo:String
public var units:Int
public var fromLoc:String
public var toLoc:String
public var miles:Int?
public var windowText:String
public var isUrgent:Bool
public var notes:String
public var source:String
public var status:String
public var requiredRig:String
public var unitsPerTruck:Int?
public var ratePerLoad:Double?
public var urgencyPct:Double
public var costPerLoad:Double?
public var loadsNeeded:Int?
public var quoteTotal:Double?
public var quoteVersion:Int
public var quotedUtc:Date?
public var quotedBy:String
public var acceptTokenExpiresUtc:Date?
public var acceptedUtc:Date?
public var acceptedVia:String
public var declinedUtc:Date?
public var declinedBy:String
public var declineReason:String
public var jobsCreated:Int
public var jobsDone:Int
public var jobsNeedDriver:Int
public var createdUtc:Date
public var createdBy:String
public var events:[DispatchRequestEventView] = []
required public init(){}
}
public class DispatchRequestEventView : Codable
{
public var eventId:Int
public var kind:String
public var detail:String
public var atUtc:Date
public var byWho:String
required public init(){}
}
public class DispatchRigCountView : Codable
{
public var rigType:String
public var rigs:Int
required public init(){}
}
public class DispatchCarrierPickView : Codable
{
public var vendorID:Int
public var vendorName:String
required public init(){}
}
Swift DispatchRequestCreateRequest 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/requests HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DispatchRequestCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Cargo>String</Cargo>
<CustomerEmail>String</CustomerEmail>
<CustomerName>String</CustomerName>
<CustomerPhone>String</CustomerPhone>
<FromLoc>String</FromLoc>
<IsUrgent>false</IsUrgent>
<Miles>0</Miles>
<Notes>String</Notes>
<ToLoc>String</ToLoc>
<Units>0</Units>
<WindowText>String</WindowText>
</DispatchRequestCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DispatchRequestsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Carriers>
<DispatchCarrierPickView>
<VendorID>0</VendorID>
<VendorName>String</VendorName>
</DispatchCarrierPickView>
</Carriers>
<Delivery>String</Delivery>
<QuoteLink>String</QuoteLink>
<Request>
<AcceptTokenExpiresUtc>0001-01-01T00:00:00</AcceptTokenExpiresUtc>
<AcceptedUtc>0001-01-01T00:00:00</AcceptedUtc>
<AcceptedVia>String</AcceptedVia>
<Cargo>String</Cargo>
<Code>String</Code>
<CostPerLoad>0</CostPerLoad>
<CreatedBy>String</CreatedBy>
<CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
<CustomerEmail>String</CustomerEmail>
<CustomerName>String</CustomerName>
<CustomerPhone>String</CustomerPhone>
<DeclineReason>String</DeclineReason>
<DeclinedBy>String</DeclinedBy>
<DeclinedUtc>0001-01-01T00:00:00</DeclinedUtc>
<Events>
<DispatchRequestEventView>
<AtUtc>0001-01-01T00:00:00</AtUtc>
<ByWho>String</ByWho>
<Detail>String</Detail>
<EventId>0</EventId>
<Kind>String</Kind>
</DispatchRequestEventView>
</Events>
<FromLoc>String</FromLoc>
<IsUrgent>false</IsUrgent>
<JobsCreated>0</JobsCreated>
<JobsDone>0</JobsDone>
<JobsNeedDriver>0</JobsNeedDriver>
<LoadsNeeded>0</LoadsNeeded>
<Miles>0</Miles>
<Notes>String</Notes>
<QuoteTotal>0</QuoteTotal>
<QuoteVersion>0</QuoteVersion>
<QuotedBy>String</QuotedBy>
<QuotedUtc>0001-01-01T00:00:00</QuotedUtc>
<RatePerLoad>0</RatePerLoad>
<RequestId>0</RequestId>
<RequiredRig>String</RequiredRig>
<Source>String</Source>
<Status>String</Status>
<ToLoc>String</ToLoc>
<Units>0</Units>
<UnitsPerTruck>0</UnitsPerTruck>
<UrgencyPct>0</UrgencyPct>
<WindowText>String</WindowText>
</Request>
<Requests>
<DispatchRequestView>
<AcceptTokenExpiresUtc>0001-01-01T00:00:00</AcceptTokenExpiresUtc>
<AcceptedUtc>0001-01-01T00:00:00</AcceptedUtc>
<AcceptedVia>String</AcceptedVia>
<Cargo>String</Cargo>
<Code>String</Code>
<CostPerLoad>0</CostPerLoad>
<CreatedBy>String</CreatedBy>
<CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
<CustomerEmail>String</CustomerEmail>
<CustomerName>String</CustomerName>
<CustomerPhone>String</CustomerPhone>
<DeclineReason>String</DeclineReason>
<DeclinedBy>String</DeclinedBy>
<DeclinedUtc>0001-01-01T00:00:00</DeclinedUtc>
<Events>
<DispatchRequestEventView>
<AtUtc>0001-01-01T00:00:00</AtUtc>
<ByWho>String</ByWho>
<Detail>String</Detail>
<EventId>0</EventId>
<Kind>String</Kind>
</DispatchRequestEventView>
</Events>
<FromLoc>String</FromLoc>
<IsUrgent>false</IsUrgent>
<JobsCreated>0</JobsCreated>
<JobsDone>0</JobsDone>
<JobsNeedDriver>0</JobsNeedDriver>
<LoadsNeeded>0</LoadsNeeded>
<Miles>0</Miles>
<Notes>String</Notes>
<QuoteTotal>0</QuoteTotal>
<QuoteVersion>0</QuoteVersion>
<QuotedBy>String</QuotedBy>
<QuotedUtc>0001-01-01T00:00:00</QuotedUtc>
<RatePerLoad>0</RatePerLoad>
<RequestId>0</RequestId>
<RequiredRig>String</RequiredRig>
<Source>String</Source>
<Status>String</Status>
<ToLoc>String</ToLoc>
<Units>0</Units>
<UnitsPerTruck>0</UnitsPerTruck>
<UrgencyPct>0</UrgencyPct>
<WindowText>String</WindowText>
</DispatchRequestView>
</Requests>
<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>
<RigCounts>
<DispatchRigCountView>
<RigType>String</RigType>
<Rigs>0</Rigs>
</DispatchRigCountView>
</RigCounts>
</DispatchRequestsResponse>