Trendsic Platform Service

<back to all web services

CourierTrackProblemRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/track/{Token}/problem
CourierTrackProblemRequest Parameters:
NameParameterData TypeRequiredDescription
ReasonbodystringNo
NotebodystringNo
PhotosbodyList<string>No
CourierTrackActRequest Parameters:
NameParameterData TypeRequiredDescription
TokenformstringNo
ActTokenformstringNo
DispatchTrackResponse Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
CodeformstringNo
WhatformstringNo
FromLocformstringNo
ToLocformstringNo
Bagsformint?No
Fareformdecimal?No
PayModeformstringNo
CardLast4formstringNo
ChargedformboolNo
StageformstringNo
HeadlineformstringNo
SubformstringNo
IsClosedformboolNo
EtaformstringNo
DriverNameformstringNo
CustomerNameformstringNo
StepsformList<DispatchTrackStepView>No
ExpiredformboolNo
InvalidformboolNo
BusinessformCourierTrackBusinessNo
CourierformCourierTrackViewNo
NoticeformstringNo
ResponseStatusformResponseStatusNo
DispatchTrackStepView Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
AtformDateTime?No
DoneformboolNo
CurrentformboolNo
CourierTrackBusiness Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PhoneformstringNo
CourierTrackView Parameters:
NameParameterData TypeRequiredDescription
StateformstringNo
CodeformstringNo
RunCodeformstringNo
ShapeformstringNo
TemplateformstringNo
CourierStepformstringNo
UnitOneformstringNo
UnitManyformstringNo
UnitOneEsformstringNo
UnitManyEsformstringNo
FacilityNounformstringNo
FacilityNounEsformstringNo
UnitsformintNo
UnitsCountedformboolNo
AddressformstringNo
DropoffAddressformstringNo
DropoffNameformstringNo
InstructionsformstringNo
GateCodeformstringNo
HandoffformstringNo
LevelNameformstringNo
ReadyPromiseformstringNo
WindowTextformstringNo
IsAsapformboolNo
TimesformDictionary<string, string>No
StopPositionformint?No
StopCountformint?No
DeliveryWindowTextformstringNo
DriverformCourierTrackDriverNo
ProofformCourierTrackProofNo
HandoffCodeformstringNo
RatingformCourierTrackRatingNo
TipAllowedformboolNo
TipsPctformdecimalNo
MissedformCourierTrackMissedNo
CancelFeeformdecimalNo
CancelFeeChargedformdecimalNo
CancelledByformstringNo
BookUrlformstringNo
CanformCourierTrackCanNo
DeliverySlotsformList<CourierTrackSlot>No
MessagesformList<CourierTrackMessage>No
MessagesOpenformboolNo
CaseCodeformstringNo
CaseStatusformstringNo
CaseReplyformstringNo
ThreadHrsformintNo
ExpiresUtcformDateTime?No
LiveEtaformboolNo
LiveformboolNo
ServerUtcformDateTimeNo
CourierTrackDriver Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
InitialformstringNo
VehicleformstringNo
PlateformstringNo
EtaMinformint?No
EtaPctformint?No
CourierTrackProof Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
PhotoUrlformstringNo
AtTextformstringNo
GpsOkformboolNo
UnitsformintNo
DamageNoteformstringNo
DeliveredToformstringNo
WaitedMinformintNo
AttemptsformintNo
ContactedTextformstringNo
EachTaggedformboolNo
EachScannedformboolNo
CourierTrackRating Parameters:
NameParameterData TypeRequiredDescription
StarsformintNo
TagsformstringNo
TipformdecimalNo
TipStatusformstringNo
CourierTrackMissed Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
FeeformdecimalNo
WaitedMinformintNo
AutoRebookformboolNo
RebookWindowTextformstringNo
SlotsformList<CourierTrackSlot>No
CourierTrackSlot Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DayformstringNo
DayEsformstringNo
WinformstringNo
CourierTrackCan Parameters:
NameParameterData TypeRequiredDescription
EditInstructionsformboolNo
ChangeUnitsformboolNo
CancelformboolNo
RescheduleDeliveryformboolNo
RebookformboolNo
RateformboolNo
MessageformboolNo
ReportformboolNo
MaxUnitsformintNo
CourierTrackMessage Parameters:
NameParameterData TypeRequiredDescription
WhoformstringNo
MineformboolNo
OfficeformboolNo
AtTextformstringNo
BodyformstringNo

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/track/{Token}/problem HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Reason: String,
	Note: String,
	Photos: 
	[
		String
	],
	Token: String,
	ActToken: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Kind: String,
	Code: String,
	What: String,
	FromLoc: String,
	ToLoc: String,
	Bags: 0,
	Fare: 0,
	PayMode: String,
	CardLast4: String,
	Charged: False,
	Stage: String,
	Headline: String,
	Sub: String,
	IsClosed: False,
	Eta: String,
	DriverName: String,
	CustomerName: String,
	Steps: 
	[
		{
			Name: String,
			At: 0001-01-01,
			Done: False,
			Current: False
		}
	],
	Expired: False,
	Invalid: False,
	Business: 
	{
		Name: String,
		Phone: String
	},
	Courier: 
	{
		State: String,
		Code: String,
		RunCode: String,
		Shape: String,
		Template: String,
		CourierStep: String,
		UnitOne: String,
		UnitMany: String,
		UnitOneEs: String,
		UnitManyEs: String,
		FacilityNoun: String,
		FacilityNounEs: String,
		Units: 0,
		UnitsCounted: False,
		Address: String,
		DropoffAddress: String,
		DropoffName: String,
		Instructions: String,
		GateCode: String,
		Handoff: String,
		LevelName: String,
		ReadyPromise: String,
		WindowText: String,
		IsAsap: False,
		Times: 
		{
			String: String
		},
		StopPosition: 0,
		StopCount: 0,
		DeliveryWindowText: String,
		Driver: 
		{
			FirstName: String,
			Initial: String,
			Vehicle: String,
			Plate: String,
			EtaMin: 0,
			EtaPct: 0
		},
		Proof: 
		{
			Kind: String,
			PhotoUrl: String,
			AtText: String,
			GpsOk: False,
			Units: 0,
			DamageNote: String,
			DeliveredTo: String,
			WaitedMin: 0,
			Attempts: 0,
			ContactedText: String,
			EachTagged: False,
			EachScanned: False
		},
		HandoffCode: String,
		Rating: 
		{
			Stars: 0,
			Tags: String,
			Tip: 0,
			TipStatus: String
		},
		TipAllowed: False,
		TipsPct: 0,
		Missed: 
		{
			Code: String,
			Fee: 0,
			WaitedMin: 0,
			AutoRebook: False,
			RebookWindowText: String,
			Slots: 
			[
				{
					Id: String,
					Day: String,
					DayEs: String,
					Win: String
				}
			]
		},
		CancelFee: 0,
		CancelFeeCharged: 0,
		CancelledBy: String,
		BookUrl: String,
		Can: 
		{
			EditInstructions: False,
			ChangeUnits: False,
			Cancel: False,
			RescheduleDelivery: False,
			Rebook: False,
			Rate: False,
			Message: False,
			Report: False,
			MaxUnits: 0
		},
		DeliverySlots: 
		[
			{
				Id: String,
				Day: String,
				DayEs: String,
				Win: String
			}
		],
		Messages: 
		[
			{
				Who: String,
				Mine: False,
				Office: False,
				AtText: String,
				Body: String
			}
		],
		MessagesOpen: False,
		CaseCode: String,
		CaseStatus: String,
		CaseReply: String,
		ThreadHrs: 0,
		ExpiresUtc: 0001-01-01,
		LiveEta: False,
		Live: False,
		ServerUtc: 0001-01-01
	},
	Notice: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}