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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01
		}
	],
	CanEditRules: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}