Trendsic Platform Service

<back to all web services

CourierSendToFacilityRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/drivers/{ContactId}/send-to-facility
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CourierSendToFacilityRequest
{
    open var ContactId:Int? = null
    open var Note:String? = null
    open var Lift:Boolean? = null
}

open class CourierOrderResponse
{
    open var Orders:ArrayList<CourierOrderView> = ArrayList<CourierOrderView>()
    open var Order:CourierOrderView? = null
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CourierOrderView
{
    open var DispatchOdRequestID:Int? = null
    open var Code:String? = null
    open var CourierProfileId:Int? = null
    open var ProfileName:String? = null
    open var RouteShape:String? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var CourierFacilityId:Int? = null
    open var FacilityName:String? = null
    open var ServiceLevelCode:String? = null
    open var LevelName:String? = null
    open var Source:String? = null
    open var Address:String? = null
    open var Unit:String? = null
    open var City:String? = null
    open var Zip:String? = null
    open var Zone:String? = null
    open var PickupContactName:String? = null
    open var DropoffAddress:String? = null
    open var DropoffUnit:String? = null
    open var DropoffCity:String? = null
    open var DropoffZip:String? = null
    open var DropoffContactName:String? = null
    open var Miles:BigDecimal? = null
    open var Units:Int? = null
    open var UnitsFound:Int? = null
    open var Stage:String? = null
    open var CourierStep:String? = null
    open var StepLabel:String? = null
    open var DriverCode:String? = null
    open var DriverName:String? = null
    open var DriverContactId:Int? = null
    open var CourierRunId:Int? = null
    open var RunCode:String? = null
    open var StopSequence:Int? = null
    open var QueueSequence:Int? = null
    open var IsAsap:Boolean? = null
    open var WindowStartUtc:Date? = null
    open var WindowEndUtc:Date? = null
    open var WindowText:String? = null
    open var DueUtc:Date? = null
    open var DueText:String? = null
    open var PingAfterUtc:Date? = null
    open var PingExpiresUtc:Date? = null
    open var CandidateCode:String? = null
    open var HeldReason:String? = null
    open var HeldUtc:Date? = 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 DamageNote:String? = null
    open var DeliveredToName:String? = null
    open var PayMode:String? = null
    open var Fare:BigDecimal? = null
    open var FinalPrice:BigDecimal? = null
    open var TipAmount:BigDecimal? = null
    open var CancelledBy:String? = null
    open var CancelReason:String? = null
    open var CancelFeeApplied:BigDecimal? = null
    open var MissedFeeApplied:BigDecimal? = null
    open var CaptureMode:String? = null
    open var AuthorizedAmount:BigDecimal? = null
    open var CapturedAmount:BigDecimal? = null
    open var RefundedAmount:BigDecimal? = null
    open var ChargeError:String? = null
    open var CreatedAt:Date? = null
    open var ArrivedUtc:Date? = null
    open var PickedUpUtc:Date? = null
    open var IntakeUtc:Date? = null
    open var ReadyUtc:Date? = null
    open var OutForDeliveryUtc:Date? = null
    open var DeliveredUtc:Date? = null
    open var MissedUtc:Date? = null
    open var CancelledUtc:Date? = null
    open var IsClosed:Boolean? = null
    open var RebookOfId:Int? = null
    open var RecurrenceId:Int? = null
    open var PickupLoadId:Int? = null
    open var Rule:CourierOrderRuleView? = null
    open var Items:ArrayList<CourierItemView> = ArrayList<CourierItemView>()
    open var Scans:ArrayList<CourierScanView> = ArrayList<CourierScanView>()
    open var Proof:ArrayList<CourierProofResultView> = ArrayList<CourierProofResultView>()
    open var Events:ArrayList<CourierEventView> = ArrayList<CourierEventView>()
    open var Photos:ArrayList<CourierPhotoView> = ArrayList<CourierPhotoView>()
    open var PayLines:ArrayList<CourierPayLineView> = ArrayList<CourierPayLineView>()
}

open class CourierOrderRuleView
{
    open var PingSecs:Int? = null
    open var MissedWaitMin:Int? = null
    open var MissedFee:BigDecimal? = null
    open var CancelFee:BigDecimal? = null
    open var MissedAutoRebook:Boolean? = null
    open var MissedRequireContact:Boolean? = null
    open var MissedRequirePhoto:Boolean? = null
    open var PayTiming:String? = null
    open var FinalPriceAfterCount:Boolean? = null
    open var PayPlanName:String? = null
    open var PerPickup:BigDecimal? = null
    open var PerStop:BigDecimal? = null
    open var PerMissed:BigDecimal? = null
    open var PerCancel:BigDecimal? = null
    open var AcceptedUtc:Date? = null
    open var Proof:HashMap<String,String> = HashMap<String,String>()
}

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
}

