Trendsic Platform Service

CourierPickupRequest

The following routes are available for this service:
POST,OPTIONS	/v1/worker/dispatch/od/{Code}/pickup

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 CourierDriverOrder
    {
        public virtual string Code { get; set; }
        public virtual string CourierStep { get; set; }
        public virtual string RouteShape { get; set; }
        public virtual string ProfileName { get; set; }
        public virtual string UnitOne { get; set; }
        public virtual string UnitMany { get; set; }
        public virtual string FacilityNoun { get; set; }
        public virtual string FacilityName { get; set; }
        public virtual string LevelName { get; set; }
        public virtual DateTime? DueUtc { get; set; }
        public virtual string DueText { get; set; }
        public virtual int Units { get; set; }
        public virtual int? UnitsFound { get; set; }
        public virtual string Area { get; set; }
        public virtual int? Minutes { get; set; }
        public virtual string Address { get; set; }
        public virtual string Unit { get; set; }
        public virtual string City { get; set; }
        public virtual decimal? Lat { get; set; }
        public virtual decimal? Lng { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string CustomerPhone { get; set; }
        public virtual string Handoff { get; set; }
        public virtual string GateCode { get; set; }
        public virtual string Instructions { get; set; }
        public virtual string DropoffAddress { get; set; }
        public virtual string DropoffContactName { get; set; }
        public virtual decimal? DropLat { get; set; }
        public virtual decimal? DropLng { get; set; }
        public virtual DateTime? ArrivedUtc { get; set; }
        public virtual List<CourierItemView> Tags { get; set; } = [];
        public virtual Dictionary<string, string> Proof { get; set; } = new();
        public virtual Dictionary<string, int> Photos { get; set; } = new();
        public virtual List<string> Needs { get; set; } = [];
        public virtual int MissedWaitMin { get; set; }
        public virtual bool MissedRequireContact { get; set; }
        public virtual bool MissedRequirePhoto { get; set; }
        public virtual decimal MissedFee { get; set; }
    }

    public partial class CourierDriverResponse
    {
        public virtual CourierDriverView Courier { get; set; }
        public virtual string Result { get; set; }
        public virtual string Detail { get; set; }
        public virtual string Message { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class CourierDriverView
    {
        public virtual string DriverCode { get; set; }
        public virtual string Name { get; set; }
        public virtual bool Online { get; set; }
        public virtual bool OnRoster { get; set; }
        public virtual CourierVanView Van { get; set; }
        public virtual CourierDriverOrder Current { get; set; }
        public virtual List<CourierDriverOrder> Queue { get; set; } = [];
        public virtual List<CourierDriverOrder> Aboard { get; set; } = [];
        public virtual List<CourierRunView> Runs { get; set; } = [];
        public virtual CourierDriverOrder UpNext { get; set; }
    }

    public partial class CourierItemView
    {
        public virtual int CourierItemID { get; set; }
        public virtual int DispatchOdRequestID { get; set; }
        public virtual int Seq { get; set; }
        public virtual string TagCode { get; set; }
        public virtual string Custody { get; set; }
        public virtual bool IsOpen { get; set; }
        public virtual bool IsMissing { get; set; }
        public virtual string MissingReason { get; set; }
        public virtual bool IsManual { get; set; }
        public virtual bool ReTagFlag { get; set; }
        public virtual bool Scanned { get; set; }
    }

    public partial class CourierPickupRequest
    {
        public virtual string Code { get; set; }
        public virtual int UnitsFound { get; set; }
        public virtual bool DamageChecked { get; set; }
        public virtual string DamageNote { get; set; }
    }

    public partial class CourierRunView
    {
        public virtual int CourierRunID { get; set; }
        public virtual string Code { get; set; }
        public virtual string Status { get; set; }
        public virtual int CourierProfileId { get; set; }
        public virtual string ProfileName { get; set; }
        public virtual int CourierFacilityId { get; set; }
        public virtual string FacilityName { get; set; }
        public virtual string FacilityAddress { get; set; }
        public virtual int? DriverContactId { get; set; }
        public virtual string DriverName { get; set; }
        public virtual int? EquipmentID { get; set; }
        public virtual string VehicleUnit { get; set; }
        public virtual string UnitOne { get; set; }
        public virtual string UnitMany { get; set; }
        public virtual int Units { get; set; }
        public virtual int StopCount { get; set; }
        public virtual int StopsDone { get; set; }
        public virtual decimal? Pay { get; set; }
        public virtual DateTime? BuiltUtc { get; set; }
        public virtual DateTime? StartedUtc { get; set; }
        public virtual DateTime? CompletedUtc { get; set; }
        public virtual int ToLoad { get; set; }
        public virtual int ToReturn { get; set; }
        public virtual List<CourierStopView> Stops { get; set; } = [];
    }

    public partial class CourierStopView
    {
        public virtual int Sequence { get; set; }
        public virtual string Status { get; set; }
        public virtual int DispatchOdRequestID { get; set; }
        public virtual string Code { get; set; }
        public virtual string CourierStep { get; set; }
        public virtual string Address { get; set; }
        public virtual string Unit { get; set; }
        public virtual string City { get; set; }
        public virtual string Zip { get; set; }
        public virtual decimal? Lat { get; set; }
        public virtual decimal? Lng { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string CustomerPhone { get; set; }
        public virtual string Handoff { get; set; }
        public virtual string GateCode { get; set; }
        public virtual string Instructions { get; set; }
        public virtual int Units { get; set; }
        public virtual string DueText { get; set; }
        public virtual string Note { get; set; }
        public virtual List<string> Needs { get; set; } = [];
        public virtual List<CourierItemView> Items { get; set; } = [];
    }

    public partial class CourierVanView
    {
        public virtual string State { get; set; }
        public virtual DateTime? LeaveByUtc { get; set; }
        public virtual string LeaveByText { get; set; }
        public virtual int? SlackMin { get; set; }
        public virtual int InVan { get; set; }
        public virtual int Committed { get; set; }
        public virtual decimal? Cap { get; set; }
        public virtual string CapUnit { get; set; }
        public virtual string VehicleUnit { get; set; }
        public virtual string CriticalCode { get; set; }
        public virtual int DriveMin { get; set; }
        public virtual string FacilityName { get; set; }
        public virtual string SendNote { get; set; }
    }

}

C# CourierPickupRequest 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/od/{Code}/pickup HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Code: String,
	UnitsFound: 0,
	DamageChecked: False,
	DamageNote: String
}

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

{
	Courier: 
	{
		DriverCode: String,
		Name: String,
		Online: False,
		OnRoster: False,
		Van: 
		{
			State: String,
			LeaveByUtc: 0001-01-01,
			LeaveByText: String,
			SlackMin: 0,
			InVan: 0,
			Committed: 0,
			Cap: 0,
			CapUnit: String,
			VehicleUnit: String,
			CriticalCode: String,
			DriveMin: 0,
			FacilityName: String,
			SendNote: String
		},
		Current: 
		{
			Code: String,
			CourierStep: String,
			RouteShape: String,
			ProfileName: String,
			UnitOne: String,
			UnitMany: String,
			FacilityNoun: String,
			FacilityName: String,
			LevelName: String,
			DueUtc: 0001-01-01,
			DueText: String,
			Units: 0,
			UnitsFound: 0,
			Area: String,
			Minutes: 0,
			Address: String,
			Unit: String,
			City: String,
			Lat: 0,
			Lng: 0,
			CustomerName: String,
			CustomerPhone: String,
			Handoff: String,
			GateCode: String,
			Instructions: String,
			DropoffAddress: String,
			DropoffContactName: String,
			DropLat: 0,
			DropLng: 0,
			ArrivedUtc: 0001-01-01,
			Tags: 
			[
				{
					CourierItemID: 0,
					DispatchOdRequestID: 0,
					Seq: 0,
					TagCode: String,
					Custody: String,
					IsOpen: False,
					IsMissing: False,
					MissingReason: String,
					IsManual: False,
					ReTagFlag: False,
					Scanned: False
				}
			],
			Proof: 
			{
				String: String
			},
			Photos: 
			{
				String: 0
			},
			Needs: 
			[
				String
			],
			MissedWaitMin: 0,
			MissedRequireContact: False,
			MissedRequirePhoto: False,
			MissedFee: 0
		},
		Queue: 
		[
			{
				Code: String,
				CourierStep: String,
				RouteShape: String,
				ProfileName: String,
				UnitOne: String,
				UnitMany: String,
				FacilityNoun: String,
				FacilityName: String,
				LevelName: String,
				DueUtc: 0001-01-01,
				DueText: String,
				Units: 0,
				UnitsFound: 0,
				Area: String,
				Minutes: 0,
				Address: String,
				Unit: String,
				City: String,
				Lat: 0,
				Lng: 0,
				CustomerName: String,
				CustomerPhone: String,
				Handoff: String,
				GateCode: String,
				Instructions: String,
				DropoffAddress: String,
				DropoffContactName: String,
				DropLat: 0,
				DropLng: 0,
				ArrivedUtc: 0001-01-01,
				Tags: 
				[
					{
						CourierItemID: 0,
						DispatchOdRequestID: 0,
						Seq: 0,
						TagCode: String,
						Custody: String,
						IsOpen: False,
						IsMissing: False,
						MissingReason: String,
						IsManual: False,
						ReTagFlag: False,
						Scanned: False
					}
				],
				Proof: 
				{
					String: String
				},
				Photos: 
				{
					String: 0
				},
				Needs: 
				[
					String
				],
				MissedWaitMin: 0,
				MissedRequireContact: False,
				MissedRequirePhoto: False,
				MissedFee: 0
			}
		],
		Aboard: 
		[
			{
				Code: String,
				CourierStep: String,
				RouteShape: String,
				ProfileName: String,
				UnitOne: String,
				UnitMany: String,
				FacilityNoun: String,
				FacilityName: String,
				LevelName: String,
				DueUtc: 0001-01-01,
				DueText: String,
				Units: 0,
				UnitsFound: 0,
				Area: String,
				Minutes: 0,
				Address: String,
				Unit: String,
				City: String,
				Lat: 0,
				Lng: 0,
				CustomerName: String,
				CustomerPhone: String,
				Handoff: String,
				GateCode: String,
				Instructions: String,
				DropoffAddress: String,
				DropoffContactName: String,
				DropLat: 0,
				DropLng: 0,
				ArrivedUtc: 0001-01-01,
				Tags: 
				[
					{
						CourierItemID: 0,
						DispatchOdRequestID: 0,
						Seq: 0,
						TagCode: String,
						Custody: String,
						IsOpen: False,
						IsMissing: False,
						MissingReason: String,
						IsManual: False,
						ReTagFlag: False,
						Scanned: False
					}
				],
				Proof: 
				{
					String: String
				},
				Photos: 
				{
					String: 0
				},
				Needs: 
				[
					String
				],
				MissedWaitMin: 0,
				MissedRequireContact: False,
				MissedRequirePhoto: False,
				MissedFee: 0
			}
		],
		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
							}
						]
					}
				]
			}
		],
		UpNext: 
		{
			Code: String,
			CourierStep: String,
			RouteShape: String,
			ProfileName: String,
			UnitOne: String,
			UnitMany: String,
			FacilityNoun: String,
			FacilityName: String,
			LevelName: String,
			DueUtc: 0001-01-01,
			DueText: String,
			Units: 0,
			UnitsFound: 0,
			Area: String,
			Minutes: 0,
			Address: String,
			Unit: String,
			City: String,
			Lat: 0,
			Lng: 0,
			CustomerName: String,
			CustomerPhone: String,
			Handoff: String,
			GateCode: String,
			Instructions: String,
			DropoffAddress: String,
			DropoffContactName: String,
			DropLat: 0,
			DropLng: 0,
			ArrivedUtc: 0001-01-01,
			Tags: 
			[
				{
					CourierItemID: 0,
					DispatchOdRequestID: 0,
					Seq: 0,
					TagCode: String,
					Custody: String,
					IsOpen: False,
					IsMissing: False,
					MissingReason: String,
					IsManual: False,
					ReTagFlag: False,
					Scanned: False
				}
			],
			Proof: 
			{
				String: String
			},
			Photos: 
			{
				String: 0
			},
			Needs: 
			[
				String
			],
			MissedWaitMin: 0,
			MissedRequireContact: False,
			MissedRequirePhoto: False,
			MissedFee: 0
		}
	},
	Result: String,
	Detail: String,
	Message: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}