Trendsic Platform Service

CourierTrackRatingRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/track/{Token}/rating

**CourierTrackRatingRequest** Parameters:
Name	Parameter	Data Type	Required
Stars	body	int	No
Tags	body	List<string>	No
Tip	body	decimal?	No

**CourierTrackActRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Token	form	string	No
ActToken	form	string	No

**DispatchTrackResponse** Parameters:
Name	Parameter	Data Type	Required
Kind	form	string	No
Code	form	string	No
What	form	string	No
FromLoc	form	string	No
ToLoc	form	string	No
Bags	form	int?	No
Fare	form	decimal?	No
PayMode	form	string	No
CardLast4	form	string	No
Charged	form	bool	No
Stage	form	string	No
Headline	form	string	No
Sub	form	string	No
IsClosed	form	bool	No
Eta	form	string	No
DriverName	form	string	No
CustomerName	form	string	No
Steps	form	List<DispatchTrackStepView>	No
Expired	form	bool	No
Invalid	form	bool	No
Business	form	CourierTrackBusiness	No
Courier	form	CourierTrackView	No
Notice	form	string	No
ResponseStatus	form	ResponseStatus	No

**DispatchTrackStepView** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
At	form	DateTime?	No
Done	form	bool	No
Current	form	bool	No

**CourierTrackBusiness** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Phone	form	string	No

**CourierTrackView** Parameters:
Name	Parameter	Data Type	Required
State	form	string	No
Code	form	string	No
RunCode	form	string	No
Shape	form	string	No
Template	form	string	No
CourierStep	form	string	No
UnitOne	form	string	No
UnitMany	form	string	No
UnitOneEs	form	string	No
UnitManyEs	form	string	No
FacilityNoun	form	string	No
FacilityNounEs	form	string	No
Units	form	int	No
UnitsCounted	form	bool	No
Address	form	string	No
DropoffAddress	form	string	No
DropoffName	form	string	No
Instructions	form	string	No
GateCode	form	string	No
Handoff	form	string	No
LevelName	form	string	No
ReadyPromise	form	string	No
WindowText	form	string	No
IsAsap	form	bool	No
Times	form	Dictionary<string, string>	No
StopPosition	form	int?	No
StopCount	form	int?	No
DeliveryWindowText	form	string	No
Driver	form	CourierTrackDriver	No
Proof	form	CourierTrackProof	No
HandoffCode	form	string	No
Rating	form	CourierTrackRating	No
TipAllowed	form	bool	No
TipsPct	form	decimal	No
Missed	form	CourierTrackMissed	No
CancelFee	form	decimal	No
CancelFeeCharged	form	decimal	No
CancelledBy	form	string	No
BookUrl	form	string	No
Can	form	CourierTrackCan	No
DeliverySlots	form	List<CourierTrackSlot>	No
Messages	form	List<CourierTrackMessage>	No
MessagesOpen	form	bool	No
CaseCode	form	string	No
CaseStatus	form	string	No
CaseReply	form	string	No
ThreadHrs	form	int	No
ExpiresUtc	form	DateTime?	No
LiveEta	form	bool	No
Live	form	bool	No
ServerUtc	form	DateTime	No

**CourierTrackDriver** Parameters:
Name	Parameter	Data Type	Required
FirstName	form	string	No
Initial	form	string	No
Vehicle	form	string	No
Plate	form	string	No
EtaMin	form	int?	No
EtaPct	form	int?	No

**CourierTrackProof** Parameters:
Name	Parameter	Data Type	Required
Kind	form	string	No
PhotoUrl	form	string	No
AtText	form	string	No
GpsOk	form	bool	No
Units	form	int	No
DamageNote	form	string	No
DeliveredTo	form	string	No
WaitedMin	form	int	No
Attempts	form	int	No
ContactedText	form	string	No
EachTagged	form	bool	No
EachScanned	form	bool	No

**CourierTrackRating** Parameters:
Name	Parameter	Data Type	Required
Stars	form	int	No
Tags	form	string	No
Tip	form	decimal	No
TipStatus	form	string	No

**CourierTrackMissed** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Fee	form	decimal	No
WaitedMin	form	int	No
AutoRebook	form	bool	No
RebookWindowText	form	string	No
Slots	form	List<CourierTrackSlot>	No

**CourierTrackSlot** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Day	form	string	No
DayEs	form	string	No
Win	form	string	No

**CourierTrackCan** Parameters:
Name	Parameter	Data Type	Required
EditInstructions	form	bool	No
ChangeUnits	form	bool	No
Cancel	form	bool	No
RescheduleDelivery	form	bool	No
Rebook	form	bool	No
Rate	form	bool	No
Message	form	bool	No
Report	form	bool	No
MaxUnits	form	int	No

**CourierTrackMessage** Parameters:
Name	Parameter	Data Type	Required
Who	form	string	No
Mine	form	bool	No
Office	form	bool	No
AtText	form	string	No
Body	form	string	No

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

{
	Stars: 0,
	Tags: 
	[
		String
	],
	Tip: 0,
	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
		}
	}
}