Trendsic Platform Service

<back to all web services

PlanningRequest

export class OtRow
{
    public ContactID: number;
    public WorkerName: string;
    public ClassCode: string;
    public Crew: string;
    public Job: string;
    public PatternLabel: string;
    public ProjHours: number;
    public OtHours: number;
    public DtHours: number;
    public OtCost?: number;
    public State: string;
    public Tone: string;

    public constructor(init?: Partial<OtRow>) { (Object as any).assign(this, init); }
}

export class OtExposureBoard
{
    public TotalOtCost?: number;
    public TotalOtHours: number;
    public OverCount: number;
    public WorkerCount: number;
    public Rows: OtRow[] = [];

    public constructor(init?: Partial<OtExposureBoard>) { (Object as any).assign(this, init); }
}

export class PerDiemJobRow
{
    public Job: string;
    public Total: number;
    public NonTax: number;
    public Tax: number;
    public Days: number;
    public AwayCount: number;
    public DayRateFlag: boolean;

    public constructor(init?: Partial<PerDiemJobRow>) { (Object as any).assign(this, init); }
}

export class PerDiemBoard
{
    public TotalCost: number;
    public NonTaxable: number;
    public Taxable: number;
    public AwayCount: number;
    public Jobs: PerDiemJobRow[] = [];

    public constructor(init?: Partial<PerDiemBoard>) { (Object as any).assign(this, init); }
}

export class MarginJobRow
{
    public Job: string;
    public BasePct: number;
    public ProjPct: number;
    public FadePts: number;
    public Severity: string;
    public OtCost?: number;
    public PerDiem: number;

    public constructor(init?: Partial<MarginJobRow>) { (Object as any).assign(this, init); }
}

export class MarginBoard
{
    public JobCount: number;
    public TotalFade?: number;
    public Jobs: MarginJobRow[] = [];

    public constructor(init?: Partial<MarginBoard>) { (Object as any).assign(this, init); }
}

export class UtilRow
{
    public ContactID: number;
    public WorkerName: string;
    public Crew: string;
    public ProjHours: number;
    public BaselineHours: number;
    public Pct: number;
    public Band: string;

    public constructor(init?: Partial<UtilRow>) { (Object as any).assign(this, init); }
}

export class UtilizationBoard
{
    public UnderCount: number;
    public OverCount: number;
    public Rows: UtilRow[] = [];

    public constructor(init?: Partial<UtilizationBoard>) { (Object as any).assign(this, init); }
}

export class PlanningSuggestion
{
    public Id: string;
    public Kind: string;
    public Title: string;
    public Detail: string;
    public SaveText: string;
    public Effect: string;
    public RuleId: string;
    public LegalNote: string;
    public ApplyLabel: string;
    public Severity: string;

    public constructor(init?: Partial<PlanningSuggestion>) { (Object as any).assign(this, init); }
}

export class PlanningSurface
{
    public WeekLabel: string;
    public WeekStart: string;
    public WorkerCount: number;
    public Ot: OtExposureBoard;
    public PerDiem: PerDiemBoard;
    public Margin: MarginBoard;
    public Utilization: UtilizationBoard;
    public Suggestions: PlanningSuggestion[] = [];

    public constructor(init?: Partial<PlanningSurface>) { (Object as any).assign(this, init); }
}

export class PlanningResponse
{
    public Surface: PlanningSurface;
    public CanSeePay: boolean;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<PlanningResponse>) { (Object as any).assign(this, init); }
}

export class PlanningRequest
{
    public AsOf?: string;

    public constructor(init?: Partial<PlanningRequest>) { (Object as any).assign(this, init); }
}

TypeScript PlanningRequest DTOs

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>