Trendsic Platform Service

<back to all web services

PayRulePoliciesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/workforce/payrules/list
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class PayRulePolicy implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $PayRulePolicyId=0,
        /** @var string */
        public string $PayRulePolicyUID='',
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $ScopeLevel=null,
        /** @var string|null */
        public ?string $BranchId=null,
        /** @var string|null */
        public ?string $JurisdictionKey=null,
        /** @var string|null */
        public ?string $CbaKey=null,
        /** @var string|null */
        public ?string $WorkTypeKey=null,
        /** @var int */
        public int $CurrentVersion=0,
        /** @var bool|null */
        public ?bool $IsActive=null,
        /** @var string|null */
        public ?string $BranchName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PayRulePolicyId'])) $this->PayRulePolicyId = $o['PayRulePolicyId'];
        if (isset($o['PayRulePolicyUID'])) $this->PayRulePolicyUID = $o['PayRulePolicyUID'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['ScopeLevel'])) $this->ScopeLevel = $o['ScopeLevel'];
        if (isset($o['BranchId'])) $this->BranchId = $o['BranchId'];
        if (isset($o['JurisdictionKey'])) $this->JurisdictionKey = $o['JurisdictionKey'];
        if (isset($o['CbaKey'])) $this->CbaKey = $o['CbaKey'];
        if (isset($o['WorkTypeKey'])) $this->WorkTypeKey = $o['WorkTypeKey'];
        if (isset($o['CurrentVersion'])) $this->CurrentVersion = $o['CurrentVersion'];
        if (isset($o['IsActive'])) $this->IsActive = $o['IsActive'];
        if (isset($o['BranchName'])) $this->BranchName = $o['BranchName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PayRulePolicyId)) $o['PayRulePolicyId'] = $this->PayRulePolicyId;
        if (isset($this->PayRulePolicyUID)) $o['PayRulePolicyUID'] = $this->PayRulePolicyUID;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->ScopeLevel)) $o['ScopeLevel'] = $this->ScopeLevel;
        if (isset($this->BranchId)) $o['BranchId'] = $this->BranchId;
        if (isset($this->JurisdictionKey)) $o['JurisdictionKey'] = $this->JurisdictionKey;
        if (isset($this->CbaKey)) $o['CbaKey'] = $this->CbaKey;
        if (isset($this->WorkTypeKey)) $o['WorkTypeKey'] = $this->WorkTypeKey;
        if (isset($this->CurrentVersion)) $o['CurrentVersion'] = $this->CurrentVersion;
        if (isset($this->IsActive)) $o['IsActive'] = $this->IsActive;
        if (isset($this->BranchName)) $o['BranchName'] = $this->BranchName;
        return empty($o) ? new class(){} : $o;
    }
}

class PayRulePoliciesResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<PayRulePolicy>|null */
        public ?array $Policies=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Policies'])) $this->Policies = JsonConverters::fromArray('PayRulePolicy', $o['Policies']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Policies)) $o['Policies'] = JsonConverters::toArray('PayRulePolicy', $this->Policies);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class PayRulePoliciesRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP PayRulePoliciesRequest 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/list HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}