Trendsic Platform Service

<back to all web services

PlanningRequest

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class PlanningRequest
{
    open var AsOf:Date? = null
}

open class PlanningResponse
{
    open var Surface:PlanningSurface? = null
    open var CanSeePay:Boolean? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class PlanningSurface
{
    open var WeekLabel:String? = null
    open var WeekStart:Date? = null
    open var WorkerCount:Int? = null
    open var Ot:OtExposureBoard? = null
    open var PerDiem:PerDiemBoard? = null
    open var Margin:MarginBoard? = null
    open var Utilization:UtilizationBoard? = null
    open var Suggestions:ArrayList<PlanningSuggestion> = ArrayList<PlanningSuggestion>()
}

open class OtExposureBoard
{
    open var TotalOtCost:BigDecimal? = null
    open var TotalOtHours:BigDecimal? = null
    open var OverCount:Int? = null
    open var WorkerCount:Int? = null
    open var Rows:ArrayList<OtRow> = ArrayList<OtRow>()
}

open class OtRow
{
    open var ContactID:Int? = null
    open var WorkerName:String? = null
    open var ClassCode:String? = null
    open var Crew:String? = null
    open var Job:String? = null
    open var PatternLabel:String? = null
    open var ProjHours:BigDecimal? = null
    open var OtHours:BigDecimal? = null
    open var DtHours:BigDecimal? = null
    open var OtCost:BigDecimal? = null
    open var State:String? = null
    open var Tone:String? = null
}

open class PerDiemBoard
{
    open var TotalCost:BigDecimal? = null
    open var NonTaxable:BigDecimal? = null
    open var Taxable:BigDecimal? = null
    open var AwayCount:Int? = null
    open var Jobs:ArrayList<PerDiemJobRow> = ArrayList<PerDiemJobRow>()
}

open class PerDiemJobRow
{
    open var Job:String? = null
    open var Total:BigDecimal? = null
    open var NonTax:BigDecimal? = null
    open var Tax:BigDecimal? = null
    open var Days:Int? = null
    open var AwayCount:Int? = null
    open var DayRateFlag:Boolean? = null
}

open class MarginBoard
{
    open var JobCount:Int? = null
    open var TotalFade:BigDecimal? = null
    open var Jobs:ArrayList<MarginJobRow> = ArrayList<MarginJobRow>()
}

open class MarginJobRow
{
    open var Job:String? = null
    open var BasePct:BigDecimal? = null
    open var ProjPct:BigDecimal? = null
    open var FadePts:BigDecimal? = null
    open var Severity:String? = null
    open var OtCost:BigDecimal? = null
    open var PerDiem:BigDecimal? = null
}

open class UtilizationBoard
{
    open var UnderCount:Int? = null
    open var OverCount:Int? = null
    open var Rows:ArrayList<UtilRow> = ArrayList<UtilRow>()
}

open class UtilRow
{
    open var ContactID:Int? = null
    open var WorkerName:String? = null
    open var Crew:String? = null
    open var ProjHours:BigDecimal? = null
    open var BaselineHours:BigDecimal? = null
    open var Pct:BigDecimal? = null
    open var Band:String? = null
}

open class PlanningSuggestion
{
    open var Id:String? = null
    open var Kind:String? = null
    open var Title:String? = null
    open var Detail:String? = null
    open var SaveText:String? = null
    open var Effect:String? = null
    open var RuleId:String? = null
    open var LegalNote:String? = null
    open var ApplyLabel:String? = null
    open var Severity:String? = null
}

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