Trendsic Platform Service

DispatchReportRequest

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DashboardStatTile
            Public Overridable Property Key As String
            Public Overridable Property Label As String
            Public Overridable Property Value As Double
            Public Overridable Property PreviousValue As Double?
            Public Overridable Property Unit As String
            Public Overridable Property DeltaPct As Double?
        End Class

        Public Partial Class DispatchReportDayRow
            Public Overridable Property Label As String
            Public Overridable Property Loads As Integer
            Public Overridable Property Revenue As Double
            Public Overridable Property Pay As Double
            Public Overridable Property Qty As Double
            Public Overridable Property AvgCycleMins As Double?
        End Class

        Public Partial Class DispatchReportDriverRow
            Public Overridable Property Driver As String
            Public Overridable Property DriverContactId As Integer?
            Public Overridable Property Loads As Integer
            Public Overridable Property Qty As Double
            Public Overridable Property Pay As Double
            Public Overridable Property DaysActive As Integer
            Public Overridable Property Unpriced As Integer
        End Class

        Public Partial Class DispatchReportHoldRow
            Public Overridable Property ScopeKind As String
            Public Overridable Property Holds As Integer
            Public Overridable Property PausedMins As Integer
            Public Overridable Property Weather As Integer
            Public Overridable Property FromIncidents As Integer
        End Class

        Public Partial Class DispatchReportIncidentRow
            Public Overridable Property Kind As String
            Public Overridable Property Opened As Integer
            Public Overridable Property Resolved As Integer
            Public Overridable Property AvgResolveMins As Double?
        End Class

        Public Partial Class DispatchReportJobRow
            Public Overridable Property JobCode As String
            Public Overridable Property Customer As String
            Public Overridable Property Cargo As String
            Public Overridable Property Route As String
            Public Overridable Property Miles As Integer
            Public Overridable Property Revenue As Double?
            Public Overridable Property Pay As Double?
            Public Overridable Property MarginPct As Double?
            Public Overridable Property ClosedUtc As Date?
        End Class

        Public Partial Class DispatchReportLaneRow
            Public Overridable Property SupplierName As String
            Public Overridable Property SourceLabel As String
            Public Overridable Property Loads As Integer
            Public Overridable Property Qty As Double
            Public Overridable Property Revenue As Double
            Public Overridable Property AvgCycleMins As Double?
        End Class

        Public Partial Class DispatchReportModuleRow
            Public Overridable Property [Module] As String
            Public Overridable Property Loads As Integer
            Public Overridable Property Qty As Double
            Public Overridable Property Revenue As Double
            Public Overridable Property Pay As Double
        End Class

        Public Partial Class DispatchReportRequest
            Public Overridable Property FromDate As Date
            Public Overridable Property ToDate As Date
            Public Overridable Property LocationIds As List(Of Guid) = New List(Of Guid)
        End Class

        Public Partial Class DispatchReportResponse
            Public Overridable Property Stats As List(Of DashboardStatTile) = New List(Of DashboardStatTile)
            Public Overridable Property Unit As String
            Public Overridable Property Trend As List(Of DispatchReportDayRow) = New List(Of DispatchReportDayRow)
            Public Overridable Property ByModule As List(Of DispatchReportModuleRow) = New List(Of DispatchReportModuleRow)
            Public Overridable Property ByLane As List(Of DispatchReportLaneRow) = New List(Of DispatchReportLaneRow)
            Public Overridable Property ByTruck As List(Of DispatchReportTruckRow) = New List(Of DispatchReportTruckRow)
            Public Overridable Property ByDriver As List(Of DispatchReportDriverRow) = New List(Of DispatchReportDriverRow)
            Public Overridable Property Jobs As List(Of DispatchReportJobRow) = New List(Of DispatchReportJobRow)
            Public Overridable Property Incidents As List(Of DispatchReportIncidentRow) = New List(Of DispatchReportIncidentRow)
            Public Overridable Property Holds As List(Of DispatchReportHoldRow) = New List(Of DispatchReportHoldRow)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class DispatchReportTruckRow
            Public Overridable Property TruckLabel As String
            Public Overridable Property DriverLabel As String
            Public Overridable Property Loads As Integer
            Public Overridable Property Qty As Double
            Public Overridable Property Revenue As Double
            Public Overridable Property Pay As Double
            Public Overridable Property AvgCycleMins As Double?
            Public Overridable Property DaysActive As Integer
        End Class
    End Namespace
End Namespace

VB.NET DispatchReportRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","LocationIds":["00000000000000000000000000000000"]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Stats":[{"Key":"String","Label":"String","Value":0,"PreviousValue":0,"Unit":"String","DeltaPct":null}],"Unit":"String","Trend":[{"Label":"String","Loads":0,"Revenue":0,"Pay":0,"Qty":0,"AvgCycleMins":0}],"ByModule":[{"Module":"String","Loads":0,"Qty":0,"Revenue":0,"Pay":0}],"ByLane":[{"SupplierName":"String","SourceLabel":"String","Loads":0,"Qty":0,"Revenue":0,"AvgCycleMins":0}],"ByTruck":[{"TruckLabel":"String","DriverLabel":"String","Loads":0,"Qty":0,"Revenue":0,"Pay":0,"AvgCycleMins":0,"DaysActive":0}],"ByDriver":[{"Driver":"String","DriverContactId":0,"Loads":0,"Qty":0,"Pay":0,"DaysActive":0,"Unpriced":0}],"Jobs":[{"JobCode":"String","Customer":"String","Cargo":"String","Route":"String","Miles":0,"Revenue":0,"Pay":0,"MarginPct":0,"ClosedUtc":"0001-01-01T00:00:00.0000000"}],"Incidents":[{"Kind":"String","Opened":0,"Resolved":0,"AvgResolveMins":0}],"Holds":[{"ScopeKind":"String","Holds":0,"PausedMins":0,"Weather":0,"FromIncidents":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}