Trendsic Platform Service

PayRuleSaveRequest

The following routes are available for this service:
POST	/v1/workforce/payrules/{PayRulePolicyId}


export class PayRulePolicy
{
    public PayRulePolicyId: number;
    public PayRulePolicyUID: string;
    public Name: string;
    public ScopeLevel: string;
    public BranchId?: string;
    public JurisdictionKey: string;
    public CbaKey: string;
    public WorkTypeKey: string;
    public CurrentVersion: number;
    public IsActive: boolean;
    public BranchName: string;

    public constructor(init?: Partial<PayRulePolicy>) { (Object as any).assign(this, init); }
}

export class PayRuleDocSection
{
    public H: string;
    public T: string;

    public constructor(init?: Partial<PayRuleDocSection>) { (Object as any).assign(this, init); }
}

export class PayRuleTuneOption
{
    public Label: string;
    public Sub: string;

    public constructor(init?: Partial<PayRuleTuneOption>) { (Object as any).assign(this, init); }
}

export class PayRuleTune
{
    public Intro: string;
    public Options: PayRuleTuneOption[] = [];

    public constructor(init?: Partial<PayRuleTune>) { (Object as any).assign(this, init); }
}

export class PayRuleDef
{
    public RuleId: string;
    public Name: string;
    public Kind: string;
    public Demand: string;
    public SourcePolicyName: string;
    public CascadeLevel: string;
    public Why: string;
    public Change: string;
    public OverrideWho: string;
    public OverrideConsequence: string;
    public NoNote: string;
    public LegalVerify: string;
    public Params: { [index:string]: string; } = {};
    public Doc: PayRuleDocSection[] = [];
    public Tune: PayRuleTune;

    public constructor(init?: Partial<PayRuleDef>) { (Object as any).assign(this, init); }
}

export class PayRulePolicyDoc
{
    public Intro: string;
    public LockLine: string;
    public TemplateName: string;
    public Rules: PayRuleDef[] = [];

    public constructor(init?: Partial<PayRulePolicyDoc>) { (Object as any).assign(this, init); }
}

export class PayRulePolicyVersionInfo
{
    public PayRulePolicyVersionId: number;
    public VersionNumber: number;
    public ChangeNote: string;
    public ChangedByName: string;
    public CreatedAtUtc: string;

    public constructor(init?: Partial<PayRulePolicyVersionInfo>) { (Object as any).assign(this, init); }
}

export class PayRulesCascadeResponse
{
    public Policy: PayRulePolicy;
    public Doc: PayRulePolicyDoc;
    public VersionNumber: number;
    public Versions: PayRulePolicyVersionInfo[] = [];
    public CanEditRules: boolean;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<PayRulesCascadeResponse>) { (Object as any).assign(this, init); }
}

export class PayRuleSaveRequest
{
    public PayRulePolicyId: number;
    public Doc: PayRulePolicyDoc;
    public ChangeNote: string;

    public constructor(init?: Partial<PayRuleSaveRequest>) { (Object as any).assign(this, init); }
}

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