Power.Dev Hangfire Services

<back to all web services

DataCatalogJobManagerRequest

The following routes are available for this service:
POST/data-catalog/job-manager
<?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 DataCatalogJob : int
{
    case Undefined = 0;
    case CaisoLMP = 4001;
    case CaisoLMPDayAhead = 4002;
    case CaisoLMPRealtimeFiveMin = 4003;
    case CaisoLMPRealtimeFifiteenMin = 4004;
    case CaisoAncillaryPriceDA = 4010;
    case CaisoAncillaryPriceRT = 4011;
    case CaisoAncillaryDemeandDA = 4015;
    case CaisoAncillaryDemeandRT = 4016;
    case CaisoFuelMix = 4021;
    case CaisoFuelMixHybrid = 4022;
    case CaisoDemand = 4031;
    case CaisoDemandForecastByRegions = 4033;
    case CaisoRACapacity = 4034;
    case CaisoEmision = 4035;
    case CaisoFuelPrice = 4036;
    case CaisoSolarWindForecast = 4037;
    case SppFuelMix = 5021;
    case SppSolarAndWindForecast = 5022;
    case SppSolarAndWindForecastShortTerm = 5023;
    case SppLoadForecastMidTerm = 5024;
    case SppGenerationCapacity = 5025;
    case SppOperatingReserves = 5026;
    case SppVerCurtailmentsData = 5027;
    case SppLoadForecast = 5028;
    case SppFuelMixDetailedData = 5029;
    case IsoNeSolarBtm = 6040;
    case IsoNeSevenDayWindForecast = 6041;
    case IsoNeSevenDaySolarForecast = 6042;
    case NyIsoBtmSolar = 7001;
    case NyIsoBtmSolarForecast = 7002;
    case NyIsoBtmSolarCapacityTracking = 7003;
    case NyIsoLoadForecast = 7004;
    case NyIsoFuelMix = 7005;
    case Ercot60dDamGenResourceData = 8001;
    case Ercot60dDamLoadResourceData = 8002;
    case Ercot60dScedGenResourceData = 8003;
    case Ercot60dScedLoadResourceData = 8004;
    case ErcotDamShadowPrices = 8005;
    case ErcotScedShadowPrices = 8006;
    case ErcotRealTimeAddersReserves = 8007;
    case ErcotAsReports = 8008;
    case ErcotAncillaryServicePlan = 8009;
    case ErcotDayAheadLoadForecast = 8010;
    case ErcotHourlyResourceOutageCapacity = 8011;
    case ErcotHourlySolarReport = 8012;
    case ErcotHourlyWindReport = 8013;
    case ErcotLoadForecastByWeatherZone = 8014;
    case ErcotLoadForecastByZone = 8015;
    case ErcotLoadForecast = 8016;
    case ErcotShortTermSystemAdequacy = 8017;
    case ErcotSppPriceCorrections = 8018;
    case ErcotTemperatureForecastByZone = 8019;
    case ErcotUnplannedResourceOutage = 8020;
    case ErcotHighestPriceAsOfferSelected = 8021;
    case ErcotAvailableSeasonalCapacityForecast = 8022;
    case ErcotGenerationOutages = 8023;
}

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;
}

class DataCatalogJobManagerRequest implements JsonSerializable
{
    public function __construct(
        /** @var DataCatalogJob|null */
        public ?DataCatalogJob $catalog=null,
        /** @var DataProvider|null */
        public ?DataProvider $provider=null,
        /** @var bool|null */
        public ?bool $isHistorical=null,
        /** @var bool|null */
        public ?bool $isStop=null
    ) {
    }

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

PHP DataCatalogJobManagerRequest DTOs

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

HTTP + OTHER

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

POST /data-catalog/job-manager HTTP/1.1 
Host: catalog-jobs-dev.power.dev 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"catalog":"Undefined","provider":"Undefined","isHistorical":false,"isStop":false}