Trendsic Platform Service

DispatchRequestCreateRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/requests

**DispatchRequestCreateRequest** Parameters:
Name	Parameter	Data Type	Required
CustomerName	body	string	No
CustomerPhone	body	string	No
CustomerEmail	body	string	No
Cargo	body	string	No
Units	body	int	No
FromLoc	body	string	No
ToLoc	body	string	No
Miles	body	int?	No
WindowText	body	string	No
IsUrgent	body	bool	No
Notes	body	string	No

**DispatchRequestsResponse** Parameters:
Name	Parameter	Data Type	Required
Requests	form	List<DispatchRequestView>	No
Request	form	DispatchRequestView	No
RigCounts	form	List<DispatchRigCountView>	No
Carriers	form	List<DispatchCarrierPickView>	No
QuoteLink	form	string	No
Delivery	form	string	No
ResponseStatus	form	ResponseStatus	No

**DispatchRequestView** Parameters:
Name	Parameter	Data Type	Required
RequestId	form	int	No
Code	form	string	No
CustomerName	form	string	No
CustomerPhone	form	string	No
CustomerEmail	form	string	No
Cargo	form	string	No
Units	form	int	No
FromLoc	form	string	No
ToLoc	form	string	No
Miles	form	int?	No
WindowText	form	string	No
IsUrgent	form	bool	No
Notes	form	string	No
Source	form	string	No
Status	form	string	No
RequiredRig	form	string	No
UnitsPerTruck	form	int?	No
RatePerLoad	form	decimal?	No
UrgencyPct	form	decimal	No
CostPerLoad	form	decimal?	No
LoadsNeeded	form	int?	No
QuoteTotal	form	decimal?	No
QuoteVersion	form	int	No
QuotedUtc	form	DateTime?	No
QuotedBy	form	string	No
AcceptTokenExpiresUtc	form	DateTime?	No
AcceptedUtc	form	DateTime?	No
AcceptedVia	form	string	No
DeclinedUtc	form	DateTime?	No
DeclinedBy	form	string	No
DeclineReason	form	string	No
JobsCreated	form	int	No
JobsDone	form	int	No
JobsNeedDriver	form	int	No
CreatedUtc	form	DateTime	No
CreatedBy	form	string	No
Events	form	List<DispatchRequestEventView>	No

**DispatchRequestEventView** Parameters:
Name	Parameter	Data Type	Required
EventId	form	int	No
Kind	form	string	No
Detail	form	string	No
AtUtc	form	DateTime	No
ByWho	form	string	No

**DispatchRigCountView** Parameters:
Name	Parameter	Data Type	Required	Description
RigType	form	string	No
Rigs	form	int	No

**DispatchCarrierPickView** Parameters:
Name	Parameter	Data Type	Required	Description
VendorID	form	int	No
VendorName	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>