DispatchHorizonService

Name

C# data type

NewDispatchHorizon

DispatchHorizon

Create a new DispatchHorizon

Name

C# data type

GetActivityHistory

id

string

List<AssetAssignment>

Retrieve a list of AssetAssignments by asset type, id, start date, and end date

type

AssetTypeEnum

endDate

DateTime

startDate

DateTime

GetActivitySummary

id

string

List<AssetAssignment>

Retrieve a list of AssetAssignments by asset type and id

type

AssetTypeEnum

GetCurrentActivity

id

string

CurrentActivity

Retrieve current activity by id and AssetTypeEnum

type

AssetTypeEnum

GetCurrentActivityLeg

id

string

Int?

Retrieve current activity leg by id and AssetTypeEnum

type

AssetTypeEnum

Name

C# data type

CalculateMileage

Dispatch

DispatchHorizon

DispatchHorizon

Calculate mileage

movToUpdate

Move

CascadeDates

Dispatch

DispatchHorizon

CascadeDatesReturn

Cascade dates for a specified stop’s arrival or departure

startDate

Stop

startStop

ArriveDepartEnum

CheckDispatchServiceStatus

DispatchServiceStatus

Retrieve the status of the dispatch service

CreateDeadhead

currentTripHorizon

DispatchHorizon

DeadheadReturn

Create new instance of DeadHead

currentTripLghNumber

int

lastTripHorizon

DispatchHorizon

lastTripLghNumber

int?

SplitTrip

splitLocation

Location

DispatchHorizon

Split a trip using the stop number and location

stopNumber

int

SplitTripWithDates

hookTime

DateTime

DispatchHorizon

Split a trip using the stop number and location; specify park and hook times

parkTime

DateTime

splitLocation

Location

stopNumber

int

StandardDateRipple

dispatch

DispatchHorizon

DispatchHorizon

Change dates of a specified move

move

Move

startFromDeparture

bool

startFromStopIndex

int

Name

C# data type

GetPagedAssetAssignments

Type, id, statuses

List<AssetAssignment>

Retrieve paged list of assets

Name

C# data type

GetMove

extraData

List<ExtraDataRequest> =null

DispatchHorizon

Retrieve DispatchHorizon for associated move number

moveNumber

Int32

GetMoveByFreight

fgtNumber

DispatchHorizon

Retrieve DispatchHorizon for associated freight

GetMoveByLeg

extraData

List<ExtraDataRequest> =null

DispatchHorizon

Retrieve DispatchHorizon for associated leg number

lghnumber

Int32

GetMoveByStop

extraData

List<ExtraDataRequest> =null

DispatchHorizon

Retrieve DispatchHorizon for associated stop number

stpNumber

Int32

GetMoves

extraData

List<ExtraDataRequest> =null

DispatchHorizon

Retrieve DispatchHorizon for associated move numbers

moveNumber

List<int>

GetMovesForLegWithRelatedMoves

extraData

int

DispatchHorizon

Retrieve DispatchHorizon by related moves for legs

legNumber

List<ExtraDataRequest>

GetMovesForOrderHeader

extraData

List<ExtraDataRequest> = null

DispatchHorizon

Retrieve DispatchHorizon associated with the provided order header number

orderHeaderNumber

int

GetMovesForOrderHeaders

extraData

List<ExtraDataRequest>

DispatchHorizon

Retrieve DispatchHorizon for associated order header numbers

orderHeaderNumbers

List<int>

GetMovesForOrderHeadersWithRelatedMoves

extraData

List<ExtraDataRequest>

DispatchHorizon

Retrieve DispatchHorizon for associated order header numbers

orderHeaderNumber

List<int>

GetMovesForOrderHeaderWithRelatedMoves

extraData

List<ExtraDataRequest>= null

DispatchHorizon

Return DispatchHorizon by related moves for order header number

orderHeaderNumber

int

GetMovesForOrderNumber

extraData

List<ExtraDataRequest> = null

DispatchHorizon

Retrieve DispatchHorizon for an associated order number

orderNumber

string

GetMovesForOrderNumbers

extraData

List<ExtraDataRequest> = null

DispatchHorizon

Retrieve moves for associated order numbers

orderNumber

List<string>

GetMovesForOrderNumbersWithRelatedMoves

extraData

