Trendsic Platform Service

PlanningRequest

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

import Foundation
import ServiceStack

public class PlanningRequest : Codable
{
    public var asOf:Date?

    required public init(){}
}

public class PlanningResponse : Codable
{
    public var surface:PlanningSurface
    public var canSeePay:Bool
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class PlanningSurface : Codable
{
    public var weekLabel:String
    public var weekStart:Date
    public var workerCount:Int
    public var ot:OtExposureBoard
    public var perDiem:PerDiemBoard
    public var margin:MarginBoard
    public var utilization:UtilizationBoard
    public var suggestions:[PlanningSuggestion] = []

    required public init(){}
}

public class OtExposureBoard : Codable
{
    public var totalOtCost:Double?
    public var totalOtHours:Double
    public var overCount:Int
    public var workerCount:Int
    public var rows:[OtRow] = []

    required public init(){}
}

public class OtRow : Codable
{
    public var contactID:Int
    public var workerName:String
    public var classCode:String
    public var crew:String
    public var job:String
    public var patternLabel:String
    public var projHours:Double
    public var otHours:Double
    public var dtHours:Double
    public var otCost:Double?
    public var state:String
    public var tone:String

    required public init(){}
}

public class PerDiemBoard : Codable
{
    public var totalCost:Double
    public var nonTaxable:Double
    public var taxable:Double
    public var awayCount:Int
    public var jobs:[PerDiemJobRow] = []

    required public init(){}
}

public class PerDiemJobRow : Codable
{
    public var job:String
    public var total:Double
    public var nonTax:Double
    public var tax:Double
    public var days:Int
    public var awayCount:Int
    public var dayRateFlag:Bool

    required public init(){}
}

public class MarginBoard : Codable
{
    public var jobCount:Int
    public var totalFade:Double?
    public var jobs:[MarginJobRow] = []

    required public init(){}
}

public class MarginJobRow : Codable
{
    public var job:String
    public var basePct:Double
    public var projPct:Double
    public var fadePts:Double
    public var severity:String
    public var otCost:Double?
    public var perDiem:Double

    required public init(){}
}

public class UtilizationBoard : Codable
{
    public var underCount:Int
    public var overCount:Int
    public var rows:[UtilRow] = []

    required public init(){}
}

public class UtilRow : Codable
{
    public var contactID:Int
    public var workerName:String
    public var crew:String
    public var projHours:Double
    public var baselineHours:Double
    public var pct:Double
    public var band:String

    required public init(){}
}

public class PlanningSuggestion : Codable
{
    public var id:String
    public var kind:String
    public var title:String
    public var detail:String
    public var saveText:String
    public var effect:String
    public var ruleId:String
    public var legalNote:String
    public var applyLabel:String
    public var severity:String

    required public init(){}
}

Swift PlanningRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Surface":{"WeekLabel":"String","WeekStart":"0001-01-01T00:00:00.0000000","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"}}}