Trendsic Platform Service

<back to all web services

PayRuleSaveRequest

Requires Authentication
The following routes are available for this service:
POST/v1/workforce/payrules/{PayRulePolicyId}
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 PayRulePolicy:
    pay_rule_policy_id: int = 0
    pay_rule_policy_u_i_d: Optional[str] = None
    name: Optional[str] = None
    scope_level: Optional[str] = None
    branch_id: Optional[str] = None
    jurisdiction_key: Optional[str] = None
    cba_key: Optional[str] = None
    work_type_key: Optional[str] = None
    current_version: int = 0
    is_active: bool = False
    branch_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayRuleDocSection:
    h: Optional[str] = None
    t: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayRuleTuneOption:
    label: Optional[str] = None
    sub: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayRuleTune:
    intro: Optional[str] = None
    options: List[PayRuleTuneOption] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayRuleDef:
    rule_id: Optional[str] = None
    name: Optional[str] = None
    kind: Optional[str] = None
    demand: Optional[str] = None
    source_policy_name: Optional[str] = None
    cascade_level: Optional[str] = None
    why: Optional[str] = None
    change: Optional[str] = None
    override_who: Optional[str] = None
    override_consequence: Optional[str] = None
    no_note: Optional[str] = None
    legal_verify: Optional[str] = None
    params: Dict[str, str] = field(default_factory=dict)
    doc: List[PayRuleDocSection] = field(default_factory=list)
    tune: Optional[PayRuleTune] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayRulePolicyDoc:
    intro: Optional[str] = None
    lock_line: Optional[str] = None
    template_name: Optional[str] = None
    rules: List[PayRuleDef] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayRulePolicyVersionInfo:
    pay_rule_policy_version_id: int = 0
    version_number: int = 0
    change_note: Optional[str] = None
    changed_by_name: Optional[str] = None
    created_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayRulesCascadeResponse:
    policy: Optional[PayRulePolicy] = None
    doc: Optional[PayRulePolicyDoc] = None
    version_number: int = 0
    versions: List[PayRulePolicyVersionInfo] = field(default_factory=list)
    can_edit_rules: bool = False
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayRuleSaveRequest:
    pay_rule_policy_id: int = 0
    doc: Optional[PayRulePolicyDoc] = None
    change_note: Optional[str] = None

Python PayRuleSaveRequest 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/payrules/{PayRulePolicyId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PayRuleSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChangeNote>String</ChangeNote>
  <Doc>
    <Intro>String</Intro>
    <LockLine>String</LockLine>
    <Rules>
      <PayRuleDef>
        <CascadeLevel>String</CascadeLevel>
        <Change>String</Change>
        <Demand>String</Demand>
        <Doc>
          <PayRuleDocSection>
            <H>String</H>
            <T>String</T>
          </PayRuleDocSection>
        </Doc>
        <Kind>String</Kind>
        <LegalVerify>String</LegalVerify>
        <Name>String</Name>
        <NoNote>String</NoNote>
        <OverrideConsequence>String</OverrideConsequence>
        <OverrideWho>String</OverrideWho>
        <Params xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Params>
        <RuleId>String</RuleId>
        <SourcePolicyName>String</SourcePolicyName>
        <Tune>
          <Intro>String</Intro>
          <Options>
            <PayRuleTuneOption>
              <Label>String</Label>
              <Sub>String</Sub>
            </PayRuleTuneOption>
          </Options>
        </Tune>
        <Why>String</Why>
      </PayRuleDef>
    </Rules>
    <TemplateName>String</TemplateName>
  </Doc>
  <PayRulePolicyId>0</PayRulePolicyId>
</PayRuleSaveRequest>

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

<PayRulesCascadeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanEditRules>false</CanEditRules>
  <Doc>
    <Intro>String</Intro>
    <LockLine>String</LockLine>
    <Rules>
      <PayRuleDef>
        <CascadeLevel>String</CascadeLevel>
        <Change>String</Change>
        <Demand>String</Demand>
        <Doc>
          <PayRuleDocSection>
            <H>String</H>
            <T>String</T>
          </PayRuleDocSection>
        </Doc>
        <Kind>String</Kind>
        <LegalVerify>String</LegalVerify>
        <Name>String</Name>
        <NoNote>String</NoNote>
        <OverrideConsequence>String</OverrideConsequence>
        <OverrideWho>String</OverrideWho>
        <Params xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Params>
        <RuleId>String</RuleId>
        <SourcePolicyName>String</SourcePolicyName>
        <Tune>
          <Intro>String</Intro>
          <Options>
            <PayRuleTuneOption>
              <Label>String</Label>
              <Sub>String</Sub>
            </PayRuleTuneOption>
          </Options>
        </Tune>
        <Why>String</Why>
      </PayRuleDef>
    </Rules>
    <TemplateName>String</TemplateName>
  </Doc>
  <Policy>
    <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
    <BranchName>String</BranchName>
    <CbaKey>String</CbaKey>
    <CurrentVersion>0</CurrentVersion>
    <IsActive>false</IsActive>
    <JurisdictionKey>String</JurisdictionKey>
    <Name>String</Name>
    <PayRulePolicyId>0</PayRulePolicyId>
    <PayRulePolicyUID>00000000-0000-0000-0000-000000000000</PayRulePolicyUID>
    <ScopeLevel>String</ScopeLevel>
    <WorkTypeKey>String</WorkTypeKey>
  </Policy>
  <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>
  <VersionNumber>0</VersionNumber>
  <Versions>
    <PayRulePolicyVersionInfo>
      <ChangeNote>String</ChangeNote>
      <ChangedByName>String</ChangedByName>
      <CreatedAtUtc>0001-01-01T00:00:00</CreatedAtUtc>
      <PayRulePolicyVersionId>0</PayRulePolicyVersionId>
      <VersionNumber>0</VersionNumber>
    </PayRulePolicyVersionInfo>
  </Versions>
</PayRulesCascadeResponse>