Trendsic Platform Service

<back to all web services

CourierRunBuildRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/runs

export class CourierItemView
{
    public CourierItemID: number;
    public DispatchOdRequestID: number;
    public Seq: number;
    public TagCode: string;
    public Custody: string;
    public IsOpen: boolean;
    public IsMissing: boolean;
    public MissingReason: string;
    public IsManual: boolean;
    public ReTagFlag: boolean;
    public Scanned: boolean;

    public constructor(init?: Partial<CourierItemView>) { (Object as any).assign(this, init); }
}

export class CourierStopView
{
    public Sequence: number;
    public Status: string;
    public DispatchOdRequestID: number;
    public Code: string;
    public CourierStep: string;
    public Address: string;
    public Unit: string;
    public City: string;
    public Zip: string;
    public Lat?: number;
    public Lng?: number;
    public CustomerName: string;
    public CustomerPhone: string;
    public Handoff: string;
    public GateCode: string;
    public Instructions: string;
    public Units: number;
    public DueText: string;
    public Note: string;
    public Needs: string[] = [];
    public Items: CourierItemView[] = [];

    public constructor(init?: Partial<CourierStopView>) { (Object as any).assign(this, init); }
}

export class CourierRunView
{
    public CourierRunID: number;
    public Code: string;
    public Status: string;
    public CourierProfileId: number;
    public ProfileName: string;
    public CourierFacilityId: number;
    public FacilityName: string;
    public FacilityAddress: string;
    public DriverContactId?: number;
    public DriverName: string;
    public EquipmentID?: number;
    public VehicleUnit: string;
    public UnitOne: string;
    public UnitMany: string;
    public Units: number;
    public StopCount: number;
    public StopsDone: number;
    public Pay?: number;
    public BuiltUtc?: string;
    public StartedUtc?: string;
    public CompletedUtc?: string;
    public ToLoad: number;
    public ToReturn: number;
    public Stops: CourierStopView[] = [];

    public constructor(init?: Partial<CourierRunView>) { (Object as any).assign(this, init); }
}

export class CourierRunResponse
{
    public Runs: CourierRunView[] = [];
    public Run: CourierRunView;
    public Message: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CourierRunResponse>) { (Object as any).assign(this, init); }
}

export class CourierRunBuildRequest
{
    public ProfileId: number;
    public FacilityCode: string;
    public Codes: string[] = [];
    public DriverContactId?: number;
    public EquipmentID?: number;

    public constructor(init?: Partial<CourierRunBuildRequest>) { (Object as any).assign(this, init); }
}

TypeScript CourierRunBuildRequest 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/runs HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProfileId: 0,
	FacilityCode: String,
	Codes: 
	[
		String
	],
	DriverContactId: 0,
	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
		}
	}
}