List<ExtraDataRequest> = null

DispatchHorizon

Retrieve DispatchHorizon by related moves for order numbers

orderNumber

List<string>

GetMovesForReferenceNumber

extraData

List<ExtraDataRequest> = null

DispatchHorizon

Retrieve DispatchHorizon for associated reference numbers

referenceNumber

string

GetMovesForStops

extraData

List<ExtraDataRequest> = null

DispatchHorizon

Retrieve DispatchHorizon for associated stop numbers

stpNumbers

List<Int32>

GetMovesWithRelatedMoves

extraData

List<ExtraDataRequest>= null

DispatchHorizon

Return DispatchHorizon by move numbers

moveNumbers

List<Int32>

Name

C# data type

SaveAndIgnoreValidation

categoriestoIgnore

List<ValidationCategoryEnum>

ValidationDispatch

Ignore specified validation for a specified DispatchHorizon

dispatch

DispatchHorizon

SaveDispatch

dispatch

DispatchHorizon

DispatchHorizon

Save DispatchHorizon

SaveDispatches

dispatches

List<DispatchHorizon>

List<DispatchSaveError>

Save dispatches, returning any errors

SaveDispatchFreight

freight

List<Freight>

List<DispatchSaveError>

Save DispatchHorizon freight, returning any errors

SaveDispatchHandleExceptions

dispatch

DispatchHorizon

DispatchHorizon

Save DispatchHorizon without throwing exceptions

SaveDispatchStop

stops

Stop

List<DispatchSaveError>

Save a DispatchHorizon stop, returning any errors

SaveDispatchWithDateRipple

Dispatch

Save a DispatchHorizon stop, returning any errors

SaveDispatchWithDateRippleForNewMoves

dispatch

DispatchHorizon

DispatchHorizon

Save DispatchHorizon, updating all dates for new moves

Name

C# data type

GetNextTrip

args

PriorAndNextTripArguments

DispatchHorizon

Retrieve DispatchHorizon by PriorAndNextTripArguments

GetPriorAndNextTrip

tripArguments

PriorAndNextTripArguments

PriorAndNextTrip

Retrieve PriorAndNextTrip by PriorAndNextTripArguments

Name

C# data type

Validate

dispatch

DispatchHorizon

ValidationErrorCollection

Return a collection of validation errors for a DispatchHorizon

Name

C# data type

Name

Data type

ControlData

string

Not mapped

Errors

List <DispatchSaveError>

See Dispatch Save Error for more information

ExtraData

List <ExtraDataItem>

Not mapped

Moves

List <Move>

Not mapped

Orders

List<Order>

See Order for more information

RuleData

List <ConcurrencyFieldRule>

Not mapped

Name

C# data type

Name

Data type

ErrorMessage

string

Not mapped

ErrorType

string

Not mapped

PreventUpdate

bool

Not mapped

Name

C# data type

Name

Data type

BookedBranch

string

o.ord_booked_revtype1

varchar(12)

Carrier

string

l.lgh_carrier

varchar(8)

CarrierContact

string

lb.lgh_contact

varchar(25)

CarrierDriver

string

lb.lgh_driver_name

varchar(255)

CarrierDriverPhone

string

lb.lgh_driver_phone

varchar(25)

CarrierTruck

string

lb.lgh_carrier_truck

varchar(50)

Driver1

string

l.lgh_driver1

varchar(8)

Driver2

string

l.lgh_driver2

varchar(8)

ExecutingBranch

string

o.ord_broker

lgh_booked_revtype1

string

l.lgh_booked_revtype1

varchar(12)

lgh_number

int

l.lgh_number

int

Not null

lgh_type1

string

l.lgh_type1

varchar(6)

lgh_type2

string

l.lgh_type2

varchar(6)

lgh_type3

string

l.lgh_type3

varchar(6)

lgh_type4

string

l.lgh_type4

varchar(6)

OutStatus

string

l.lgh_outstatus

varchar(6)

ShiftId

int?

l.shift_ss_id

int

ShiftSequence

int?

l.mfh_number

int

TotalMiles

int

l.lgh_total_mov_miles

int

Tractor

string

l.lgh_tractor

varchar(8)

Name

C# data type

Comments

Legs

List<Leg>

See Leg for more information

mov_number

int

Not mapped

Stops

List<Stop>

