Power.Dev Optimization Services

<back to all web services

WorkerRequest

The following routes are available for this service:
POST,GET/worker
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class DataProvider(IntEnum):
    UNDEFINED = 0
    SPP = 1
    ERCOT = 2
    MISO = 3
    CAISO = 4
    PJM = 5
    ISONE = 6
    NYISO = 7
    NW = 8
    SW = 9
    SE = 10
    AESO = 11
    IESO = 12
    CENACE = 20
    NONISO = 99
    EIA = 100
    PNM = 150
    NREL = 200
    NOAA = 210
    ENTSOE = 1000
    EPIAS = 1010
    SELF = 10000


class PriceMarketType(IntEnum):
    UNDEFINED = 0
    REALTIME = 1
    DAY_AHEAD = 10
    DART = 101


class ShadowPriceNodeScoreType(str, Enum):
    UNDEFINED = 'Undefined'
    DAILY_AVG_STD = 'DailyAvgStd'
    HOURLY_AVG = 'HourlyAvg'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkerRequest:
    provider: Optional[DataProvider] = None
    key: Optional[str] = None
    start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    node_ids: Optional[List[int]] = None
    market_type: Optional[PriceMarketType] = None
    score_type: Optional[ShadowPriceNodeScoreType] = None

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

<WorkerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.ServiceModel">
  <EndDate>0001-01-01T00:00:00</EndDate>
  <Key>String</Key>
  <MarketType>Undefined</MarketType>
  <NodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </NodeIds>
  <Provider>Undefined</Provider>
  <ScoreType>Undefined</ScoreType>
  <StartDate>0001-01-01T00:00:00</StartDate>
</WorkerRequest>