Power.Dev Hangfire Services

<back to all web services

JobManagerRequest

The following routes are available for this service:
POST/job-manager
GET/job-manager/{Type}
<?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 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;
}

class JobManagerRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $type=null,
        /** @var DataProvider|null */
        public ?DataProvider $provider=null,
        /** @var DataSumType|null */
        public ?DataSumType $sumType=null
    ) {
    }

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

PHP JobManagerRequest 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 /job-manager HTTP/1.1 
Host: catalog-jobs-dev.power.dev 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JobManagerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/powerDev.ISO.ServiceModels">
  <Provider>Undefined</Provider>
  <SumType>Undefined</SumType>
  <Type>String</Type>
</JobManagerRequest>