Trendsic Platform Service

<back to all web services

PlanningRequest

export class OtRow
{
    public ContactID: number;
    public WorkerName: string;
    public ClassCode: string;
    public Crew: string;
    public Job: string;
    public PatternLabel: string;
    public ProjHours: number;
    public OtHours: number;
    public DtHours: number;
    public OtCost?: number;
    public State: string;
    public Tone: string;

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

export class OtExposureBoard
{
    public TotalOtCost?: number;
    public TotalOtHours: number;
    public OverCount: number;
    public WorkerCount: number;
    public Rows: OtRow[] = [];

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

export class PerDiemJobRow
{
    public Job: string;
    public Total: number;
    public NonTax: number;
    public Tax: number;
    public Days: number;
    public AwayCount: number;
    public DayRateFlag: boolean;

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

export class PerDiemBoard
{
    public TotalCost: number;
    public NonTaxable: number;
    public Taxable: number;
    public AwayCount: number;
    public Jobs: PerDiemJobRow[] = [];

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

export class MarginJobRow
{
    public Job: string;
    public BasePct: number;
    public ProjPct: number;
    public FadePts: number;
    public Severity: string;
    public OtCost?: number;
    public PerDiem: number;

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

export class MarginBoard
{
    public JobCount: number;
    public TotalFade?: number;
    public Jobs: MarginJobRow[] = [];

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

export class UtilRow
{
    public ContactID: number;
    public WorkerName: string;
    public Crew: string;
    public ProjHours: number;
    public BaselineHours: number;
    public Pct: number;
    public Band: string;

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

export class UtilizationBoard
{
    public UnderCount: number;
    public OverCount: number;
    public Rows: UtilRow[] = [];

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

export class PlanningSuggestion
{
    public Id: string;
    public Kind: string;
    public Title: string;
    public Detail: string;
    public SaveText: string;
    public Effect: string;
    public RuleId: string;
    public LegalNote: string;
    public ApplyLabel: string;
    public Severity: string;

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

export class PlanningSurface
{
    public WeekLabel: string;
    public WeekStart: string;
    public WorkerCount: number;
    public Ot: OtExposureBoard;
    public PerDiem: PerDiemBoard;
    public Margin: MarginBoard;
    public Utilization: UtilizationBoard;
    public Suggestions: PlanningSuggestion[] = [];

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

export class PlanningResponse
{
    public Surface: PlanningSurface;
    public CanSeePay: boolean;
    public ResponseStatus: ResponseStatus;

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

export class PlanningRequest
{
    public AsOf?: string;

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

TypeScript PlanningRequest DTOs

GET /v1/workforce/planning HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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

{
	Surface: 
	{
		WeekLabel: String,
		WeekStart: 0001-01-01,
		WorkerCount: 0,
		Ot: 
		{
			TotalOtCost: 0,
			TotalOtHours: 0,
			OverCount: 0,
			WorkerCount: 0,
			Rows: 
			[
				{
					ContactID: 0,
					WorkerName: String,
					ClassCode: String,
					Crew: String,
					Job: String,
					PatternLabel: String,
					ProjHours: 0,
					OtHours: 0,
					DtHours: 0,
					OtCost: 0,
					State: String,
					Tone: String
				}
			]
		},
		PerDiem: 
		{
			TotalCost: 0,
			NonTaxable: 0,
			Taxable: 0,
			AwayCount: 0,
			Jobs: 
			[
				{
					Job: String,
					Total: 0,
					NonTax: 0,
					Tax: 0,
					Days: 0,
					AwayCount: 0,
					DayRateFlag: False
				}
			]
		},
		Margin: 
		{
			JobCount: 0,
			TotalFade: 0,
			Jobs: 
			[
				{
					Job: String,
					BasePct: 0,
					ProjPct: 0,
					FadePts: 0,
					Severity: String,
					OtCost: 0,
					PerDiem: 0
				}
			]
		},
		Utilization: 
		{
			UnderCount: 0,
			OverCount: 0,
			Rows: 
			[
				{
					ContactID: 0,
					WorkerName: String,
					Crew: String,
					ProjHours: 0,
					BaselineHours: 0,
					Pct: 0,
					Band: String
				}
			]
		},
		Suggestions: 
		[
			{
				Id: String,
				Kind: String,
				Title: String,
				Detail: String,
				SaveText: String,
				Effect: String,
				RuleId: String,
				LegalNote: String,
				ApplyLabel: String,
				Severity: String
			}
		]
	},
	CanSeePay: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}