Trendsic Platform Service

DispatchReportRequest

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

import Foundation
import ServiceStack

public class DispatchReportRequest : Codable
{
    public var fromDate:Date
    public var toDate:Date
    public var locationIds:[String] = []

    required public init(){}
}

public class DispatchReportResponse : Codable
{
    public var stats:[DashboardStatTile] = []
    public var unit:String
    public var trend:[DispatchReportDayRow] = []
    public var byModule:[DispatchReportModuleRow] = []
    public var byLane:[DispatchReportLaneRow] = []
    public var byTruck:[DispatchReportTruckRow] = []
    public var byDriver:[DispatchReportDriverRow] = []
    public var jobs:[DispatchReportJobRow] = []
    public var incidents:[DispatchReportIncidentRow] = []
    public var holds:[DispatchReportHoldRow] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DashboardStatTile : Codable
{
    public var key:String
    public var label:String
    public var value:Double
    public var previousValue:Double?
    public var unit:String
    public var deltaPct:Double?

    required public init(){}
}

public class DispatchReportDayRow : Codable
{
    public var label:String
    public var loads:Int
    public var revenue:Double
    public var pay:Double
    public var qty:Double
    public var avgCycleMins:Double?

    required public init(){}
}

public class DispatchReportModuleRow : Codable
{
    public var module:String
    public var loads:Int
    public var qty:Double
    public var revenue:Double
    public var pay:Double

    required public init(){}
}

public class DispatchReportLaneRow : Codable
{
    public var supplierName:String
    public var sourceLabel:String
    public var loads:Int
    public var qty:Double
    public var revenue:Double
    public var avgCycleMins:Double?

    required public init(){}
}

public class DispatchReportTruckRow : Codable
{
    public var truckLabel:String
    public var driverLabel:String
    public var loads:Int
    public var qty:Double
    public var revenue:Double
    public var pay:Double
    public var avgCycleMins:Double?
    public var daysActive:Int

    required public init(){}
}

public class DispatchReportDriverRow : Codable
{
    public var driver:String
    public var driverContactId:Int?
    public var loads:Int
    public var qty:Double
    public var pay:Double
    public var daysActive:Int
    public var unpriced:Int

    required public init(){}
}

public class DispatchReportJobRow : Codable
{
    public var jobCode:String
    public var customer:String
    public var cargo:String
    public var route:String
    public var miles:Int
    public var revenue:Double?
    public var pay:Double?
    public var marginPct:Double?
    public var closedUtc:Date?

    required public init(){}
}

public class DispatchReportIncidentRow : Codable
{
    public var kind:String
    public var opened:Int
    public var resolved:Int
    public var avgResolveMins:Double?

    required public init(){}
}

public class DispatchReportHoldRow : Codable
{
    public var scopeKind:String
    public var holds:Int
    public var pausedMins:Int
    public var weather:Int
    public var fromIncidents:Int

    required public init(){}
}

Swift DispatchReportRequest 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.

POST /v1/dashboard/dispatch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FromDate>0001-01-01T00:00:00</FromDate>
  <LocationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </LocationIds>
  <ToDate>0001-01-01T00:00:00</ToDate>
</DispatchReportRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ByDriver>
    <DispatchReportDriverRow>
      <DaysActive>0</DaysActive>
      <Driver>String</Driver>
      <DriverContactId>0</DriverContactId>
      <Loads>0</Loads>
      <Pay>0</Pay>
      <Qty>0</Qty>
      <Unpriced>0</Unpriced>
    </DispatchReportDriverRow>
  </ByDriver>
  <ByLane>
    <DispatchReportLaneRow>
      <AvgCycleMins>0</AvgCycleMins>
      <Loads>0</Loads>
      <Qty>0</Qty>
      <Revenue>0</Revenue>
      <SourceLabel>String</SourceLabel>
      <SupplierName>String</SupplierName>
    </DispatchReportLaneRow>
  </ByLane>
  <ByModule>
    <DispatchReportModuleRow>
      <Loads>0</Loads>
      <Module>String</Module>
      <Pay>0</Pay>
      <Qty>0</Qty>
      <Revenue>0</Revenue>
    </DispatchReportModuleRow>
  </ByModule>
  <ByTruck>
    <DispatchReportTruckRow>
      <AvgCycleMins>0</AvgCycleMins>
      <DaysActive>0</DaysActive>
      <DriverLabel>String</DriverLabel>
      <Loads>0</Loads>
      <Pay>0</Pay>
      <Qty>0</Qty>
      <Revenue>0</Revenue>
      <TruckLabel>String</TruckLabel>
    </DispatchReportTruckRow>
  </ByTruck>
  <Holds>
    <DispatchReportHoldRow>
      <FromIncidents>0</FromIncidents>
      <Holds>0</Holds>
      <PausedMins>0</PausedMins>
      <ScopeKind>String</ScopeKind>
      <Weather>0</Weather>
    </DispatchReportHoldRow>
  </Holds>
  <Incidents>
    <DispatchReportIncidentRow>
      <AvgResolveMins>0</AvgResolveMins>
      <Kind>String</Kind>
      <Opened>0</Opened>
      <Resolved>0</Resolved>
    </DispatchReportIncidentRow>
  </Incidents>
  <Jobs>
    <DispatchReportJobRow>
      <Cargo>String</Cargo>
      <ClosedUtc>0001-01-01T00:00:00</ClosedUtc>
      <Customer>String</Customer>
      <JobCode>String</JobCode>
      <MarginPct>0</MarginPct>
      <Miles>0</Miles>
      <Pay>0</Pay>
      <Revenue>0</Revenue>
      <Route>String</Route>
    </DispatchReportJobRow>
  </Jobs>
  <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>
  <Stats>
    <DashboardStatTile>
      <Key>String</Key>
      <Label>String</Label>
      <PreviousValue>0</PreviousValue>
      <Unit>String</Unit>
      <Value>0</Value>
    </DashboardStatTile>
  </Stats>
  <Trend>
    <DispatchReportDayRow>
      <AvgCycleMins>0</AvgCycleMins>
      <Label>String</Label>
      <Loads>0</Loads>
      <Pay>0</Pay>
      <Qty>0</Qty>
      <Revenue>0</Revenue>
    </DispatchReportDayRow>
  </Trend>
  <Unit>String</Unit>
</DispatchReportResponse>