Trendsic Platform Service

DispatchRequestUpdateRequest

The following routes are available for this service:
PUT,OPTIONS	/v1/dispatch/requests/{RequestId}


export class DispatchRequestEventView
{
    public EventId: number;
    public Kind: string;
    public Detail: string;
    public AtUtc: string;
    public ByWho: string;

    public constructor(init?: Partial<DispatchRequestEventView>) { (Object as any).assign(this, init); }
}

export class DispatchRequestView
{
    public RequestId: number;
    public Code: string;
    public CustomerName: string;
    public CustomerPhone: string;
    public CustomerEmail: string;
    public Cargo: string;
    public Units: number;
    public FromLoc: string;
    public ToLoc: string;
    public Miles?: number;
    public WindowText: string;
    public IsUrgent: boolean;
    public Notes: string;
    public Source: string;
    public Status: string;
    public RequiredRig: string;
    public UnitsPerTruck?: number;
    public RatePerLoad?: number;
    public UrgencyPct: number;
    public CostPerLoad?: number;
    public LoadsNeeded?: number;
    public QuoteTotal?: number;
    public QuoteVersion: number;
    public QuotedUtc?: string;
    public QuotedBy: string;
    public AcceptTokenExpiresUtc?: string;
    public AcceptedUtc?: string;
    public AcceptedVia: string;
    public DeclinedUtc?: string;
    public DeclinedBy: string;
    public DeclineReason: string;
    public JobsCreated: number;
    public JobsDone: number;
    public JobsNeedDriver: number;
    public CreatedUtc: string;
    public CreatedBy: string;
    public Events: DispatchRequestEventView[] = [];

    public constructor(init?: Partial<DispatchRequestView>) { (Object as any).assign(this, init); }
}

export class DispatchRigCountView
{
    public RigType: string;
    public Rigs: number;

    public constructor(init?: Partial<DispatchRigCountView>) { (Object as any).assign(this, init); }
}

export class DispatchCarrierPickView
{
    public VendorID: number;
    public VendorName: string;

    public constructor(init?: Partial<DispatchCarrierPickView>) { (Object as any).assign(this, init); }
}

export class DispatchRequestsResponse
{
    public Requests: DispatchRequestView[] = [];
    public Request: DispatchRequestView;
    public RigCounts: DispatchRigCountView[] = [];
    public Carriers: DispatchCarrierPickView[] = [];
    public QuoteLink: string;
    public Delivery: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchRequestsResponse>) { (Object as any).assign(this, init); }
}

export class DispatchRequestUpdateRequest
{
    public RequestId: number;
    public CustomerName: string;
    public CustomerPhone: string;
    public CustomerEmail: string;
    public Cargo: string;
    public Units?: number;
    public FromLoc: string;
    public ToLoc: string;
    public Miles?: number;
    public WindowText: string;
    public IsUrgent?: boolean;
    public Notes: string;
    public RequiredRig: string;
    public UnitsPerTruck?: number;
    public RatePerLoad?: number;
    public UrgencyPct?: number;
    public CostPerLoad?: number;

    public constructor(init?: Partial<DispatchRequestUpdateRequest>) { (Object as any).assign(this, init); }
}

TypeScript DispatchRequestUpdateRequest DTOs

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.

PUT /v1/dispatch/requests/{RequestId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchRequestUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Cargo>String</Cargo>
  <CostPerLoad>0</CostPerLoad>
  <CustomerEmail>String</CustomerEmail>
  <CustomerName>String</CustomerName>
  <CustomerPhone>String</CustomerPhone>
  <FromLoc>String</FromLoc>
  <IsUrgent>false</IsUrgent>
  <Miles>0</Miles>
  <Notes>String</Notes>
  <RatePerLoad>0</RatePerLoad>
  <RequestId>0</RequestId>
  <RequiredRig>String</RequiredRig>
  <ToLoc>String</ToLoc>
  <Units>0</Units>
  <UnitsPerTruck>0</UnitsPerTruck>
  <UrgencyPct>0</UrgencyPct>
  <WindowText>String</WindowText>
</DispatchRequestUpdateRequest>

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>