Trendsic Platform Service

<back to all web services

PayRulesCascadeRequest

Requires Authentication
The following routes are available for this service:
GET/v1/workforce/payrules
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class PayRuleDef
            Public Overridable Property RuleId As String
            Public Overridable Property Name As String
            Public Overridable Property Kind As String
            Public Overridable Property Demand As String
            Public Overridable Property SourcePolicyName As String
            Public Overridable Property CascadeLevel As String
            Public Overridable Property Why As String
            Public Overridable Property Change As String
            Public Overridable Property OverrideWho As String
            Public Overridable Property OverrideConsequence As String
            Public Overridable Property NoNote As String
            Public Overridable Property LegalVerify As String
            Public Overridable Property Params As Dictionary(Of String, String) = New Dictionary(Of String, String)
            Public Overridable Property Doc As List(Of PayRuleDocSection) = New List(Of PayRuleDocSection)
            Public Overridable Property Tune As PayRuleTune
        End Class

        Public Partial Class PayRuleDocSection
            Public Overridable Property H As String
            Public Overridable Property T As String
        End Class

        Public Partial Class PayRulePolicy
            Public Overridable Property PayRulePolicyId As Integer
            Public Overridable Property PayRulePolicyUID As Guid
            Public Overridable Property Name As String
            Public Overridable Property ScopeLevel As String
            Public Overridable Property BranchId As Guid?
            Public Overridable Property JurisdictionKey As String
            Public Overridable Property CbaKey As String
            Public Overridable Property WorkTypeKey As String
            Public Overridable Property CurrentVersion As Integer
            Public Overridable Property IsActive As Boolean
            Public Overridable Property BranchName As String
        End Class

        Public Partial Class PayRulePolicyDoc
            Public Overridable Property Intro As String
            Public Overridable Property LockLine As String
            Public Overridable Property TemplateName As String
            Public Overridable Property Rules As List(Of PayRuleDef) = New List(Of PayRuleDef)
        End Class

        Public Partial Class PayRulePolicyVersionInfo
            Public Overridable Property PayRulePolicyVersionId As Integer
            Public Overridable Property VersionNumber As Integer
            Public Overridable Property ChangeNote As String
            Public Overridable Property ChangedByName As String
            Public Overridable Property CreatedAtUtc As Date
        End Class

        Public Partial Class PayRulesCascadeRequest
            Public Overridable Property PayRulePolicyId As Integer?
            Public Overridable Property VersionNumber As Integer?
        End Class

        Public Partial Class PayRulesCascadeResponse
            Public Overridable Property Policy As PayRulePolicy
            Public Overridable Property Doc As PayRulePolicyDoc
            Public Overridable Property VersionNumber As Integer
            Public Overridable Property Versions As List(Of PayRulePolicyVersionInfo) = New List(Of PayRulePolicyVersionInfo)
            Public Overridable Property CanEditRules As Boolean
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class PayRuleTune
            Public Overridable Property Intro As String
            Public Overridable Property Options As List(Of PayRuleTuneOption) = New List(Of PayRuleTuneOption)
        End Class

        Public Partial Class PayRuleTuneOption
            Public Overridable Property Label As String
            Public Overridable Property [Sub] As String
        End Class
    End Namespace
End Namespace

VB.NET 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>