Trendsic Platform Service

PlanningRequest

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

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class MarginBoard
    {
        public virtual int JobCount { get; set; }
        public virtual decimal? TotalFade { get; set; }
        public virtual List<MarginJobRow> Jobs { get; set; } = [];
    }

    public partial class MarginJobRow
    {
        public virtual string Job { get; set; }
        public virtual decimal BasePct { get; set; }
        public virtual decimal ProjPct { get; set; }
        public virtual decimal FadePts { get; set; }
        public virtual string Severity { get; set; }
        public virtual decimal? OtCost { get; set; }
        public virtual decimal PerDiem { get; set; }
    }

    public partial class OtExposureBoard
    {
        public virtual decimal? TotalOtCost { get; set; }
        public virtual decimal TotalOtHours { get; set; }
        public virtual int OverCount { get; set; }
        public virtual int WorkerCount { get; set; }
        public virtual List<OtRow> Rows { get; set; } = [];
    }

    public partial class OtRow
    {
        public virtual int ContactID { get; set; }
        public virtual string WorkerName { get; set; }
        public virtual string ClassCode { get; set; }
        public virtual string Crew { get; set; }
        public virtual string Job { get; set; }
        public virtual string PatternLabel { get; set; }
        public virtual decimal ProjHours { get; set; }
        public virtual decimal OtHours { get; set; }
        public virtual decimal DtHours { get; set; }
        public virtual decimal? OtCost { get; set; }
        public virtual string State { get; set; }
        public virtual string Tone { get; set; }
    }

    public partial class PerDiemBoard
    {
        public virtual decimal TotalCost { get; set; }
        public virtual decimal NonTaxable { get; set; }
        public virtual decimal Taxable { get; set; }
        public virtual int AwayCount { get; set; }
        public virtual List<PerDiemJobRow> Jobs { get; set; } = [];
    }

    public partial class PerDiemJobRow
    {
        public virtual string Job { get; set; }
        public virtual decimal Total { get; set; }
        public virtual decimal NonTax { get; set; }
        public virtual decimal Tax { get; set; }
        public virtual int Days { get; set; }
        public virtual int AwayCount { get; set; }
        public virtual bool DayRateFlag { get; set; }
    }

    public partial class PlanningRequest
    {
        public virtual DateTime? AsOf { get; set; }
    }

    public partial class PlanningResponse
    {
        public virtual PlanningSurface Surface { get; set; }
        public virtual bool CanSeePay { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class PlanningSuggestion
    {
        public virtual string Id { get; set; }
        public virtual string Kind { get; set; }
        public virtual string Title { get; set; }
        public virtual string Detail { get; set; }
        public virtual string SaveText { get; set; }
        public virtual string Effect { get; set; }
        public virtual string RuleId { get; set; }
        public virtual string LegalNote { get; set; }
        public virtual string ApplyLabel { get; set; }
        public virtual string Severity { get; set; }
    }

    public partial class PlanningSurface
    {
        public virtual string WeekLabel { get; set; }
        public virtual DateTime WeekStart { get; set; }
        public virtual int WorkerCount { get; set; }
        public virtual OtExposureBoard Ot { get; set; }
        public virtual PerDiemBoard PerDiem { get; set; }
        public virtual MarginBoard Margin { get; set; }
        public virtual UtilizationBoard Utilization { get; set; }
        public virtual List<PlanningSuggestion> Suggestions { get; set; } = [];
    }

    public partial class UtilizationBoard
    {
        public virtual int UnderCount { get; set; }
        public virtual int OverCount { get; set; }
        public virtual List<UtilRow> Rows { get; set; } = [];
    }

    public partial class UtilRow
    {
        public virtual int ContactID { get; set; }
        public virtual string WorkerName { get; set; }
        public virtual string Crew { get; set; }
        public virtual decimal ProjHours { get; set; }
        public virtual decimal BaselineHours { get; set; }
        public virtual decimal Pct { get; set; }
        public virtual string Band { get; set; }
    }

}

C# 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>