Trendsic Platform Service

<back to all web services

AdjustmentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Adjustment/{ID}
GET,POST,PUT,DELETE,OPTIONS/v1/Adjustment
GET,POST,PUT,DELETE,OPTIONS/v1/Adjustment/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}
GET,POST,PUT,DELETE,OPTIONS/v1/Adjustment/DateRange/{ParamStartDate}/{ParamEndDate}
<?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 Adjustment implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ID=0,
        /** @var DateTime */
        public DateTime $AdjustmentDate=new DateTime(),
        /** @var string|null */
        public ?string $Agent=null,
        /** @var string|null */
        public ?string $Reason=null,
        /** @var float */
        public float $Amount=0.0,
        /** @var string|null */
        public ?string $Approved=null,
        /** @var string|null */
        public ?string $AdjType=null,
        /** @var string|null */
        public ?string $Income=null,
        /** @var string|null */
        public ?string $Paid=null,
        /** @var string|null */
        public ?string $BalanceForward=null,
        /** @var string|null */
        public ?string $BalanceDate=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
        if (isset($o['AdjustmentDate'])) $this->AdjustmentDate = JsonConverters::from('DateTime', $o['AdjustmentDate']);
        if (isset($o['Agent'])) $this->Agent = $o['Agent'];
        if (isset($o['Reason'])) $this->Reason = $o['Reason'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
        if (isset($o['Approved'])) $this->Approved = $o['Approved'];
        if (isset($o['AdjType'])) $this->AdjType = $o['AdjType'];
        if (isset($o['Income'])) $this->Income = $o['Income'];
        if (isset($o['Paid'])) $this->Paid = $o['Paid'];
        if (isset($o['BalanceForward'])) $this->BalanceForward = $o['BalanceForward'];
        if (isset($o['BalanceDate'])) $this->BalanceDate = $o['BalanceDate'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        if (isset($this->AdjustmentDate)) $o['AdjustmentDate'] = JsonConverters::to('DateTime', $this->AdjustmentDate);
        if (isset($this->Agent)) $o['Agent'] = $this->Agent;
        if (isset($this->Reason)) $o['Reason'] = $this->Reason;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        if (isset($this->Approved)) $o['Approved'] = $this->Approved;
        if (isset($this->AdjType)) $o['AdjType'] = $this->AdjType;
        if (isset($this->Income)) $o['Income'] = $this->Income;
        if (isset($this->Paid)) $o['Paid'] = $this->Paid;
        if (isset($this->BalanceForward)) $o['BalanceForward'] = $this->BalanceForward;
        if (isset($this->BalanceDate)) $o['BalanceDate'] = $this->BalanceDate;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class AdjustmentRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<Adjustment>|null */
        public ?array $Adjustment=null,
        /** @var int */
        public int $AgentID=0,
        /** @var DateTime */
        public DateTime $ParamStartDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ParamEndDate=new DateTime()
    ) {
    }

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

PHP AdjustmentRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/Adjustment/{ID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Adjustment":[{"ID":0,"AdjustmentDate":"0001-01-01T00:00:00.0000000","Agent":"String","Reason":"String","Amount":0,"Approved":"String","AdjType":"String","Income":"String","Paid":"String","BalanceForward":"String","BalanceDate":"String"}],"AgentID":0,"ParamStartDate":"0001-01-01T00:00:00.0000000","ParamEndDate":"0001-01-01T00:00:00.0000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Adjustment":[{"ID":0,"AdjustmentDate":"0001-01-01T00:00:00.0000000","Agent":"String","Reason":"String","Amount":0,"Approved":"String","AdjType":"String","Income":"String","Paid":"String","BalanceForward":"String","BalanceDate":"String"}]}