Trendsic Platform Service

<back to all web services

PayRulesCascadeRequest

Requires Authentication
The following routes are available for this service:
GET/v1/workforce/payrules
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PayRulePolicy() = 
        member val PayRulePolicyId:Int32 = new Int32() with get,set
        member val PayRulePolicyUID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val ScopeLevel:String = null with get,set
        member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val JurisdictionKey:String = null with get,set
        member val CbaKey:String = null with get,set
        member val WorkTypeKey:String = null with get,set
        member val CurrentVersion:Int32 = new Int32() with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val BranchName:String = null with get,set

    [<AllowNullLiteral>]
    type PayRuleDocSection() = 
        member val H:String = null with get,set
        member val T:String = null with get,set

    [<AllowNullLiteral>]
    type PayRuleTuneOption() = 
        member val Label:String = null with get,set
        member val Sub:String = null with get,set

    [<AllowNullLiteral>]
    type PayRuleTune() = 
        member val Intro:String = null with get,set
        member val Options:ResizeArray<PayRuleTuneOption> = new ResizeArray<PayRuleTuneOption>() with get,set

    [<AllowNullLiteral>]
    type PayRuleDef() = 
        member val RuleId:String = null with get,set
        member val Name:String = null with get,set
        member val Kind:String = null with get,set
        member val Demand:String = null with get,set
        member val SourcePolicyName:String = null with get,set
        member val CascadeLevel:String = null with get,set
        member val Why:String = null with get,set
        member val Change:String = null with get,set
        member val OverrideWho:String = null with get,set
        member val OverrideConsequence:String = null with get,set
        member val NoNote:String = null with get,set
        member val LegalVerify:String = null with get,set
        member val Params:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Doc:ResizeArray<PayRuleDocSection> = new ResizeArray<PayRuleDocSection>() with get,set
        member val Tune:PayRuleTune = null with get,set

    [<AllowNullLiteral>]
    type PayRulePolicyDoc() = 
        member val Intro:String = null with get,set
        member val LockLine:String = null with get,set
        member val TemplateName:String = null with get,set
        member val Rules:ResizeArray<PayRuleDef> = new ResizeArray<PayRuleDef>() with get,set

    [<AllowNullLiteral>]
    type PayRulePolicyVersionInfo() = 
        member val PayRulePolicyVersionId:Int32 = new Int32() with get,set
        member val VersionNumber:Int32 = new Int32() with get,set
        member val ChangeNote:String = null with get,set
        member val ChangedByName:String = null with get,set
        member val CreatedAtUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type PayRulesCascadeResponse() = 
        member val Policy:PayRulePolicy = null with get,set
        member val Doc:PayRulePolicyDoc = null with get,set
        member val VersionNumber:Int32 = new Int32() with get,set
        member val Versions:ResizeArray<PayRulePolicyVersionInfo> = new ResizeArray<PayRulePolicyVersionInfo>() with get,set
        member val CanEditRules:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type PayRulesCascadeRequest() = 
        member val PayRulePolicyId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val VersionNumber:Nullable<Int32> = new Nullable<Int32>() with get,set

F# PayRulesCascadeRequest 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.

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

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>