Trendsic Platform Service

<back to all web services

PayRulePoliciesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/workforce/payrules/list
"use strict";
export class PayRulePolicy {
    /** @param {{PayRulePolicyId?:number,PayRulePolicyUID?:string,Name?:string,ScopeLevel?:string,BranchId?:string,JurisdictionKey?:string,CbaKey?:string,WorkTypeKey?:string,CurrentVersion?:number,IsActive?:boolean,BranchName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PayRulePolicyId;
    /** @type {string} */
    PayRulePolicyUID;
    /** @type {string} */
    Name;
    /** @type {string} */
    ScopeLevel;
    /** @type {?string} */
    BranchId;
    /** @type {string} */
    JurisdictionKey;
    /** @type {string} */
    CbaKey;
    /** @type {string} */
    WorkTypeKey;
    /** @type {number} */
    CurrentVersion;
    /** @type {boolean} */
    IsActive;
    /** @type {string} */
    BranchName;
}
export class PayRulePoliciesResponse {
    /** @param {{Policies?:PayRulePolicy[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {PayRulePolicy[]} */
    Policies = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class PayRulePoliciesRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript PayRulePoliciesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/workforce/payrules/list HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Policies":[{"PayRulePolicyId":0,"PayRulePolicyUID":"00000000000000000000000000000000","Name":"String","ScopeLevel":"String","BranchId":"00000000000000000000000000000000","JurisdictionKey":"String","CbaKey":"String","WorkTypeKey":"String","CurrentVersion":0,"IsActive":false,"BranchName":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}