Trendsic Platform Service

<back to all web services

DispatchReportRequest

export class DashboardStatTile
{
    public Key: string;
    public Label: string;
    public Value: number;
    public PreviousValue?: number;
    public Unit: string;
    public DeltaPct?: number;

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

export class DispatchReportDayRow
{
    public Label: string;
    public Loads: number;
    public Revenue: number;
    public Pay: number;
    public Qty: number;
    public AvgCycleMins?: number;

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

export class DispatchReportModuleRow
{
    public Module: string;
    public Loads: number;
    public Qty: number;
    public Revenue: number;
    public Pay: number;

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

export class DispatchReportLaneRow
{
    public SupplierName: string;
    public SourceLabel: string;
    public Loads: number;
    public Qty: number;
    public Revenue: number;
    public AvgCycleMins?: number;

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

export class DispatchReportTruckRow
{
    public TruckLabel: string;
    public DriverLabel: string;
    public Loads: number;
    public Qty: number;
    public Revenue: number;
    public Pay: number;
    public AvgCycleMins?: number;
    public DaysActive: number;

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

export class DispatchReportDriverRow
{
    public Driver: string;
    public DriverContactId?: number;
    public Loads: number;
    public Qty: number;
    public Pay: number;
    public DaysActive: number;
    public Unpriced: number;

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

export class DispatchReportJobRow
{
    public JobCode: string;
    public Customer: string;
    public Cargo: string;
    public Route: string;
    public Miles: number;
    public Revenue?: number;
    public Pay?: number;
    public MarginPct?: number;
    public ClosedUtc?: string;

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

export class DispatchReportIncidentRow
{
    public Kind: string;
    public Opened: number;
    public Resolved: number;
    public AvgResolveMins?: number;

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

export class DispatchReportHoldRow
{
    public ScopeKind: string;
    public Holds: number;
    public PausedMins: number;
    public Weather: number;
    public FromIncidents: number;

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

export class DispatchReportResponse
{
    public Stats: DashboardStatTile[] = [];
    public Unit: string;
    public Trend: DispatchReportDayRow[] = [];
    public ByModule: DispatchReportModuleRow[] = [];
    public ByLane: DispatchReportLaneRow[] = [];
    public ByTruck: DispatchReportTruckRow[] = [];
    public ByDriver: DispatchReportDriverRow[] = [];
    public Jobs: DispatchReportJobRow[] = [];
    public Incidents: DispatchReportIncidentRow[] = [];
    public Holds: DispatchReportHoldRow[] = [];
    public ResponseStatus: ResponseStatus;

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

export class DispatchReportRequest
{
    public FromDate: string;
    public ToDate: string;
    public LocationIds: string[] = [];

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

TypeScript DispatchReportRequest DTOs

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>