| 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Surface:
{
WeekLabel: String,
WeekStart: 0001-01-01,
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
}
}
}