Trendsic Platform Service

PayRuleSaveRequest

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


export class PayRulePolicy
{
    public PayRulePolicyId: number;
    public PayRulePolicyUID: string;
    public Name: string;
    public ScopeLevel: string;
    public BranchId?: string;
    public JurisdictionKey: string;
    public CbaKey: string;
    public WorkTypeKey: string;
    public CurrentVersion: number;
    public IsActive: boolean;
    public BranchName: string;

    public constructor(init?: Partial<PayRulePolicy>) { (Object as any).assign(this, init); }
}

export class PayRuleDocSection
{
    public H: string;
    public T: string;

    public constructor(init?: Partial<PayRuleDocSection>) { (Object as any).assign(this, init); }
}

export class PayRuleTuneOption
{
    public Label: string;
    public Sub: string;

    public constructor(init?: Partial<PayRuleTuneOption>) { (Object as any).assign(this, init); }
}

export class PayRuleTune
{
    public Intro: string;
    public Options: PayRuleTuneOption[] = [];

    public constructor(init?: Partial<PayRuleTune>) { (Object as any).assign(this, init); }
}

export class PayRuleDef
{
    public RuleId: string;
    public Name: string;
    public Kind: string;
    public Demand: string;
    public SourcePolicyName: string;
    public CascadeLevel: string;
    public Why: string;
    public Change: string;
    public OverrideWho: string;
    public OverrideConsequence: string;
    public NoNote: string;
    public LegalVerify: string;
    public Params: { [index:string]: string; } = {};
    public Doc: PayRuleDocSection[] = [];
    public Tune: PayRuleTune;

    public constructor(init?: Partial<PayRuleDef>) { (Object as any).assign(this, init); }
}

export class PayRulePolicyDoc
{
    public Intro: string;
    public LockLine: string;
    public TemplateName: string;
    public Rules: PayRuleDef[] = [];

    public constructor(init?: Partial<PayRulePolicyDoc>) { (Object as any).assign(this, init); }
}

export class PayRulePolicyVersionInfo
{
    public PayRulePolicyVersionId: number;
    public VersionNumber: number;
    public ChangeNote: string;
    public ChangedByName: string;
    public CreatedAtUtc: string;

    public constructor(init?: Partial<PayRulePolicyVersionInfo>) { (Object as any).assign(this, init); }
}

export class PayRulesCascadeResponse
{
    public Policy: PayRulePolicy;
    public Doc: PayRulePolicyDoc;
    public VersionNumber: number;
    public Versions: PayRulePolicyVersionInfo[] = [];
    public CanEditRules: boolean;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<PayRulesCascadeResponse>) { (Object as any).assign(this, init); }
}

export class PayRuleSaveRequest
{
    public PayRulePolicyId: number;
    public Doc: PayRulePolicyDoc;
    public ChangeNote: string;

    public constructor(init?: Partial<PayRuleSaveRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}