Trendsic Platform Service

<back to all web services

RunBillingSystemRequest

The following routes are available for this service:
POST/v1/billing/run/system
<?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 RunBillingSystemTenantResult implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $TenantId='',
        /** @var int */
        public int $BillingRunID=0,
        /** @var bool|null */
        public ?bool $Started=null,
        /** @var string|null */
        public ?string $Message=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TenantId'])) $this->TenantId = $o['TenantId'];
        if (isset($o['BillingRunID'])) $this->BillingRunID = $o['BillingRunID'];
        if (isset($o['Started'])) $this->Started = $o['Started'];
        if (isset($o['Message'])) $this->Message = $o['Message'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TenantId)) $o['TenantId'] = $this->TenantId;
        if (isset($this->BillingRunID)) $o['BillingRunID'] = $this->BillingRunID;
        if (isset($this->Started)) $o['Started'] = $this->Started;
        if (isset($this->Message)) $o['Message'] = $this->Message;
        return empty($o) ? new class(){} : $o;
    }
}

class RunBillingSystemResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var int */
        public int $TenantsSwept=0,
        /** @var int */
        public int $RunsStarted=0,
        /** @var int */
        public int $Reclaimed=0,
        /** @var array<RunBillingSystemTenantResult>|null */
        public ?array $Results=null
    ) {
    }

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

class RunBillingSystemRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $RunType=null,
        /** @var string|null */
        public ?string $PeriodKey=null,
        /** @var string|null */
        public ?string $TenantId=null,
        /** @var int */
        public int $ReclaimStaleMinutes=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['RunType'])) $this->RunType = $o['RunType'];
        if (isset($o['PeriodKey'])) $this->PeriodKey = $o['PeriodKey'];
        if (isset($o['TenantId'])) $this->TenantId = $o['TenantId'];
        if (isset($o['ReclaimStaleMinutes'])) $this->ReclaimStaleMinutes = $o['ReclaimStaleMinutes'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->RunType)) $o['RunType'] = $this->RunType;
        if (isset($this->PeriodKey)) $o['PeriodKey'] = $this->PeriodKey;
        if (isset($this->TenantId)) $o['TenantId'] = $this->TenantId;
        if (isset($this->ReclaimStaleMinutes)) $o['ReclaimStaleMinutes'] = $this->ReclaimStaleMinutes;
        return empty($o) ? new class(){} : $o;
    }
}

PHP RunBillingSystemRequest 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/billing/run/system HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RunType":"String","PeriodKey":"String","TenantId":"00000000000000000000000000000000","ReclaimStaleMinutes":0}

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"}},"TenantsSwept":0,"RunsStarted":0,"Reclaimed":0,"Results":[{"TenantId":"00000000000000000000000000000000","BillingRunID":0,"Started":false,"Message":"String"}]}