Trendsic Platform Service

<back to all web services

PayRuleSaveRequest

Requires Authentication
The following routes are available for this service:
POST/v1/workforce/payrules/{PayRulePolicyId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class PayRuleSaveRequest
{
    open var PayRulePolicyId:Int? = null
    open var Doc:PayRulePolicyDoc? = null
    open var ChangeNote:String? = null
}

open class PayRulePolicyDoc
{
    open var Intro:String? = null
    open var LockLine:String? = null
    open var TemplateName:String? = null
    open var Rules:ArrayList<PayRuleDef> = ArrayList<PayRuleDef>()
}

open class PayRuleDef
{
    open var RuleId:String? = null
    open var Name:String? = null
    open var Kind:String? = null
    open var Demand:String? = null
    open var SourcePolicyName:String? = null
    open var CascadeLevel:String? = null
    open var Why:String? = null
    open var Change:String? = null
    open var OverrideWho:String? = null
    open var OverrideConsequence:String? = null
    open var NoNote:String? = null
    open var LegalVerify:String? = null
    open var Params:HashMap<String,String> = HashMap<String,String>()
    open var Doc:ArrayList<PayRuleDocSection> = ArrayList<PayRuleDocSection>()
    open var Tune:PayRuleTune? = null
}

open class PayRuleDocSection
{
    open var H:String? = null
    open var T:String? = null
}

open class PayRuleTune
{
    open var Intro:String? = null
    open var Options:ArrayList<PayRuleTuneOption> = ArrayList<PayRuleTuneOption>()
}

open class PayRuleTuneOption
{
    open var Label:String? = null
    open var Sub:String? = null
}

open class PayRulesCascadeResponse
{
    open var Policy:PayRulePolicy? = null
    open var Doc:PayRulePolicyDoc? = null
    open var VersionNumber:Int? = null
    open var Versions:ArrayList<PayRulePolicyVersionInfo> = ArrayList<PayRulePolicyVersionInfo>()
    open var CanEditRules:Boolean? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class PayRulePolicy
{
    open var PayRulePolicyId:Int? = null
    open var PayRulePolicyUID:UUID? = null
    open var Name:String? = null
    open var ScopeLevel:String? = null
    open var BranchId:UUID? = null
    open var JurisdictionKey:String? = null
    open var CbaKey:String? = null
    open var WorkTypeKey:String? = null
    open var CurrentVersion:Int? = null
    open var IsActive:Boolean? = null
    open var BranchName:String? = null
}

open class PayRulePolicyVersionInfo
{
    open var PayRulePolicyVersionId:Int? = null
    open var VersionNumber:Int? = null
    open var ChangeNote:String? = null
    open var ChangedByName:String? = null
    open var CreatedAtUtc:Date? = null
}

Kotlin PayRuleSaveRequest 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.

POST /v1/workforce/payrules/{PayRulePolicyId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PayRulePolicyId: 0,
	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
						}
					]
				}
			}
		]
	},
	ChangeNote: String
}
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
		}
	}
}