Trendsic Platform Service

ShiftPatternSaveRequest

The following routes are available for this service:
POST	/v1/workforce/patterns

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShiftPattern:
    shift_pattern_i_d: int = 0
    branch_id: Optional[str] = None
    code: Optional[str] = None
    name: Optional[str] = None
    struct: Optional[str] = None
    hours_per_day: Decimal = decimal.Decimal(0)
    on_days: int = 0
    off_days: int = 0
    pattern_type: Optional[str] = None
    is_night: bool = False
    has_boundary: bool = False
    is_hitch: bool = False
    has_travel: bool = False
    is_seasonal: bool = False
    seasonal_window: Optional[str] = None
    is_day_rate: bool = False
    ot_rule_id: Optional[str] = None
    per_diem_rule_id: Optional[str] = None
    packs: Optional[str] = None
    status: Optional[str] = None
    is_seed: bool = False
    assigned_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShiftPatternsResponse:
    patterns: List[ShiftPattern] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShiftPatternSaveRequest:
    pattern: Optional[ShiftPattern] = None

Python ShiftPatternSaveRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/workforce/patterns HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Pattern: 
	{
		ShiftPatternID: 0,
		BranchId: 00000000000000000000000000000000,
		Code: String,
		Name: String,
		Struct: String,
		HoursPerDay: 0,
		OnDays: 0,
		OffDays: 0,
		PatternType: String,
		IsNight: False,
		HasBoundary: False,
		IsHitch: False,
		HasTravel: False,
		IsSeasonal: False,
		SeasonalWindow: String,
		IsDayRate: False,
		OtRuleId: String,
		PerDiemRuleId: String,
		Packs: String,
		Status: String,
		IsSeed: False,
		AssignedCount: 0
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Patterns: 
	[
		{
			ShiftPatternID: 0,
			BranchId: 00000000000000000000000000000000,
			Code: String,
			Name: String,
			Struct: String,
			HoursPerDay: 0,
			OnDays: 0,
			OffDays: 0,
			PatternType: String,
			IsNight: False,
			HasBoundary: False,
			IsHitch: False,
			HasTravel: False,
			IsSeasonal: False,
			SeasonalWindow: String,
			IsDayRate: False,
			OtRuleId: String,
			PerDiemRuleId: String,
			Packs: String,
			Status: String,
			IsSeed: False,
			AssignedCount: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}