Power.Dev Hangfire Services

<back to all web services

TbxRunRequest

The following routes are available for this service:
POST/tbx-run
<?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};


enum PriceMarketType : int
{
    case Undefined = 0;
    case Realtime = 1;
    case DayAhead = 10;
    case DART = 101;
}

class TbxRunRequest implements JsonSerializable
{
    public function __construct(
        /** @var PriceMarketType|null */
        public ?PriceMarketType $marketType=null,
        /** @var int */
        public int $nodeId=0,
        /** @var DateTime */
        public DateTime $startDate=new DateTime(),
        /** @var DateTime */
        public DateTime $endDate=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['marketType'])) $this->marketType = JsonConverters::from('PriceMarketType', $o['marketType']);
        if (isset($o['nodeId'])) $this->nodeId = $o['nodeId'];
        if (isset($o['startDate'])) $this->startDate = JsonConverters::from('DateTime', $o['startDate']);
        if (isset($o['endDate'])) $this->endDate = JsonConverters::from('DateTime', $o['endDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->marketType)) $o['marketType'] = JsonConverters::to('PriceMarketType', $this->marketType);
        if (isset($this->nodeId)) $o['nodeId'] = $this->nodeId;
        if (isset($this->startDate)) $o['startDate'] = JsonConverters::to('DateTime', $this->startDate);
        if (isset($this->endDate)) $o['endDate'] = JsonConverters::to('DateTime', $this->endDate);
        return empty($o) ? new class(){} : $o;
    }
}

PHP TbxRunRequest 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.

POST /tbx-run HTTP/1.1 
Host: catalog-jobs-dev.power.dev 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"marketType":"Undefined","nodeId":0,"startDate":"\/Date(-62135596800000-0000)\/","endDate":"\/Date(-62135596800000-0000)\/"}