Trendsic Platform Service

<back to all web services

PayRulesCascadeRequest

Requires Authentication
The following routes are available for this service:
GET/v1/workforce/payrules
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 PayRulesCascadeRequest:
    pay_rule_policy_id: Optional[int] = None
    version_number: Optional[int] = None

Python PayRulesCascadeRequest DTOs

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

HTTP + CSV

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

GET /v1/workforce/payrules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

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

{"Policy":{"PayRulePolicyId":0,"PayRulePolicyUID":"00000000000000000000000000000000","Name":"String","ScopeLevel":"String","BranchId":"00000000000000000000000000000000","JurisdictionKey":"String","CbaKey":"String","WorkTypeKey":"String","CurrentVersion":0,"IsActive":false,"BranchName":"String"},"Doc":{"Intro":"String","LockLine":"String","TemplateName":"String","Rules":[{"RuleId":"String","Name":"String","Kind":"String","Demand":"String","SourcePolicyName":"String","CascadeLevel":"String","Why":"String","Change":"String","OverrideWho":"String","OverrideConsequence":"String","NoNote":"String","LegalVerify":"String","Params":{"String":"String"},"Doc":[{"H":"String","T":"String"}],"Tune":{"Intro":"String","Options":[{"Label":"String","Sub":"String"}]}}]},"VersionNumber":0,"Versions":[{"PayRulePolicyVersionId":0,"VersionNumber":0,"ChangeNote":"String","ChangedByName":"String","CreatedAtUtc":"0001-01-01T00:00:00.0000000"}],"CanEditRules":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}