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 .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.

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

<ShiftPatternSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Pattern>
    <AssignedCount>0</AssignedCount>
    <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
    <Code>String</Code>
    <HasBoundary>false</HasBoundary>
    <HasTravel>false</HasTravel>
    <HoursPerDay>0</HoursPerDay>
    <IsDayRate>false</IsDayRate>
    <IsHitch>false</IsHitch>
    <IsNight>false</IsNight>
    <IsSeasonal>false</IsSeasonal>
    <IsSeed>false</IsSeed>
    <Name>String</Name>
    <OffDays>0</OffDays>
    <OnDays>0</OnDays>
    <OtRuleId>String</OtRuleId>
    <Packs>String</Packs>
    <PatternType>String</PatternType>
    <PerDiemRuleId>String</PerDiemRuleId>
    <SeasonalWindow>String</SeasonalWindow>
    <ShiftPatternID>0</ShiftPatternID>
    <Status>String</Status>
    <Struct>String</Struct>
  </Pattern>
</ShiftPatternSaveRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ShiftPatternsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Patterns>
    <ShiftPattern>
      <AssignedCount>0</AssignedCount>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <Code>String</Code>
      <HasBoundary>false</HasBoundary>
      <HasTravel>false</HasTravel>
      <HoursPerDay>0</HoursPerDay>
      <IsDayRate>false</IsDayRate>
      <IsHitch>false</IsHitch>
      <IsNight>false</IsNight>
      <IsSeasonal>false</IsSeasonal>
      <IsSeed>false</IsSeed>
      <Name>String</Name>
      <OffDays>0</OffDays>
      <OnDays>0</OnDays>
      <OtRuleId>String</OtRuleId>
      <Packs>String</Packs>
      <PatternType>String</PatternType>
      <PerDiemRuleId>String</PerDiemRuleId>
      <SeasonalWindow>String</SeasonalWindow>
      <ShiftPatternID>0</ShiftPatternID>
      <Status>String</Status>
      <Struct>String</Struct>
    </ShiftPattern>
  </Patterns>
  <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>
</ShiftPatternsResponse>