Trendsic Platform Service

<back to all web services

PlanningRequest

Requires Authentication
The following routes are available for this service:
GET/v1/workforce/planning
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type OtRow() = 
        member val ContactID:Int32 = new Int32() with get,set
        member val WorkerName:String = null with get,set
        member val ClassCode:String = null with get,set
        member val Crew:String = null with get,set
        member val Job:String = null with get,set
        member val PatternLabel:String = null with get,set
        member val ProjHours:Decimal = new Decimal() with get,set
        member val OtHours:Decimal = new Decimal() with get,set
        member val DtHours:Decimal = new Decimal() with get,set
        member val OtCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val State:String = null with get,set
        member val Tone:String = null with get,set

    [<AllowNullLiteral>]
    type OtExposureBoard() = 
        member val TotalOtCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TotalOtHours:Decimal = new Decimal() with get,set
        member val OverCount:Int32 = new Int32() with get,set
        member val WorkerCount:Int32 = new Int32() with get,set
        member val Rows:ResizeArray<OtRow> = new ResizeArray<OtRow>() with get,set

    [<AllowNullLiteral>]
    type PerDiemJobRow() = 
        member val Job:String = null with get,set
        member val Total:Decimal = new Decimal() with get,set
        member val NonTax:Decimal = new Decimal() with get,set
        member val Tax:Decimal = new Decimal() with get,set
        member val Days:Int32 = new Int32() with get,set
        member val AwayCount:Int32 = new Int32() with get,set
        member val DayRateFlag:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PerDiemBoard() = 
        member val TotalCost:Decimal = new Decimal() with get,set
        member val NonTaxable:Decimal = new Decimal() with get,set
        member val Taxable:Decimal = new Decimal() with get,set
        member val AwayCount:Int32 = new Int32() with get,set
        member val Jobs:ResizeArray<PerDiemJobRow> = new ResizeArray<PerDiemJobRow>() with get,set

    [<AllowNullLiteral>]
    type MarginJobRow() = 
        member val Job:String = null with get,set
        member val BasePct:Decimal = new Decimal() with get,set
        member val ProjPct:Decimal = new Decimal() with get,set
        member val FadePts:Decimal = new Decimal() with get,set
        member val Severity:String = null with get,set
        member val OtCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PerDiem:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type MarginBoard() = 
        member val JobCount:Int32 = new Int32() with get,set
        member val TotalFade:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Jobs:ResizeArray<MarginJobRow> = new ResizeArray<MarginJobRow>() with get,set

    [<AllowNullLiteral>]
    type UtilRow() = 
        member val ContactID:Int32 = new Int32() with get,set
        member val WorkerName:String = null with get,set
        member val Crew:String = null with get,set
        member val ProjHours:Decimal = new Decimal() with get,set
        member val BaselineHours:Decimal = new Decimal() with get,set
        member val Pct:Decimal = new Decimal() with get,set
        member val Band:String = null with get,set

    [<AllowNullLiteral>]
    type UtilizationBoard() = 
        member val UnderCount:Int32 = new Int32() with get,set
        member val OverCount:Int32 = new Int32() with get,set
        member val Rows:ResizeArray<UtilRow> = new ResizeArray<UtilRow>() with get,set

    [<AllowNullLiteral>]
    type PlanningSuggestion() = 
        member val Id:String = null with get,set
        member val Kind:String = null with get,set
        member val Title:String = null with get,set
        member val Detail:String = null with get,set
        member val SaveText:String = null with get,set
        member val Effect:String = null with get,set
        member val RuleId:String = null with get,set
        member val LegalNote:String = null with get,set
        member val ApplyLabel:String = null with get,set
        member val Severity:String = null with get,set

    [<AllowNullLiteral>]
    type PlanningSurface() = 
        member val WeekLabel:String = null with get,set
        member val WeekStart:DateTime = new DateTime() with get,set
        member val WorkerCount:Int32 = new Int32() with get,set
        member val Ot:OtExposureBoard = null with get,set
        member val PerDiem:PerDiemBoard = null with get,set
        member val Margin:MarginBoard = null with get,set
        member val Utilization:UtilizationBoard = null with get,set
        member val Suggestions:ResizeArray<PlanningSuggestion> = new ResizeArray<PlanningSuggestion>() with get,set

    [<AllowNullLiteral>]
    type PlanningResponse() = 
        member val Surface:PlanningSurface = null with get,set
        member val CanSeePay:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type PlanningRequest() = 
        member val AsOf:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# 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"}}}