open class CourierScanView
{
    open var TagCode:String? = null
    open var Stage:String? = null
    open var Result:String? = null
    open var AtUtc:Date? = null
}

open class CourierProofResultView
{
    open var Stage:String? = null
    open var StepKey:String? = null
    open var Value:String? = null
    open var AtUtc:Date? = null
}

open class CourierEventView
{
    open var Kind:String? = null
    open var Party:String? = null
    open var Body:String? = null
    open var AtUtc:Date? = null
}

open class CourierPhotoView
{
    open var PhotoId:Int? = null
    open var Kind:String? = null
    open var FileName:String? = null
    open var Url:String? = null
    open var TakenUtc:Date? = null
}

open class CourierPayLineView
{
    open var DispatchLoadID:Int? = null
    open var Kind:String? = null
    open var Label:String? = null
    open var Qty:BigDecimal? = null
    open var Rate:BigDecimal? = null
    open var Amount:BigDecimal? = null
}

Kotlin CourierSendToFacilityRequest 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/dispatch/courier/drivers/{ContactId}/send-to-facility HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ContactId: 0,
	Note: String,
	Lift: False
}

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

{
	Orders: 
	[
		{
			DispatchOdRequestID: 0,
			Code: String,
			CourierProfileId: 0,
			ProfileName: String,
			RouteShape: String,
			UnitOne: String,
			UnitMany: String,
			CourierFacilityId: 0,
			FacilityName: String,
			ServiceLevelCode: String,
			LevelName: String,
			Source: String,
			Address: String,
			Unit: String,
			City: String,
			Zip: String,
			Zone: String,
			PickupContactName: String,
			DropoffAddress: String,
			DropoffUnit: String,
			DropoffCity: String,
			DropoffZip: String,
			DropoffContactName: String,
			Miles: 0,
			Units: 0,
			UnitsFound: 0,
			Stage: String,
			CourierStep: String,
			StepLabel: String,
			DriverCode: String,
			DriverName: String,
			DriverContactId: 0,
			CourierRunId: 0,
			RunCode: String,
			StopSequence: 0,
			QueueSequence: 0,
			IsAsap: False,
			WindowStartUtc: 0001-01-01,
			WindowEndUtc: 0001-01-01,
			WindowText: String,
			DueUtc: 0001-01-01,
			DueText: String,
			PingAfterUtc: 0001-01-01,
			PingExpiresUtc: 0001-01-01,
			CandidateCode: String,
			HeldReason: String,
			HeldUtc: 0001-01-01,
			CustomerName: String,
			CustomerPhone: String,
			Handoff: String,
			GateCode: String,
			Instructions: String,
			DamageNote: String,
			DeliveredToName: String,
			PayMode: String,
			Fare: 0,
			FinalPrice: 0,
			TipAmount: 0,
			CancelledBy: String,
			CancelReason: String,
			CancelFeeApplied: 0,
			MissedFeeApplied: 0,
			CaptureMode: String,
			AuthorizedAmount: 0,
			CapturedAmount: 0,
			RefundedAmount: 0,
			ChargeError: String,
			CreatedAt: 0001-01-01,
			ArrivedUtc: 0001-01-01,
			PickedUpUtc: 0001-01-01,
			IntakeUtc: 0001-01-01,
			ReadyUtc: 0001-01-01,
			OutForDeliveryUtc: 0001-01-01,
			DeliveredUtc: 0001-01-01,
			MissedUtc: 0001-01-01,
			CancelledUtc: 0001-01-01,
			IsClosed: False,
			RebookOfId: 0,
			RecurrenceId: 0,
			PickupLoadId: 0,
			Rule: 
			{
				PingSecs: 0,
				MissedWaitMin: 0,
				MissedFee: 0,
				CancelFee: 0,
				MissedAutoRebook: False,
				MissedRequireContact: False,
				MissedRequirePhoto: False,
				PayTiming: String,
				FinalPriceAfterCount: False,
				PayPlanName: String,
				PerPickup: 0,
				PerStop: 0,
				PerMissed: 0,
				PerCancel: 0,
				AcceptedUtc: 0001-01-01,
				Proof: 
				{
					String: String
				}
			},
			Items: 
			[
				{
					CourierItemID: 0,
					DispatchOdRequestID: 0,
					Seq: 0,
					TagCode: String,
					Custody: String,
					IsOpen: False,
					IsMissing: False,
					MissingReason: String,
					IsManual: False,
					ReTagFlag: False,
					Scanned: False
				}
			],
			Scans: 
			[
				{
					TagCode: String,
					Stage: String,
					Result: String,
					AtUtc: 0001-01-01
				}
			],
			Proof: 
			[
				{
					Stage: String,
					StepKey: String,
					Value: String,
					AtUtc: 0001-01-01
				}
			],
			Events: 
			[
				{
					Kind: String,
					Party: String,
					Body: String,
					AtUtc: 0001-01-01
				}
			],
			Photos: 
			[
				{
					PhotoId: 0,
					Kind: String,
					FileName: String,
					Url: String,
					TakenUtc: 0001-01-01
				}
			],
			PayLines: 
			[
				{
					DispatchLoadID: 0,
					Kind: String,
					Label: String,
					Qty: 0,
					Rate: 0,
					Amount: 0
				}
			]
		}
	],
	Order: 
	{
		DispatchOdRequestID: 0,
		Code: String,
		CourierProfileId: 0,
		ProfileName: String,
		RouteShape: String,
		UnitOne: String,
		UnitMany: String,
		CourierFacilityId: 0,
		FacilityName: String,
		ServiceLevelCode: String,
		LevelName: String,
		Source: String,
		Address: String,
		Unit: String,
		City: String,
		Zip: String,
		Zone: String,
		PickupContactName: String,
		DropoffAddress: String,
		DropoffUnit: String,
		DropoffCity: String,
		DropoffZip: String,
		DropoffContactName: String,
		Miles: 0,
		Units: 0,
		UnitsFound: 0,
		Stage: String,
		CourierStep: String,
		StepLabel: String,
		DriverCode: String,
		DriverName: String,
		DriverContactId: 0,
		CourierRunId: 0,
		RunCode: String,
		StopSequence: 0,
		QueueSequence: 0,
		IsAsap: False,
		WindowStartUtc: 0001-01-01,
		WindowEndUtc: 0001-01-01,
		WindowText: String,
		DueUtc: 0001-01-01,
		DueText: String,
		PingAfterUtc: 0001-01-01,
		PingExpiresUtc: 0001-01-01,
		CandidateCode: String,
		HeldReason: String,
		HeldUtc: 0001-01-01,
		CustomerName: String,
		CustomerPhone: String,
		Handoff: String,
		GateCode: String,
		Instructions: String,
		DamageNote: String,
		DeliveredToName: String,
		PayMode: String,
		Fare: 0,
		FinalPrice: 0,
		TipAmount: 0,
		CancelledBy: String,
		CancelReason: String,
		CancelFeeApplied: 0,
		MissedFeeApplied: 0,
		CaptureMode: String,
		AuthorizedAmount: 0,
		CapturedAmount: 0,
		RefundedAmount: 0,
		ChargeError: String,
		CreatedAt: 0001-01-01,
		ArrivedUtc: 0001-01-01,
		PickedUpUtc: 0001-01-01,
		IntakeUtc: 0001-01-01,
		ReadyUtc: 0001-01-01,
		OutForDeliveryUtc: 0001-01-01,
		DeliveredUtc: 0001-01-01,
		MissedUtc: 0001-01-01,
		CancelledUtc: 0001-01-01,
		IsClosed: False,
		RebookOfId: 0,
		RecurrenceId: 0,
		PickupLoadId: 0,
		Rule: 
		{
			PingSecs: 0,
			MissedWaitMin: 0,
			MissedFee: 0,
			CancelFee: 0,
			MissedAutoRebook: False,
			MissedRequireContact: False,
			MissedRequirePhoto: False,
			PayTiming: String,
			FinalPriceAfterCount: False,
			PayPlanName: String,
			PerPickup: 0,
			PerStop: 0,
			PerMissed: 0,
			PerCancel: 0,
			AcceptedUtc: 0001-01-01,
			Proof: 
			{
				String: String
			}
		},
		Items: 
		[
			{
				CourierItemID: 0,
				DispatchOdRequestID: 0,
				Seq: 0,
				TagCode: String,
				Custody: String,
				IsOpen: False,
				IsMissing: False,
				MissingReason: String,
				IsManual: False,
				ReTagFlag: False,
				Scanned: False
			}
		],
		Scans: 
		[
			{
				TagCode: String,
				Stage: String,
				Result: String,
				AtUtc: 0001-01-01
			}
		],
		Proof: 
		[
			{
				Stage: String,
				StepKey: String,
				Value: String,
				AtUtc: 0001-01-01
			}
		],
		Events: 
		[
			{
				Kind: String,
				Party: String,
				Body: String,
				AtUtc: 0001-01-01
			}
		],
		Photos: 
		[
			{
				PhotoId: 0,
				Kind: String,
				FileName: String,
				Url: String,
				TakenUtc: 0001-01-01
			}
		],
		PayLines: 
		[
			{
				DispatchLoadID: 0,
				Kind: String,
				Label: String,
				Qty: 0,
				Rate: 0,
				Amount: 0
			}
		]
	},
	Message: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}