| POST,OPTIONS | /v1/worker/dispatch/photo |
|---|
export class DriverStampView
{
public Stage: string;
public AtUtc: string;
public Note: string;
public constructor(init?: Partial<DriverStampView>) { (Object as any).assign(this, init); }
}
export class DriverTruckView
{
public Code: string;
public Stage: string;
public StageSinceUtc?: string;
public LoadsToday: number;
public NetToday: number;
public EstLoad?: number;
public Slot: string;
public SiteName: string;
public SupplierName: string;
public NextSiteName: string;
public Facility: string;
public FacilityShort: string;
public Unit: string;
public QueuePosition?: number;
public HoldCode: string;
public HoldReason: string;
public HoldEndUtc?: string;
public OpenLoadId?: number;
public OpenLoadCode: string;
public OpenLoadPhotos: number;
public Stamps: DriverStampView[] = [];
public constructor(init?: Partial<DriverTruckView>) { (Object as any).assign(this, init); }
}
export class DriverRigView
{
public Code: string;
public Name: string;
public RigType: string;
public IsFree: boolean;
public HoldCode: string;
public HoldReason: string;
public HoldEndUtc?: string;
public constructor(init?: Partial<DriverRigView>) { (Object as any).assign(this, init); }
}
export class DriverJobView
{
public Kind: string;
public Code: string;
public Cargo: string;
public Customer: string;
public CustomerPhone: string;
public HoldContact: string;
public HoldPhone: string;
public FromLoc: string;
public ToLoc: string;
public Miles: number;
public WindowText: string;
public Stage: string;
public Rate?: number;
public RequiredRig: string;
public EtaText: string;
public OfferExpiresUtc?: string;
public RequestId?: number;
public LoadId?: number;
public LoadCode: string;
public LoadPay?: number;
public Photos: number;
public Stamps: DriverStampView[] = [];
public constructor(init?: Partial<DriverJobView>) { (Object as any).assign(this, init); }
}
export class DriverOdView
{
public Code: string;
public Name: string;
public Zone: string;
public Status: string;
public Tier: string;
public Capabilities: string;
public PingCode: string;
public PingAddress: string;
public PingZone: string;
public PingBags?: number;
public PingNeeds: string;
public PingNote: string;
public PingExpiresUtc?: string;
public RunCode: string;
public RunAddress: string;
public RunZone: string;
public RunBags?: number;
public RunStage: string;
public RunNeeds: string;
public RunNote: string;
public RunEta: string;
public OdBase?: number;
public OdPerBag?: number;
public HoldCode: string;
public HoldReason: string;
public HoldEndUtc?: string;
public constructor(init?: Partial<DriverOdView>) { (Object as any).assign(this, init); }
}
export class DispatchIncidentMessageView
{
public MessageId: number;
public Who: string;
public Role: string;
public Msg: string;
public AtUtc: string;
public constructor(init?: Partial<DispatchIncidentMessageView>) { (Object as any).assign(this, init); }
}
export class DriverIncidentView
{
public IncidentId: number;
public Code: string;
public Kind: string;
public KindDetail: string;
public Status: string;
public LoadCode: string;
public TruckCode: string;
public LocationText: string;
public DriverPref: string;
public TruckRecovery: string;
public LoadRecovery: string;
public TransloadTruckCode: string;
public HoldCode: string;
public OpenedUtc: string;
public ResolvedUtc?: string;
public Messages: DispatchIncidentMessageView[] = [];
public constructor(init?: Partial<DriverIncidentView>) { (Object as any).assign(this, init); }
}
export class DriverPayLineView
{
public Code: string;
public Module: string;
public SourceLabel: string;
public DestinationLabel: string;
public QtyText: string;
public Pay?: number;
public PayPlanLabel: string;
public Status: string;
public ClosedUtc?: string;
public OpenedUtc: string;
public TicketCode: string;
public constructor(init?: Partial<DriverPayLineView>) { (Object as any).assign(this, init); }
}
export class DriverMeResponse
{
public ContactId: number;
public Name: string;
public Phone: string;
public PayPlanName: string;
public PayPlanBasis: string;
public PayPlanRate?: number;
public Truck: DriverTruckView;
public Rig: DriverRigView;
public Jobs: DriverJobView[] = [];
public Od: DriverOdView;
public Incidents: DriverIncidentView[] = [];
public Pay: DriverPayLineView[] = [];
public ServerUtc: string;
public Message: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<DriverMeResponse>) { (Object as any).assign(this, init); }
}
export class DriverPhotoRequest
{
public LoadId: number;
public Kind: string;
public constructor(init?: Partial<DriverPhotoRequest>) { (Object as any).assign(this, init); }
}
TypeScript DriverPhotoRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/worker/dispatch/photo HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
LoadId: 0,
Kind: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ContactId: 0,
Name: String,
Phone: String,
PayPlanName: String,
PayPlanBasis: String,
PayPlanRate: 0,
Truck:
{
Code: String,
Stage: String,
StageSinceUtc: 0001-01-01,
LoadsToday: 0,
NetToday: 0,
EstLoad: 0,
Slot: String,
SiteName: String,
SupplierName: String,
NextSiteName: String,
Facility: String,
FacilityShort: String,
Unit: String,
QueuePosition: 0,
HoldCode: String,
HoldReason: String,
HoldEndUtc: 0001-01-01,
OpenLoadId: 0,
OpenLoadCode: String,
OpenLoadPhotos: 0,
Stamps:
[
{
Stage: String,
AtUtc: 0001-01-01,
Note: String
}
]
},
Rig:
{
Code: String,
Name: String,
RigType: String,
IsFree: False,
HoldCode: String,
HoldReason: String,
HoldEndUtc: 0001-01-01
},
Jobs:
[
{
Kind: String,
Code: String,
Cargo: String,
Customer: String,
CustomerPhone: String,
HoldContact: String,
HoldPhone: String,
FromLoc: String,
ToLoc: String,
Miles: 0,
WindowText: String,
Stage: String,
Rate: 0,
RequiredRig: String,
EtaText: String,
OfferExpiresUtc: 0001-01-01,
RequestId: 0,
LoadId: 0,
LoadCode: String,
LoadPay: 0,
Photos: 0,
Stamps:
[
{
Stage: String,
AtUtc: 0001-01-01,
Note: String
}
]
}
],
Od:
{
Code: String,
Name: String,
Zone: String,
Status: String,
Tier: String,
Capabilities: String,
PingCode: String,
PingAddress: String,
PingZone: String,
PingBags: 0,
PingNeeds: String,
PingNote: String,
PingExpiresUtc: 0001-01-01,
RunCode: String,
RunAddress: String,
RunZone: String,
RunBags: 0,
RunStage: String,
RunNeeds: String,
RunNote: String,
RunEta: String,
OdBase: 0,
OdPerBag: 0,
HoldCode: String,
HoldReason: String,
HoldEndUtc: 0001-01-01
},
Incidents:
[
{
IncidentId: 0,
Code: String,
Kind: String,
KindDetail: String,
Status: String,
LoadCode: String,
TruckCode: String,
LocationText: String,
DriverPref: String,
TruckRecovery: String,
LoadRecovery: String,
TransloadTruckCode: String,
HoldCode: String,
OpenedUtc: 0001-01-01,
ResolvedUtc: 0001-01-01,
Messages:
[
{
MessageId: 0,
Who: String,
Role: String,
Msg: String,
AtUtc: 0001-01-01
}
]
}
],
Pay:
[
{
Code: String,
Module: String,
SourceLabel: String,
DestinationLabel: String,
QtyText: String,
Pay: 0,
PayPlanLabel: String,
Status: String,
ClosedUtc: 0001-01-01,
OpenedUtc: 0001-01-01,
TicketCode: String
}
],
ServerUtc: 0001-01-01,
Message: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}