Trendsic Platform Service

<back to all web services

CourierRunUpdateRequest

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CourierRunUpdateRequest
{
    open var Id:Int? = null
    open var Codes:ArrayList<String> = ArrayList<String>()
    open var DriverContactId:Int? = null
    open var ClearDriver:Boolean? = null
    open var EquipmentID:Int? = null
}

open class CourierRunResponse
{
    open var Runs:ArrayList<CourierRunView> = ArrayList<CourierRunView>()
    open var Run:CourierRunView? = null
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CourierRunView
{
    open var CourierRunID:Int? = null
    open var Code:String? = null
    open var Status:String? = null
    open var CourierProfileId:Int? = null
    open var ProfileName:String? = null
    open var CourierFacilityId:Int? = null
    open var FacilityName:String? = null
    open var FacilityAddress:String? = null
    open var DriverContactId:Int? = null
    open var DriverName:String? = null
    open var EquipmentID:Int? = null
    open var VehicleUnit:String? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var Units:Int? = null
    open var StopCount:Int? = null
    open var StopsDone:Int? = null
    open var Pay:BigDecimal? = null
    open var BuiltUtc:Date? = null
    open var StartedUtc:Date? = null
    open var CompletedUtc:Date? = null
    open var ToLoad:Int? = null
    open var ToReturn:Int? = null
    open var Stops:ArrayList<CourierStopView> = ArrayList<CourierStopView>()
}

open class CourierStopView
{
    open var Sequence:Int? = null
    open var Status:String? = null
    open var DispatchOdRequestID:Int? = null
    open var Code:String? = null
    open var CourierStep:String? = null
    open var Address:String? = null
    open var Unit:String? = null
    open var City:String? = null
    open var Zip:String? = null
    open var Lat:BigDecimal? = null
    open var Lng:BigDecimal? = null
    open var CustomerName:String? = null
    open var CustomerPhone:String? = null
    open var Handoff:String? = null
    open var GateCode:String? = null
    open var Instructions:String? = null
    open var Units:Int? = null
    open var DueText:String? = null
    open var Note:String? = null
    open var Needs:ArrayList<String> = ArrayList<String>()
    open var Items:ArrayList<CourierItemView> = ArrayList<CourierItemView>()
}

open class CourierItemView
{
    open var CourierItemID:Int? = null
    open var DispatchOdRequestID:Int? = null
    open var Seq:Int? = null
    open var TagCode:String? = null
    open var Custody:String? = null
    open var IsOpen:Boolean? = null
    open var IsMissing:Boolean? = null
    open var MissingReason:String? = null
    open var IsManual:Boolean? = null
    open var ReTagFlag:Boolean? = null
    open var Scanned:Boolean? = null
}

Kotlin CourierRunUpdateRequest DTOs

PUT /v1/dispatch/courier/runs/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Codes: 
	[
		String
	],
	DriverContactId: 0,
	ClearDriver: False,
	EquipmentID: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Runs: 
	[
		{
			CourierRunID: 0,
			Code: String,
			Status: String,
			CourierProfileId: 0,
			ProfileName: String,
			CourierFacilityId: 0,
			FacilityName: String,
			FacilityAddress: String,
			DriverContactId: 0,
			DriverName: String,
			EquipmentID: 0,
			VehicleUnit: String,
			UnitOne: String,
			UnitMany: String,
			Units: 0,
			StopCount: 0,
			StopsDone: 0,
			Pay: 0,
			BuiltUtc: 0001-01-01,
			StartedUtc: 0001-01-01,
			CompletedUtc: 0001-01-01,
			ToLoad: 0,
			ToReturn: 0,
			Stops: 
			[
				{
					Sequence: 0,
					Status: String,
					DispatchOdRequestID: 0,
					Code: String,
					CourierStep: String,
					Address: String,
					Unit: String,
					City: String,
					Zip: String,
					Lat: 0,
					Lng: 0,
					CustomerName: String,
					CustomerPhone: String,
					Handoff: String,
					GateCode: String,
					Instructions: String,
					Units: 0,
					DueText: String,
					Note: String,
					Needs: 
					[
						String
					],
					Items: 
					[
						{
							CourierItemID: 0,
							DispatchOdRequestID: 0,
							Seq: 0,
							TagCode: String,
							Custody: String,
							IsOpen: False,
							IsMissing: False,
							MissingReason: String,
							IsManual: False,
							ReTagFlag: False,
							Scanned: False
						}
					]
				}
			]
		}
	],
	Run: 
	{
		CourierRunID: 0,
		Code: String,
		Status: String,
		CourierProfileId: 0,
		ProfileName: String,
		CourierFacilityId: 0,
		FacilityName: String,
		FacilityAddress: String,
		DriverContactId: 0,
		DriverName: String,
		EquipmentID: 0,
		VehicleUnit: String,
		UnitOne: String,
		UnitMany: String,
		Units: 0,
		StopCount: 0,
		StopsDone: 0,
		Pay: 0,
		BuiltUtc: 0001-01-01,
		StartedUtc: 0001-01-01,
		CompletedUtc: 0001-01-01,
		ToLoad: 0,
		ToReturn: 0,
		Stops: 
		[
			{
				Sequence: 0,
				Status: String,
				DispatchOdRequestID: 0,
				Code: String,
				CourierStep: String,
				Address: String,
				Unit: String,
				City: String,
				Zip: String,
				Lat: 0,
				Lng: 0,
				CustomerName: String,
				CustomerPhone: String,
				Handoff: String,
				GateCode: String,
				Instructions: String,
				Units: 0,
				DueText: String,
				Note: String,
				Needs: 
				[
					String
				],
				Items: 
				[
					{
						CourierItemID: 0,
						DispatchOdRequestID: 0,
						Seq: 0,
						TagCode: String,
						Custody: String,
						IsOpen: False,
						IsMissing: False,
						MissingReason: String,
						IsManual: False,
						ReTagFlag: False,
						Scanned: False
					}
				]
			}
		]
	},
	Message: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}