Trendsic Platform Service

CourierProfileRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/courier/profiles/{Id}

**CourierProfileRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int	No
FacilityCode	query	string	No

**CourierResponse** Parameters:
Name	Parameter	Data Type	Required
Profiles	form	List<CourierProfileSummary>	No
Templates	form	List<CourierTemplateOption>	No
Profile	form	CourierProfileView	No
Issues	form	List<CourierIssue>	No
Changes	form	List<CourierChange>	No
Preview	form	CourierPreview	No
Fleet	form	List<CourierFleetVehicle>	No
ResponseStatus	form	ResponseStatus	No

**CourierProfileSummary** Parameters:
Name	Parameter	Data Type	Required
CourierProfileID	form	int	No
Code	form	string	No
Name	form	string	No
BusinessName	form	string	No
RouteShape	form	string	No
Enabled	form	bool	No
TemplateFrom	form	string	No
Drivers	form	int	No

**CourierTemplateOption** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Label	form	string	No
Detail	form	string	No
RouteShape	form	string	No

**CourierProfileView** Parameters:
Name	Parameter	Data Type	Required
CourierProfileID	form	int	No
Code	form	string	No
Name	form	string	No
BusinessName	form	string	No
RouteShape	form	string	No
Enabled	form	bool	No
TemplateFrom	form	string	No
UnitOne	form	string	No
UnitMany	form	string	No
FacilityNoun	form	string	No
UnitOneEs	form	string	No
UnitManyEs	form	string	No
FacilityNounEs	form	string	No
TagMode	form	string	No
TagFormats	form	List<string>	No
Pay	form	CourierPay	No
Dispatch	form	CourierDispatch	No
Missed	form	CourierMissed	No
Privacy	form	CourierPrivacy	No
Pricing	form	CourierPricing	No
Booking	form	CourierBooking	No
Facilities	form	List<CourierFacilityView>	No
Vehicles	form	List<CourierVehicleView>	No
Proof	form	Dictionary<string, Dictionary<String,String>>	No
Context	form	CourierProfileContext	No

**CourierPay** Parameters:
Name	Parameter	Data Type	Required
WorkerClass	form	string	No
PerPickup	form	decimal	No
PerStop	form	decimal	No
PerMissed	form	decimal	No
PerCancel	form	decimal	No
WaitAfterMin	form	int	No
WaitPerMin	form	decimal	No
MileageOn	form	bool	No
PerMile	form	decimal	No
MinPerJob	form	decimal	No
TipsPct	form	decimal	No

**CourierDispatch** Parameters:
Name	Parameter	Data Type	Required
PingSecs	form	int	No
RadiusMi	form	decimal	No
DeclinePenalty	form	bool	No
NextRule	form	string	No
GoMin	form	int	No
LastMin	form	int	No
NearFull	form	int	No
MarginMin	form	int	No
TrafficSource	form	string	No

**CourierMissed** Parameters:
Name	Parameter	Data Type	Required
WaitMin	form	int	No
Fee	form	decimal	No
CancelFee	form	decimal	No
AutoRebook	form	bool	No
RequireContact	form	bool	No
RequirePhoto	form	bool	No

**CourierPrivacy** Parameters:
Name	Parameter	Data Type	Required
ThreadHrs	form	int	No
PhotoDays	form	int	No
LockNames	form	string	No
HideAddr	form	bool	No
LiveEta	form	bool	No
Tipping	form	bool	No

**CourierPricing** Parameters:
Name	Parameter	Data Type	Required
Base	form	decimal	No
PerUnit	form	decimal	No
PerMile	form	decimal	No
MinOrder	form	decimal	No
TaxPct	form	decimal	No
FinalAfterCount	form	bool	No
ServiceArea	form	List<string>	No
WindowMin	form	int	No
Surcharges	form	Dictionary<string, decimal>	No

**CourierBooking** Parameters:
Name	Parameter	Data Type	Required
On	form	bool	No
Slug	form	string	No
Asap	form	bool	No
MinLeadMin	form	int	No
Open	form	string	No
Close	form	string	No
DriveBufferMin	form	int	No
Zips	form	List<string>	No
Recurring	form	bool	No
PayTiming	form	string	No

**CourierFacilityView** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
Address	form	string	No
IntakeMin	form	int	No
Levels	form	List<CourierLevelView>	No
Holidays	form	List<string>	No

**CourierLevelView** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
InBy	form	string	No
WithinMin	form	int	No
Ready	form	string	No
Days	form	List<int>	No
IsOn	form	bool	No

**CourierVehicleView** Parameters:
Name	Parameter	Data Type	Required
EquipmentID	form	int	No
UnitNumber	form	string	No
Name	form	string	No
Unit	form	string	No
Cap	form	decimal	No
Cold	form	bool	No

**CourierProfileContext** Parameters:
Name	Parameter	Data Type	Required
Drivers	form	int	No
ProfileCount	form	int	No
PayPlanId	form	int?	No
ZoneMode	form	string	No
ZoneName	form	string	No
ZoneCount	form	int	No
HasBookingPage	form	bool	No
HasRateConfig	form	bool	No
VehicleFacts	form	Dictionary<string, string>	No

**CourierIssue** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Section	form	string	No
Message	form	string	No

**CourierChange** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Section	form	string	No
Label	form	string	No
From	form	string	No
To	form	string	No

