Trendsic Platform Service

RoutePlanWeekRequest

The following routes are available for this service:
GET,OPTIONS	/v1/routeplan/week

**RoutePlanWeekRequest** Parameters:
Name	Parameter	Data Type	Required	Description
From	query	string	No

**RoutePlanWeekResponse** Parameters:
Name	Parameter	Data Type	Required
FromIso	form	string	No
ToIso	form	string	No
Crews	form	List<RoutePlanCrew>	No
Visits	form	List<RoutePlanVisit>	No
Skipped	form	List<RoutePlanSkippedVisit>	No
ResponseStatus	form	ResponseStatus	No

**RoutePlanCrew** Parameters:
Name	Parameter	Data Type	Required
CrewID	form	int	No
CrewName	form	string	No
CrewColor	form	string	No
HomeZip	form	string	No
YardLat	form	double?	No
YardLng	form	double?	No
DailyCapacityMin	form	int	No
WeeklyCapacityMin	form	int	No
Specialist	form	bool	No

**RoutePlanVisit** Parameters:
Name	Parameter	Data Type	Required
AgreementID	form	int	No
AgreementJobID	form	int?	No
Name	form	string	No
Sub	form	string	No
ServiceType	form	string	No
Zip	form	string	No
Area	form	string	No
Lat	form	double?	No
Lng	form	double?	No
DurationMin	form	int	No
DueIso	form	string	No
DueLabel	form	string	No
Overdue	form	bool	No
DefaultCrewID	form	int?	No
RouteCrewID	form	int?	No
RouteSeq	form	int?	No
RouteDateIso	form	string	No
LateDays	form	int	No
AutoPay	form	bool	No
SkipPolicy	form	string	No
SkipCreditAmount	form	decimal	No

**RoutePlanSkippedVisit** Parameters:
Name	Parameter	Data Type	Required
AgreementJobID	form	int	No
AgreementID	form	int	No
Name	form	string	No
DateIso	form	string	No
Reason	form	string	No
CreditAmount	form	decimal	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/routeplan/week HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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

{
	FromIso: String,
	ToIso: String,
	Crews: 
	[
		{
			CrewID: 0,
			CrewName: String,
			CrewColor: String,
			HomeZip: String,
			YardLat: 0,
			YardLng: 0,
			DailyCapacityMin: 0,
			WeeklyCapacityMin: 0,
			Specialist: False
		}
	],
	Visits: 
	[
		{
			AgreementID: 0,
			AgreementJobID: 0,
			Name: String,
			Sub: String,
			ServiceType: String,
			Zip: String,
			Area: String,
			Lat: 0,
			Lng: 0,
			DurationMin: 0,
			DueIso: String,
			DueLabel: String,
			Overdue: False,
			DefaultCrewID: 0,
			RouteCrewID: 0,
			RouteSeq: 0,
			RouteDateIso: String,
			LateDays: 0,
			AutoPay: False,
			SkipPolicy: String,
			SkipCreditAmount: 0
		}
	],
	Skipped: 
	[
		{
			AgreementJobID: 0,
			AgreementID: 0,
			Name: String,
			DateIso: String,
			Reason: String,
			CreditAmount: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}