Trendsic Platform Service

PlanningRequest

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

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

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>