**CourierPreview** Parameters:
Name	Parameter	Data Type	Required
DeadlineTitle	form	string	No
DeadlineLead	form	string	No
RoomW	form	string	No
LastW	form	string	No
GoW	form	string	No
Zones	form	List<CourierPreviewLine>	No
PaySub	form	string	No
PayRows	form	List<CourierPreviewLine>	No
PayTotal	form	string	No
ProofRows	form	List<CourierPreviewLine>	No
Ping	form	string	No

**CourierPreviewLine** Parameters:
Name	Parameter	Data Type	Required
K	form	string	No
V	form	string	No
Dot	form	string	No

**CourierFleetVehicle** Parameters:
Name	Parameter	Data Type	Required
EquipmentID	form	int	No
UnitNumber	form	string	No
Name	form	string	No
VehicleType	form	string	No
Unit	form	string	No
Cap	form	decimal?	No
Cold	form	bool	No
Status	form	string	No
Assigned	form	bool	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.

GET /v1/dispatch/courier/profiles/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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

{
	Profiles: 
	[
		{
			CourierProfileID: 0,
			Code: String,
			Name: String,
			BusinessName: String,
			RouteShape: String,
			Enabled: False,
			TemplateFrom: String,
			Drivers: 0
		}
	],
	Templates: 
	[
		{
			Key: String,
			Label: String,
			Detail: String,
			RouteShape: String
		}
	],
	Profile: 
	{
		CourierProfileID: 0,
		Code: String,
		Name: String,
		BusinessName: String,
		RouteShape: String,
		Enabled: False,
		TemplateFrom: String,
		UnitOne: String,
		UnitMany: String,
		FacilityNoun: String,
		UnitOneEs: String,
		UnitManyEs: String,
		FacilityNounEs: String,
		TagMode: String,
		TagFormats: 
		[
			String
		],
		Pay: 
		{
			WorkerClass: String,
			PerPickup: 0,
			PerStop: 0,
			PerMissed: 0,
			PerCancel: 0,
			WaitAfterMin: 0,
			WaitPerMin: 0,
			MileageOn: False,
			PerMile: 0,
			MinPerJob: 0,
			TipsPct: 0
		},
		Dispatch: 
		{
			PingSecs: 0,
			RadiusMi: 0,
			DeclinePenalty: False,
			NextRule: String,
			GoMin: 0,
			LastMin: 0,
			NearFull: 0,
			MarginMin: 0,
			TrafficSource: String
		},
		Missed: 
		{
			WaitMin: 0,
			Fee: 0,
			CancelFee: 0,
			AutoRebook: False,
			RequireContact: False,
			RequirePhoto: False
		},
		Privacy: 
		{
			ThreadHrs: 0,
			PhotoDays: 0,
			LockNames: String,
			HideAddr: False,
			LiveEta: False,
			Tipping: False
		},
		Pricing: 
		{
			Base: 0,
			PerUnit: 0,
			PerMile: 0,
			MinOrder: 0,
			TaxPct: 0,
			FinalAfterCount: False,
			ServiceArea: 
			[
				String
			],
			WindowMin: 0,
			Surcharges: 
			{
				String: 0
			}
		},
		Booking: 
		{
			On: False,
			Slug: String,
			Asap: False,
			MinLeadMin: 0,
			Open: String,
			Close: String,
			DriveBufferMin: 0,
			Zips: 
			[
				String
			],
			Recurring: False,
			PayTiming: String
		},
		Facilities: 
		[
			{
				Code: String,
				Name: String,
				Address: String,
				IntakeMin: 0,
				Levels: 
				[
					{
						Code: String,
						Name: String,
						InBy: String,
						WithinMin: 0,
						Ready: String,
						Days: 
						[
							0
						],
						IsOn: False
					}
				],
				Holidays: 
				[
					String
				]
			}
		],
		Vehicles: 
		[
			{
				EquipmentID: 0,
				UnitNumber: String,
				Name: String,
				Unit: String,
				Cap: 0,
				Cold: False
			}
		],
		Proof: 
		{
			String: 
			{
				String: String
			}
		},
		Context: 
		{
			Drivers: 0,
			ProfileCount: 0,
			PayPlanId: 0,
			ZoneMode: String,
			ZoneName: String,
			ZoneCount: 0,
			HasBookingPage: False,
			HasRateConfig: False,
			VehicleFacts: 
			{
				String: String
			}
		}
	},
	Issues: 
	[
		{
			Key: String,
			Section: String,
			Message: String
		}
	],
	Changes: 
	[
		{
			Key: String,
			Section: String,
			Label: String,
			From: String,
			To: String
		}
	],
	Preview: 
	{
		DeadlineTitle: String,
		DeadlineLead: String,
		RoomW: String,
		LastW: String,
		GoW: String,
		Zones: 
		[
			{
				K: String,
				V: String,
				Dot: String
			}
		],
		PaySub: String,
		PayRows: 
		[
			{
				K: String,
				V: String,
				Dot: String
			}
		],
		PayTotal: String,
		ProofRows: 
		[
			{
				K: String,
				V: String,
				Dot: String
			}
		],
		Ping: String
	},
	Fleet: 
	[
		{
			EquipmentID: 0,
			UnitNumber: String,
			Name: String,
			VehicleType: String,
			Unit: String,
			Cap: 0,
			Cold: False,
			Status: String,
			Assigned: False
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}