Trendsic Platform Service

<back to all web services

DriverJobStepRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/worker/dispatch/job/{Code}/step
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DispatchIncidentMessageView
    {
        public virtual int MessageId { get; set; }
        public virtual string Who { get; set; }
        public virtual string Role { get; set; }
        public virtual string Msg { get; set; }
        public virtual DateTime AtUtc { get; set; }
    }

    public partial class DriverIncidentView
    {
        public virtual int IncidentId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Kind { get; set; }
        public virtual string KindDetail { get; set; }
        public virtual string Status { get; set; }
        public virtual string LoadCode { get; set; }
        public virtual string TruckCode { get; set; }
        public virtual string LocationText { get; set; }
        public virtual string DriverPref { get; set; }
        public virtual string TruckRecovery { get; set; }
        public virtual string LoadRecovery { get; set; }
        public virtual string TransloadTruckCode { get; set; }
        public virtual string HoldCode { get; set; }
        public virtual DateTime OpenedUtc { get; set; }
        public virtual DateTime? ResolvedUtc { get; set; }
        public virtual List<DispatchIncidentMessageView> Messages { get; set; } = [];
    }

    public partial class DriverJobStepRequest
    {
        public virtual string Code { get; set; }
        public virtual string Step { get; set; }
        public virtual string PodName { get; set; }
    }

    public partial class DriverJobView
    {
        public virtual string Kind { get; set; }
        public virtual string Code { get; set; }
        public virtual string Cargo { get; set; }
        public virtual string Customer { get; set; }
        public virtual string CustomerPhone { get; set; }
        public virtual string HoldContact { get; set; }
        public virtual string HoldPhone { get; set; }
        public virtual string FromLoc { get; set; }
        public virtual string ToLoc { get; set; }
        public virtual int Miles { get; set; }
        public virtual string WindowText { get; set; }
        public virtual string Stage { get; set; }
        public virtual decimal? Rate { get; set; }
        public virtual string RequiredRig { get; set; }
        public virtual string EtaText { get; set; }
        public virtual DateTime? OfferExpiresUtc { get; set; }
        public virtual int? RequestId { get; set; }
        public virtual int? LoadId { get; set; }
        public virtual string LoadCode { get; set; }
        public virtual decimal? LoadPay { get; set; }
        public virtual int Photos { get; set; }
        public virtual List<DriverStampView> Stamps { get; set; } = [];
    }

    public partial class DriverMeResponse
    {
        public virtual int ContactId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Phone { get; set; }
        public virtual string PayPlanName { get; set; }
        public virtual string PayPlanBasis { get; set; }
        public virtual decimal? PayPlanRate { get; set; }
        public virtual DriverTruckView Truck { get; set; }
        public virtual DriverRigView Rig { get; set; }
        public virtual List<DriverJobView> Jobs { get; set; } = [];
        public virtual DriverOdView Od { get; set; }
        public virtual List<DriverIncidentView> Incidents { get; set; } = [];
        public virtual List<DriverPayLineView> Pay { get; set; } = [];
        public virtual DateTime ServerUtc { get; set; }
        public virtual string Message { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DriverOdView
    {
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Zone { get; set; }
        public virtual string Status { get; set; }
        public virtual string Tier { get; set; }
        public virtual string Capabilities { get; set; }
        public virtual string PingCode { get; set; }
        public virtual string PingAddress { get; set; }
        public virtual string PingZone { get; set; }
        public virtual int? PingBags { get; set; }
        public virtual string PingNeeds { get; set; }
        public virtual string PingNote { get; set; }
        public virtual DateTime? PingExpiresUtc { get; set; }
        public virtual string RunCode { get; set; }
        public virtual string RunAddress { get; set; }
        public virtual string RunZone { get; set; }
        public virtual int? RunBags { get; set; }
        public virtual string RunStage { get; set; }
        public virtual string RunNeeds { get; set; }
        public virtual string RunNote { get; set; }
        public virtual string RunEta { get; set; }
        public virtual decimal? OdBase { get; set; }
        public virtual decimal? OdPerBag { get; set; }
        public virtual string HoldCode { get; set; }
        public virtual string HoldReason { get; set; }
        public virtual DateTime? HoldEndUtc { get; set; }
    }

    public partial class DriverPayLineView
    {
        public virtual string Code { get; set; }
        public virtual string Module { get; set; }
        public virtual string SourceLabel { get; set; }
        public virtual string DestinationLabel { get; set; }
        public virtual string QtyText { get; set; }
        public virtual decimal? Pay { get; set; }
        public virtual string PayPlanLabel { get; set; }
        public virtual string Status { get; set; }
        public virtual DateTime? ClosedUtc { get; set; }
        public virtual DateTime OpenedUtc { get; set; }
        public virtual string TicketCode { get; set; }
    }

    public partial class DriverRigView
    {
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string RigType { get; set; }
        public virtual bool IsFree { get; set; }
        public virtual string HoldCode { get; set; }
        public virtual string HoldReason { get; set; }
        public virtual DateTime? HoldEndUtc { get; set; }
    }

    public partial class DriverStampView
    {
        public virtual string Stage { get; set; }
        public virtual DateTime AtUtc { get; set; }
        public virtual string Note { get; set; }
    }

    public partial class DriverTruckView
    {
        public virtual string Code { get; set; }
        public virtual string Stage { get; set; }
        public virtual DateTime? StageSinceUtc { get; set; }
        public virtual int LoadsToday { get; set; }
        public virtual decimal NetToday { get; set; }
        public virtual decimal? EstLoad { get; set; }
        public virtual string Slot { get; set; }
        public virtual string SiteName { get; set; }
        public virtual string SupplierName { get; set; }
        public virtual string NextSiteName { get; set; }
        public virtual string Facility { get; set; }
        public virtual string FacilityShort { get; set; }
        public virtual string Unit { get; set; }
        public virtual int? QueuePosition { get; set; }
        public virtual string HoldCode { get; set; }
        public virtual string HoldReason { get; set; }
        public virtual DateTime? HoldEndUtc { get; set; }
        public virtual int? OpenLoadId { get; set; }
        public virtual string OpenLoadCode { get; set; }
        public virtual int OpenLoadPhotos { get; set; }
        public virtual List<DriverStampView> Stamps { get; set; } = [];
    }

}

C# DriverJobStepRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/worker/dispatch/job/{Code}/step HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Code: String,
	Step: String,
	PodName: 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
		}
	}
}