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 .xml suffix or ?format=xml

HTTP + XML

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/xml

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

<PlanningResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanSeePay>false</CanSeePay>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Surface>
    <Margin>
      <JobCount>0</JobCount>
      <Jobs>
        <MarginJobRow>
          <BasePct>0</BasePct>
          <FadePts>0</FadePts>
          <Job>String</Job>
          <OtCost>0</OtCost>
          <PerDiem>0</PerDiem>
          <ProjPct>0</ProjPct>
          <Severity>String</Severity>
        </MarginJobRow>
      </Jobs>
      <TotalFade>0</TotalFade>
    </Margin>
    <Ot>
      <OverCount>0</OverCount>
      <Rows>
        <OtRow>
          <ClassCode>String</ClassCode>
          <ContactID>0</ContactID>
          <Crew>String</Crew>
          <DtHours>0</DtHours>
          <Job>String</Job>
          <OtCost>0</OtCost>
          <OtHours>0</OtHours>
          <PatternLabel>String</PatternLabel>
          <ProjHours>0</ProjHours>
          <State>String</State>
          <Tone>String</Tone>
          <WorkerName>String</WorkerName>
        </OtRow>
      </Rows>
      <TotalOtCost>0</TotalOtCost>
      <TotalOtHours>0</TotalOtHours>
      <WorkerCount>0</WorkerCount>
    </Ot>
    <PerDiem>
      <AwayCount>0</AwayCount>
      <Jobs>
        <PerDiemJobRow>
          <AwayCount>0</AwayCount>
          <DayRateFlag>false</DayRateFlag>
          <Days>0</Days>
          <Job>String</Job>
          <NonTax>0</NonTax>
          <Tax>0</Tax>
          <Total>0</Total>
        </PerDiemJobRow>
      </Jobs>
      <NonTaxable>0</NonTaxable>
      <Taxable>0</Taxable>
      <TotalCost>0</TotalCost>
    </PerDiem>
    <Suggestions>
      <PlanningSuggestion>
        <ApplyLabel>String</ApplyLabel>
        <Detail>String</Detail>
        <Effect>String</Effect>
        <Id>String</Id>
        <Kind>String</Kind>
        <LegalNote>String</LegalNote>
        <RuleId>String</RuleId>
        <SaveText>String</SaveText>
        <Severity>String</Severity>
        <Title>String</Title>
      </PlanningSuggestion>
    </Suggestions>
    <Utilization>
      <OverCount>0</OverCount>
      <Rows>
        <UtilRow>
          <Band>String</Band>
          <BaselineHours>0</BaselineHours>
          <ContactID>0</ContactID>
          <Crew>String</Crew>
          <Pct>0</Pct>
          <ProjHours>0</ProjHours>
          <WorkerName>String</WorkerName>
        </UtilRow>
      </Rows>
      <UnderCount>0</UnderCount>
    </Utilization>
    <WeekLabel>String</WeekLabel>
    <WeekStart>0001-01-01T00:00:00</WeekStart>
    <WorkerCount>0</WorkerCount>
  </Surface>
</PlanningResponse>