Trendsic Platform Service

PlanningRequest

The following routes are available for this service:
GET	/v1/workforce/planning

**PlanningRequest** Parameters:
Name	Parameter	Data Type	Required	Description
AsOf	query	DateTime?	No

**PlanningResponse** Parameters:
Name	Parameter	Data Type	Required
Surface	form	PlanningSurface	No
CanSeePay	form	bool	No
ResponseStatus	form	ResponseStatus	No

**PlanningSurface** Parameters:
Name	Parameter	Data Type	Required
WeekLabel	form	string	No
WeekStart	form	DateTime	No
WorkerCount	form	int	No
Ot	form	OtExposureBoard	No
PerDiem	form	PerDiemBoard	No
Margin	form	MarginBoard	No
Utilization	form	UtilizationBoard	No
Suggestions	form	List<PlanningSuggestion>	No

**OtExposureBoard** Parameters:
Name	Parameter	Data Type	Required
TotalOtCost	form	decimal?	No
TotalOtHours	form	decimal	No
OverCount	form	int	No
WorkerCount	form	int	No
Rows	form	List<OtRow>	No

**OtRow** Parameters:
Name	Parameter	Data Type	Required
ContactID	form	int	No
WorkerName	form	string	No
ClassCode	form	string	No
Crew	form	string	No
Job	form	string	No
PatternLabel	form	string	No
ProjHours	form	decimal	No
OtHours	form	decimal	No
DtHours	form	decimal	No
OtCost	form	decimal?	No
State	form	string	No
Tone	form	string	No

**PerDiemBoard** Parameters:
Name	Parameter	Data Type	Required
TotalCost	form	decimal	No
NonTaxable	form	decimal	No
Taxable	form	decimal	No
AwayCount	form	int	No
Jobs	form	List<PerDiemJobRow>	No

**PerDiemJobRow** Parameters:
Name	Parameter	Data Type	Required
Job	form	string	No
Total	form	decimal	No
NonTax	form	decimal	No
Tax	form	decimal	No
Days	form	int	No
AwayCount	form	int	No
DayRateFlag	form	bool	No

**MarginBoard** Parameters:
Name	Parameter	Data Type	Required
JobCount	form	int	No
TotalFade	form	decimal?	No
Jobs	form	List<MarginJobRow>	No

**MarginJobRow** Parameters:
Name	Parameter	Data Type	Required
Job	form	string	No
BasePct	form	decimal	No
ProjPct	form	decimal	No
FadePts	form	decimal	No
Severity	form	string	No
OtCost	form	decimal?	No
PerDiem	form	decimal	No

**UtilizationBoard** Parameters:
Name	Parameter	Data Type	Required
UnderCount	form	int	No
OverCount	form	int	No
Rows	form	List<UtilRow>	No

**UtilRow** Parameters:
Name	Parameter	Data Type	Required
ContactID	form	int	No
WorkerName	form	string	No
Crew	form	string	No
ProjHours	form	decimal	No
BaselineHours	form	decimal	No
Pct	form	decimal	No
Band	form	string	No

**PlanningSuggestion** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Kind	form	string	No
Title	form	string	No
Detail	form	string	No
SaveText	form	string	No
Effect	form	string	No
RuleId	form	string	No
LegalNote	form	string	No
ApplyLabel	form	string	No
Severity	form	string	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/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
		}
	}
}