Power.Dev Hangfire Services

<back to all web services

NewStageLmpSumRequest

The following routes are available for this service:
POST/new-state/lmp-sum
<?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;
}

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 DataSumType : int
{
    case Undefined = 0;
    case Hourly = 1;
    case Daily = 2;
    case Weekly = 3;
    case Monthly = 4;
    case Yearly = 5;
    case SeasonalMonthHour = 11;
    case SolarWind = 12;
}

enum JobScope : int
{
    case Undefined = 0;
    case Lmp = 1;
    case SolarWind = 2;
    case TxBx = 5;
    case Parquet = 6;
}

class NewStageLmpSumRequest implements JsonSerializable
{
    public function __construct(
        /** @var PriceMarketType|null */
        public ?PriceMarketType $marketType=null,
        /** @var DataProvider|null */
        public ?DataProvider $provider=null,
        /** @var DateTime */
        public DateTime $date=new DateTime(),
        /** @var int */
        public int $monthDuration=0,
        /** @var DataSumType|null */
        public ?DataSumType $sumType=null,
        /** @var JobScope|null */
        public ?JobScope $jobScope=null,
        /** @var int */
        public int $nodeId=0,
        /** @var bool|null */
        public ?bool $force=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['marketType'])) $this->marketType = JsonConverters::from('PriceMarketType', $o['marketType']);
        if (isset($o['provider'])) $this->provider = JsonConverters::from('DataProvider', $o['provider']);
        if (isset($o['date'])) $this->date = JsonConverters::from('DateTime', $o['date']);
        if (isset($o['monthDuration'])) $this->monthDuration = $o['monthDuration'];
        if (isset($o['sumType'])) $this->sumType = JsonConverters::from('DataSumType', $o['sumType']);
        if (isset($o['jobScope'])) $this->jobScope = JsonConverters::from('JobScope', $o['jobScope']);
        if (isset($o['nodeId'])) $this->nodeId = $o['nodeId'];
        if (isset($o['force'])) $this->force = $o['force'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->marketType)) $o['marketType'] = JsonConverters::to('PriceMarketType', $this->marketType);
        if (isset($this->provider)) $o['provider'] = JsonConverters::to('DataProvider', $this->provider);
        if (isset($this->date)) $o['date'] = JsonConverters::to('DateTime', $this->date);
        if (isset($this->monthDuration)) $o['monthDuration'] = $this->monthDuration;
        if (isset($this->sumType)) $o['sumType'] = JsonConverters::to('DataSumType', $this->sumType);
        if (isset($this->jobScope)) $o['jobScope'] = JsonConverters::to('JobScope', $this->jobScope);
        if (isset($this->nodeId)) $o['nodeId'] = $this->nodeId;
        if (isset($this->force)) $o['force'] = $this->force;
        return empty($o) ? new class(){} : $o;
    }
}

PHP NewStageLmpSumRequest DTOs

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

HTTP + XML

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

POST /new-state/lmp-sum HTTP/1.1 
Host: catalog-jobs-dev.power.dev 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<NewStageLmpSumRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/powerDev.ISO.ServiceModels">
  <Date>0001-01-01T00:00:00</Date>
  <Force>false</Force>
  <JobScope>Undefined</JobScope>
  <MarketType>Undefined</MarketType>
  <MonthDuration>0</MonthDuration>
  <NodeId>0</NodeId>
  <Provider>Undefined</Provider>
  <SumType>Undefined</SumType>
</NewStageLmpSumRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />