Power.Dev Optimization Services

WorkerRequest

The following routes are available for this service:
POST,GET	/worker

<?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 DataProvider : int
{
    case Undefined = 0;
    case SPP = 1;
    case ERCOT = 2;
    case MISO = 3;
    case CAISO = 4;
    case PJM = 5;
    case ISONE = 6;
    case NYISO = 7;
    case NW = 8;
    case SW = 9;
    case SE = 10;
    case AESO = 11;
    case IESO = 12;
    case CENACE = 20;
    case NONISO = 99;
    case EIA = 100;
    case PNM = 150;
    case NREL = 200;
    case NOAA = 210;
    case ENTSOE = 1000;
    case EPIAS = 1010;
    case SELF = 10000;
}

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

enum ShadowPriceNodeScoreType : string
{
    case Undefined = 'Undefined';
    case DailyAvgStd = 'DailyAvgStd';
    case HourlyAvg = 'HourlyAvg';
}

class WorkerRequest implements JsonSerializable
{
    public function __construct(
        /** @var DataProvider|null */
        public ?DataProvider $provider=null,
        /** @var string */
        public string $key='',
        /** @var DateTime */
        public DateTime $startDate=new DateTime(),
        /** @var DateTime */
        public DateTime $endDate=new DateTime(),
        /** @var array<int>|null */
        public ?array $nodeIds=null,
        /** @var PriceMarketType|null */
        public ?PriceMarketType $marketType=null,
        /** @var ShadowPriceNodeScoreType|null */
        public ?ShadowPriceNodeScoreType $scoreType=null
    ) {
    }

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

PHP WorkerRequest 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 /worker HTTP/1.1 
Host: dev-optimization.power.dev 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"provider":"Undefined","key":"String","nodeIds":[0],"marketType":"Undefined","scoreType":"Undefined"}