Trendsic Platform Service

<back to all web services

PayRulePoliciesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/workforce/payrules/list

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 PayRulePoliciesResponse
{
    public Policies: PayRulePolicy[] = [];
    public ResponseStatus: ResponseStatus;

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

export class PayRulePoliciesRequest
{

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

TypeScript PayRulePoliciesRequest 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/list HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PayRulePoliciesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Policies>
    <PayRulePolicy>
      <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>
    </PayRulePolicy>
  </Policies>
  <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>
</PayRulePoliciesResponse>