See Stops for more information

Name

C# data type

Name

Data type

AvailableDate

DateTime?

ord_availabledate

datetime

BillTo

string

ord_billto

varchar(8)

BookedDate

DateTime?

ord_bookdate

datetime

ControlData

string

Not mapped

CreatedBy

string

Not mapped

CreatedDateTime

DateTime?

Not mapped

InvoiceStatus

string

ord_invoicestatus

varchar(6)

OdometerMileage

double?

ord_odmetermiles

int

OrderBy

string

ord_company

varchar(8)

OrderContact

string

ord_contact

varchar(30)

OrderHeaderNumber

int

ord_hdrnumber

int

OrderNumber

int

ord_number

char(12)

Priority

string

ord_priority

varchar(6)

PromisedDate

DateTime?

ord_datepromised

datetime

Remark1

string

ord_remark

varchar(254)

Remark2

string

ord_remark2

varchar(255)

RevenueType1

string

ord_revtype1

varchar(6)

RevenueType2

string

ord_revtype2

varchar(6)

RevenueType3

string

ord_revtype3

varchar(6)

RevenueType4

string

ord_revtype4

varchar(6)

RuleData

List <ConcurrencyFieldRule>

Not mapped

Status

string

ord_status

varchar(6)

Stops

List<Stops>

See Stop for more information

Terms

string

ord_terms

varchar(6)

TotalMileage

double?

ord_totalmiles

int

TrailerType1

string

trl_type1

varchar(6)

TrailerType2

string

ord_trl_type2

varchar(6)

TrailerType3

string

ord_trl_type3

varchar(6)

TrailerType4

string

ord_trl_type4

varchar(6)

UpdateDateTime

DateTime?

Not mapped

UpdatedBy

string

Not mapped

Name

C# data type

Name

Data type

ArrivalDate

DateTime

s.stp_arrivaldate

datetime

ArrivalLateReason

string

s.stp_reasonlate

varchar(6)

ArrivalLateReasonText

string

s.stp_reasonlate_text

varchar(255)

Arrived

bool

s.stp_status

varchar(6)

Completed

bool

s.stp_departure_status

varchar(6)

DepartureDate

DateTime

s.stp_departuredate

datetime

DepartureLateReason

string

s.stp_reasonlate_depart

varchar(6)

DepartureLateReasonText

string

s.stp_reasonlate_depart_text

varchar(255)

DriveTime

double?

Not mapped

EarliestDate

DateTime

s.stp_schdtearliest

datetime

Event

string

s.stp_event

varchar(6)

Freight

List <Freight>

See Freight for more information

LatestDate

DateTime

s.stp_schdtlatest

datetime

lgh_number

int?

s.lgh_number

int

LoadStatus

string

s.stp_loadstatus

char(3)

Location

Location

Not mapped

mfh_number

int?

s.mfh_number

int

Mileage

float?

s.stp_lgh_mileage

int

MileageId

int?

s.stp_lgh_mileage_mtid

int

ord_hdrnumber

int?

s.ord_hdrnumber

int

OrderMileage

float?

s.stp_ord_mileage

int

OrderMileageId

int?

s.stp_ord_mileage_mtid

int

PayMileage

float?

s.stp_trip_mileage

int

PayMileageId

int?

s.stp_lgh_mileage_mtid

int

ProofOfDeliveryName

string

s.stp_podname

varchar(20)

ReferenceNumbers

List <ReferenceNumber>

Not mapped

StopComment

string

s.stp_comment

varchar(254)

StopCustomerRequestDate

DateTime

s.stp_CustomerRequestDate

datetime

StopDepartureStatus

string

s.stp_departure_status

varchar(6)

StopETA

DateTime?

s.stp_eta

datetime

StopETD

DateTime?

s.stp_etd

datetime

StopStatus

string

s.stp_status

varchar(6)

StopTransferStop

int?

s.stp_transfer_stp

int

StopType1

string

s.stp_type1

varchar (6)

StopType2

string

s.stp_type2

varchar (6)

StopType3

string

s.stp_type3

varchar (6)

stp_number

int?

s.stp_number

int

TractorOdometer

int?

e.evt_hubmiles

int

Trailer1

string

e.evt_trailer1

varchar(13)

Trailer2

string

e.evt_trailer2

varchar(13)