Trendsic Platform Service

PayRuleSaveRequest

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

"use strict";
export class PayRulePolicy {
    /** @param {{PayRulePolicyId?:number,PayRulePolicyUID?:string,Name?:string,ScopeLevel?:string,BranchId?:string,JurisdictionKey?:string,CbaKey?:string,WorkTypeKey?:string,CurrentVersion?:number,IsActive?:boolean,BranchName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PayRulePolicyId;
    /** @type {string} */
    PayRulePolicyUID;
    /** @type {string} */
    Name;
    /** @type {string} */
    ScopeLevel;
    /** @type {?string} */
    BranchId;
    /** @type {string} */
    JurisdictionKey;
    /** @type {string} */
    CbaKey;
    /** @type {string} */
    WorkTypeKey;
    /** @type {number} */
    CurrentVersion;
    /** @type {boolean} */
    IsActive;
    /** @type {string} */
    BranchName;
}
export class PayRuleDocSection {
    /** @param {{H?:string,T?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    H;
    /** @type {string} */
    T;
}
export class PayRuleTuneOption {
    /** @param {{Label?:string,Sub?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Label;
    /** @type {string} */
    Sub;
}
export class PayRuleTune {
    /** @param {{Intro?:string,Options?:PayRuleTuneOption[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Intro;
    /** @type {PayRuleTuneOption[]} */
    Options = [];
}
export class PayRuleDef {
    /** @param {{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?:{ [index:string]: string; },Doc?:PayRuleDocSection[],Tune?:PayRuleTune}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RuleId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Demand;
    /** @type {string} */
    SourcePolicyName;
    /** @type {string} */
    CascadeLevel;
    /** @type {string} */
    Why;
    /** @type {string} */
    Change;
    /** @type {string} */
    OverrideWho;
    /** @type {string} */
    OverrideConsequence;
    /** @type {string} */
    NoNote;
    /** @type {string} */
    LegalVerify;
    /** @type {{ [index:string]: string; }} */
    Params = {};
    /** @type {PayRuleDocSection[]} */
    Doc = [];
    /** @type {PayRuleTune} */
    Tune;
}
export class PayRulePolicyDoc {
    /** @param {{Intro?:string,LockLine?:string,TemplateName?:string,Rules?:PayRuleDef[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Intro;
    /** @type {string} */
    LockLine;
    /** @type {string} */
    TemplateName;
    /** @type {PayRuleDef[]} */
    Rules = [];
}
export class PayRulePolicyVersionInfo {
    /** @param {{PayRulePolicyVersionId?:number,VersionNumber?:number,ChangeNote?:string,ChangedByName?:string,CreatedAtUtc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PayRulePolicyVersionId;
    /** @type {number} */
    VersionNumber;
    /** @type {string} */
    ChangeNote;
    /** @type {string} */
    ChangedByName;
    /** @type {string} */
    CreatedAtUtc;
}
export class PayRulesCascadeResponse {
    /** @param {{Policy?:PayRulePolicy,Doc?:PayRulePolicyDoc,VersionNumber?:number,Versions?:PayRulePolicyVersionInfo[],CanEditRules?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {PayRulePolicy} */
    Policy;
    /** @type {PayRulePolicyDoc} */
    Doc;
    /** @type {number} */
    VersionNumber;
    /** @type {PayRulePolicyVersionInfo[]} */
    Versions = [];
    /** @type {boolean} */
    CanEditRules;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class PayRuleSaveRequest {
    /** @param {{PayRulePolicyId?:number,Doc?:PayRulePolicyDoc,ChangeNote?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PayRulePolicyId;
    /** @type {PayRulePolicyDoc} */
    Doc;
    /** @type {string} */
    ChangeNote;
}

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