Trendsic Platform Service

<back to all web services

DispatchReportRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/dispatch
"use strict";
export class DashboardStatTile {
    /** @param {{Key?:string,Label?:string,Value?:number,PreviousValue?:number,Unit?:string,DeltaPct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Label;
    /** @type {number} */
    Value;
    /** @type {?number} */
    PreviousValue;
    /** @type {string} */
    Unit;
    /** @type {?number} */
    DeltaPct;
}
export class DispatchReportDayRow {
    /** @param {{Label?:string,Loads?:number,Revenue?:number,Pay?:number,Qty?:number,AvgCycleMins?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Label;
    /** @type {number} */
    Loads;
    /** @type {number} */
    Revenue;
    /** @type {number} */
    Pay;
    /** @type {number} */
    Qty;
    /** @type {?number} */
    AvgCycleMins;
}
export class DispatchReportModuleRow {
    /** @param {{Module?:string,Loads?:number,Qty?:number,Revenue?:number,Pay?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Module;
    /** @type {number} */
    Loads;
    /** @type {number} */
    Qty;
    /** @type {number} */
    Revenue;
    /** @type {number} */
    Pay;
}
export class DispatchReportLaneRow {
    /** @param {{SupplierName?:string,SourceLabel?:string,Loads?:number,Qty?:number,Revenue?:number,AvgCycleMins?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SupplierName;
    /** @type {string} */
    SourceLabel;
    /** @type {number} */
    Loads;
    /** @type {number} */
    Qty;
    /** @type {number} */
    Revenue;
    /** @type {?number} */
    AvgCycleMins;
}
export class DispatchReportTruckRow {
    /** @param {{TruckLabel?:string,DriverLabel?:string,Loads?:number,Qty?:number,Revenue?:number,Pay?:number,AvgCycleMins?:number,DaysActive?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TruckLabel;
    /** @type {string} */
    DriverLabel;
    /** @type {number} */
    Loads;
    /** @type {number} */
    Qty;
    /** @type {number} */
    Revenue;
    /** @type {number} */
    Pay;
    /** @type {?number} */
    AvgCycleMins;
    /** @type {number} */
    DaysActive;
}
export class DispatchReportDriverRow {
    /** @param {{Driver?:string,DriverContactId?:number,Loads?:number,Qty?:number,Pay?:number,DaysActive?:number,Unpriced?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Driver;
    /** @type {?number} */
    DriverContactId;
    /** @type {number} */
    Loads;
    /** @type {number} */
    Qty;
    /** @type {number} */
    Pay;
    /** @type {number} */
    DaysActive;
    /** @type {number} */
    Unpriced;
}
export class DispatchReportJobRow {
    /** @param {{JobCode?:string,Customer?:string,Cargo?:string,Route?:string,Miles?:number,Revenue?:number,Pay?:number,MarginPct?:number,ClosedUtc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    JobCode;
    /** @type {string} */
    Customer;
    /** @type {string} */
    Cargo;
    /** @type {string} */
    Route;
    /** @type {number} */
    Miles;
    /** @type {?number} */
    Revenue;
    /** @type {?number} */
    Pay;
    /** @type {?number} */
    MarginPct;
    /** @type {?string} */
    ClosedUtc;
}
export class DispatchReportIncidentRow {
    /** @param {{Kind?:string,Opened?:number,Resolved?:number,AvgResolveMins?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {number} */
    Opened;
    /** @type {number} */
    Resolved;
    /** @type {?number} */
    AvgResolveMins;
}
export class DispatchReportHoldRow {
    /** @param {{ScopeKind?:string,Holds?:number,PausedMins?:number,Weather?:number,FromIncidents?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ScopeKind;
    /** @type {number} */
    Holds;
    /** @type {number} */
    PausedMins;
    /** @type {number} */
    Weather;
    /** @type {number} */
    FromIncidents;
}
export class DispatchReportResponse {
    /** @param {{Stats?:DashboardStatTile[],Unit?:string,Trend?:DispatchReportDayRow[],ByModule?:DispatchReportModuleRow[],ByLane?:DispatchReportLaneRow[],ByTruck?:DispatchReportTruckRow[],ByDriver?:DispatchReportDriverRow[],Jobs?:DispatchReportJobRow[],Incidents?:DispatchReportIncidentRow[],Holds?:DispatchReportHoldRow[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DashboardStatTile[]} */
    Stats = [];
    /** @type {string} */
    Unit;
    /** @type {DispatchReportDayRow[]} */
    Trend = [];
    /** @type {DispatchReportModuleRow[]} */
    ByModule = [];
    /** @type {DispatchReportLaneRow[]} */
    ByLane = [];
    /** @type {DispatchReportTruckRow[]} */
    ByTruck = [];
    /** @type {DispatchReportDriverRow[]} */
    ByDriver = [];
    /** @type {DispatchReportJobRow[]} */
    Jobs = [];
    /** @type {DispatchReportIncidentRow[]} */
    Incidents = [];
    /** @type {DispatchReportHoldRow[]} */
    Holds = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchReportRequest {
    /** @param {{FromDate?:string,ToDate?:string,LocationIds?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FromDate;
    /** @type {string} */
    ToDate;
    /** @type {string[]} */
    LocationIds = [];
}

JavaScript 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>