Power.Dev Hangfire Services

<back to all web services

EIAProductionSeriesByPlantRequest

The following routes are available for this service:
POST/eia-production-request-by-plant
<?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 TimeGranularity : int
{
    case Undefined = 0;
    case hourly = 1;
    case daily = 2;
    case weekly = 3;
    case monthy = 4;
    case yearly = 5;
    case fivemin = 10;
    case tenmin = 11;
    case fifteenmin = 12;
    case halfhour = 13;
    case quarterly = 14;
    case twohours = 21;
    case threehours = 22;
    case fourhours = 24;
    case sixhours = 26;
    case eighthours = 28;
    case twelvehours = 32;
    case irregular = 100;
}

class EIAProductionSeriesByPlantRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $startPlantId=0,
        /** @var TimeGranularity|null */
        public ?TimeGranularity $timeGranularity=null
    ) {
    }

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

PHP EIAProductionSeriesByPlantRequest DTOs

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

HTTP + JSV

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

POST /eia-production-request-by-plant HTTP/1.1 
Host: catalog-jobs-dev.power.dev 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	startPlantId: 0,
	timeGranularity: Undefined
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}