| GET | /v1/workforce/planning |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal
Namespace Global
Namespace CRM.AgencyPlatform.API.Internal
Public Partial Class MarginBoard
Public Overridable Property JobCount As Integer
Public Overridable Property TotalFade As Decimal?
Public Overridable Property Jobs As List(Of MarginJobRow) = New List(Of MarginJobRow)
End Class
Public Partial Class MarginJobRow
Public Overridable Property Job As String
Public Overridable Property BasePct As Decimal
Public Overridable Property ProjPct As Decimal
Public Overridable Property FadePts As Decimal
Public Overridable Property Severity As String
Public Overridable Property OtCost As Decimal?
Public Overridable Property PerDiem As Decimal
End Class
Public Partial Class OtExposureBoard
Public Overridable Property TotalOtCost As Decimal?
Public Overridable Property TotalOtHours As Decimal
Public Overridable Property OverCount As Integer
Public Overridable Property WorkerCount As Integer
Public Overridable Property Rows As List(Of OtRow) = New List(Of OtRow)
End Class
Public Partial Class OtRow
Public Overridable Property ContactID As Integer
Public Overridable Property WorkerName As String
Public Overridable Property ClassCode As String
Public Overridable Property Crew As String
Public Overridable Property Job As String
Public Overridable Property PatternLabel As String
Public Overridable Property ProjHours As Decimal
Public Overridable Property OtHours As Decimal
Public Overridable Property DtHours As Decimal
Public Overridable Property OtCost As Decimal?
Public Overridable Property State As String
Public Overridable Property Tone As String
End Class
Public Partial Class PerDiemBoard
Public Overridable Property TotalCost As Decimal
Public Overridable Property NonTaxable As Decimal
Public Overridable Property Taxable As Decimal
Public Overridable Property AwayCount As Integer
Public Overridable Property Jobs As List(Of PerDiemJobRow) = New List(Of PerDiemJobRow)
End Class
Public Partial Class PerDiemJobRow
Public Overridable Property Job As String
Public Overridable Property Total As Decimal
Public Overridable Property NonTax As Decimal
Public Overridable Property Tax As Decimal
Public Overridable Property Days As Integer
Public Overridable Property AwayCount As Integer
Public Overridable Property DayRateFlag As Boolean
End Class
Public Partial Class PlanningRequest
Public Overridable Property AsOf As Date?
End Class
Public Partial Class PlanningResponse
Public Overridable Property Surface As PlanningSurface
Public Overridable Property CanSeePay As Boolean
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class PlanningSuggestion
Public Overridable Property Id As String
Public Overridable Property Kind As String
Public Overridable Property Title As String
Public Overridable Property Detail As String
Public Overridable Property SaveText As String
Public Overridable Property Effect As String
Public Overridable Property RuleId As String
Public Overridable Property LegalNote As String
Public Overridable Property ApplyLabel As String
Public Overridable Property Severity As String
End Class
Public Partial Class PlanningSurface
Public Overridable Property WeekLabel As String
Public Overridable Property WeekStart As Date
Public Overridable Property WorkerCount As Integer
Public Overridable Property Ot As OtExposureBoard
Public Overridable Property PerDiem As PerDiemBoard
Public Overridable Property Margin As MarginBoard
Public Overridable Property Utilization As UtilizationBoard
Public Overridable Property Suggestions As List(Of PlanningSuggestion) = New List(Of PlanningSuggestion)
End Class
Public Partial Class UtilizationBoard
Public Overridable Property UnderCount As Integer
Public Overridable Property OverCount As Integer
Public Overridable Property Rows As List(Of UtilRow) = New List(Of UtilRow)
End Class
Public Partial Class UtilRow
Public Overridable Property ContactID As Integer
Public Overridable Property WorkerName As String
Public Overridable Property Crew As String
Public Overridable Property ProjHours As Decimal
Public Overridable Property BaselineHours As Decimal
Public Overridable Property Pct As Decimal
Public Overridable Property Band As String
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Surface":{"WeekLabel":"String","WeekStart":"0001-01-01T00:00:00.0000000","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"}}}