Trendsic Platform Service

<back to all web services

AgreementPlannerRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/planner

export class AgreementPlannerRow
{
    public AgreementID: number;
    public Name: string;
    public ProjectName: string;
    public ServiceType: string;
    public Area: string;
    public Zip: string;
    public Frequency: string;
    public NextDueIso: string;
    public NextDueLabel: string;
    public Overdue: boolean;
    public DurationMin: number;
    public EligibleDow: number[] = [];
    public ScheduledDow: number;
    public WeeklyAll: boolean;
    public DueThisWeek: boolean;
    public AssignedCrewID?: number;
    public AssignedCrewName: string;
    public ThisWeekJobID?: number;
    public ThisWeekBackingJobID?: number;
    public ThisWeekOccIso: string;
    public ThisWeekStandingIso: string;
    public StandingDow?: number;
    public Moved: boolean;

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

export class AgreementPlannerCrew
{
    public CrewID: number;
    public CrewName: string;
    public CrewColor: string;

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

export class AgreementPlannerResponse
{
    public ResponseStatus: ResponseStatus;
    public FromIso: string;
    public ToIso: string;
    public WeekdayCapacity: number;
    public Rows: AgreementPlannerRow[] = [];
    public Crews: AgreementPlannerCrew[] = [];

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

export class AgreementPlannerRequest
{
    public From: string;
    public Scope: string;

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

TypeScript AgreementPlannerRequest DTOs

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	FromIso: String,
	ToIso: String,
	WeekdayCapacity: 0,
	Rows: 
	[
		{
			AgreementID: 0,
			Name: String,
			ProjectName: String,
			ServiceType: String,
			Area: String,
			Zip: String,
			Frequency: String,
			NextDueIso: String,
			NextDueLabel: String,
			Overdue: False,
			DurationMin: 0,
			EligibleDow: 
			[
				0
			],
			ScheduledDow: 0,
			WeeklyAll: False,
			DueThisWeek: False,
			AssignedCrewID: 0,
			AssignedCrewName: String,
			ThisWeekJobID: 0,
			ThisWeekBackingJobID: 0,
			ThisWeekOccIso: String,
			ThisWeekStandingIso: String,
			StandingDow: 0,
			Moved: False
		}
	],
	Crews: 
	[
		{
			CrewID: 0,
			CrewName: String,
			CrewColor: String
		}
	]
}