Trendsic Platform Service

<back to all web services

RoutePlanWeekRequest

export class RoutePlanCrew
{
    public CrewID: number;
    public CrewName: string;
    public CrewColor: string;
    public HomeZip: string;
    public YardLat?: number;
    public YardLng?: number;
    public DailyCapacityMin: number;
    public WeeklyCapacityMin: number;
    public Specialist: boolean;

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

export class RoutePlanVisit
{
    public AgreementID: number;
    public AgreementJobID?: number;
    public Name: string;
    public Sub: string;
    public ServiceType: string;
    public Zip: string;
    public Area: string;
    public Lat?: number;
    public Lng?: number;
    public DurationMin: number;
    public DueIso: string;
    public DueLabel: string;
    public Overdue: boolean;
    public DefaultCrewID?: number;
    public RouteCrewID?: number;
    public RouteSeq?: number;
    public RouteDateIso: string;
    public LateDays: number;
    public AutoPay: boolean;
    public SkipPolicy: string;
    public SkipCreditAmount: number;

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

export class RoutePlanSkippedVisit
{
    public AgreementJobID: number;
    public AgreementID: number;
    public Name: string;
    public DateIso: string;
    public Reason: string;
    public CreditAmount: number;

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

export class RoutePlanWeekResponse
{
    public FromIso: string;
    public ToIso: string;
    public Crews: RoutePlanCrew[] = [];
    public Visits: RoutePlanVisit[] = [];
    public Skipped: RoutePlanSkippedVisit[] = [];
    public ResponseStatus: ResponseStatus;

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

export class RoutePlanWeekRequest
{
    public From: string;

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

TypeScript RoutePlanWeekRequest DTOs

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
		}
	}
}