Customer Market Results Interface (CMRI) Interface ... · Customer Market Results Interface (CMRI) Interface Specification Fall 2017 Release Version: ... October26, 2017 . Page 2

Customer Market Results Interface

(CMRI)

Interface Specification

Fall 2017 Release

Version: 3.6.3

October26, 2017

Page 2 of 166

Copyright © 2013 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change.

Revision History

Date Version Description

10/23/2013 2.0 Initial document release related to the Spring 2014 Release (FERC764 and RIMPR projects).

This is red-lined based on the CMRI Fall/December 2013 Release – GMT Implementation document.

11/20/2013 2.1 Eliminated the “retrieveEIRForecast” service from the spring 2014 CMRI API

specifications document. DA & HA forecasts will be from the PIRP system.

03/31/2014 3.0 Fall 2014 Changes.

1. RequestMarketAwards_v3.xsd

Added new enumeration value IEEA for product

Added new enumeration value for RTD for executionType 2. MarketAwards_v3.xsd


Added tiePointUsedForFlow element

Added new enumeration value for RTD for executionType 3. RequestSchedulePrices_v3.xsd


Added new enumeration value for RTD for executionType

Added new enumeration value GHG for priceType 4. RequestMarketSchedules_v2.xsd


Added new enumeration value for RTD for executionType

Added tiePointUsedForFlow element 5. Added new service for EIM Transfer Results 6. Added new service for EIM Test Results 7. Added new service for Load Base Schedules 8. Added new service for EIM Entity market base schedules 9. Added new service for Market Base schedules 10. Updated resource id description for all the services.

04/29/2014 3.1 Additional Fall 2014 Changes

1. Added new service for CMRI Inter-tie resource transaction id 2. Added new service for EIM Entity CMRI Inter-tie resource transaction id 3. Updated EIMTranferResult service 4. Updated EIMTestResult service 5. Updated LoadBase schedule service 6. Updated EIM entity market base schedule and market base schedule services 7. EIM Transfer results has been renamed as EIM Transfer 8. Updated the service Retrieve Convergence Bid Awards


1. EIM Test Results -added inputtimetype element enumerations

Page 3 of 166



2. EIM Transfer - Removed resource, and scheduling point elements

3. Updated EIM market base schedule and market base schedule services to add note on execution type element description.

4. Updated Market Schedule service to remove the RC enumeration for product element.

5. Update CMRIInterTieResourceTransactionID request to remove datetimeStart and dateTimeEnd and marketType elements.


1. Updated schedule price request and response element tables – to change the markettype value from RTD to RTM

2. Updated Load Base Schedules request and response sections to add inputTimeType element.

3. Changed executionType element to optional element in EIM Entity Market Base Schedules Response.

4. Changed executionType element to optional element in Market Base Schedules Response.

5. Updated both EIM Entity CMRI Inter-tie Resource Transaction ID and CMRI Inter-tie Resource Transaction ID Response sections for the following changes AlternativeSchedulingPoint/mrid - remove PrimarySchedulingPoint/mrid - remove sequenceIdentifier - remove PrimaryFlowgate/mrid - add, required SecondaryFlowgate/mrid - add, optional purchaseServiceEntity - add, required

6. Added a note to the Market Schedules Request dateTimeEnd element.

7. Added a note to the Market Awards Request dateTimeEnd element.

8. Added a note to the Schedule Prices Request dateTimeEnd element.

03/31/15

3.4.0 Fall 2015 Changes

1. Updated EIM Test results serive to include two additional optional elements (additionalIncrementalRequirement and additionalDecrementalRequirement), updated MessageHeader as required element and major version is now v2

2. Added a note to the EIM Transfer service to indicate that this service no longer provides data beginning Fall 2015 deployment

3. Added new service for EIM Transfer Limit 4. Added new service for EIM Bid Capacity Percentage

Page 4 of 166



Convergence Bid Awards Response

1. Note: There is no xsd change under Fall 2015, only documentation update in this document revision. Corrected “primarySchedulingPoint” to “flowgate” name under the Response section, to align with its corresponding v2 xsd released back in Fall 2014.

08/14/2015 3.4.1 Document modifications include:

Updated section 1.1 Purpose, from "CAISO" to "Customer"

Updated section 1.2 Related Documents, to refer to the release planning page

Updated section 2.1 Document Release notes

Corrected the request and/or response schedulingCoordinator element document description to be the EIM entity ID for the following services:

o EIMTransfer o EIM Test Results o EIM Load Base Schedules o EIMEntityCMRIIntertieResourceTransactionID o EIMEntityMarketBaseSchedules o BidCapacityPercentage

Note: These are all document text updates only, existing service output value have no changes.

Corrected the HighLimit description on the EIMTransferLimit service

Added the EIMEntityTransferLimit service

Added notation on the request.dateTimeStart and request.dateTimeEnd for the EIM Bid Capacity Percentage service

02/03/2016 3.5.0 Added the “RetrieveEIRForecast” service which provides the day-ahead/hour-ahead Eligible Intermittent Resource forecast

04/11/2016 3.5.1 Fall 2016 Release changes

Updated MPM Results service to include RTD – 5 min market values

Updated Expected Energy Allocation details service to add a new enumeration value (FCS –Forecast) to market service type.

Updated Schedule Prices service to include additional product enumeration values and also priceType enumeration values

Updated MarketAwards to add FRU/FRD product enumeration; CLEARED scheduleType enumeration

Added the following new services: o retrieveGreenhouseGasCapData o retrieveEIMInterchangeScheduleData o retrieveElectricityPriceIndex o retrieveResourceLevelMovement o retrieveResourceMovementPoint

06/02/2016 3.5.2 Fall 2016 Release – additional changes

Updated MarketSchedules to add FRU/FRD product enumeration; CLEARED scheduleType enumeration, to both request and response;

For requestMarketSchedules version 3, header is required

Updated EIMTestResults, to add requirementAmount on all of the tests except the Transmission test

07/20/2016 3.5.3 Fall 2016 Release – document corrections/updates

SchedulePrices response - removed the Product enumeration values: FM,FMU,FMD,UM,UMU,UMD

Page 5 of 166



EIR Forecast request - updated the SC list definition, to either be the SCID or the ACL group identifier

EIR Forecast response - updated the SC definition, that the SCID will be the owner of the resource

08/16/2016 3.5.4 Fall 2016 Release

Updated the SchedulePrices v4 service, that request for RTUC/15min results is max of one hour only

10/31/2016 3.5.5 Production November 2016 Release

Updated ResourceMovementPoint and ResourceLevelMovement API service request, to be a maximum of one hour only.

04/12/2017 3.6.0 Fall 2017 Release

Added Daily Electricity Price Index service ( Part of BREB )

Added Actual Limitation Values service ( Part of CCE 3)

Added Resource Opportunity Cost ( Part of CCE 3)

Added External Default Commitment Cost ( Part of EIM 2017)

Updated Document Release Notes section to include service versions and upcoming changes.

Added XML Element Data type section to list frequently used elements and data types

04/24/2017 3.6.1 Fall 2017 Release – Second Iteration

Added GasBurnResourceData service ( Part of Gas Burn & GenDB )

Added GasBurnSummaryData service ( Part of Gas Burn & GenDB )

06/27/2017 3.6.2 Fall 2017 Release – Third Iteration

Updated Resource Opportunity Cost Request to add marketType element

Updated Resource Opportunity Cost Response to add schedulingCoordinator element

Updated DailyElectricityPriceIndex o Removed timeperiod element o Added marketType element to request and response o Added intervalStartTime and intervalEndTime to response

Updated GasBurnResourceData and GasBurnSummaryData Response schema’s gasBurn element type to float

Updated EIMEntityMarketBaseSchedules Request and Response to add resourceType element

Updated MarketBaseSchedules Request and Response to add resourceType element

3.6.3 Fall 2017 Release – Fourth Iteration

Page 6 of 166



Added EIMBidCapacityPercentage_v2 service ( Part of EIM 2017 )

Updated GasBurnSummaryData Request and Response to add valid enumeration values for executionType and added gasCompany element to the Response xsd

Updated GasBurnResourceData Request and Response to add valid enumeration values for executionType

Updated ResourceOpportunityCost Request xsd to add opportunityCostGranularity element and updated marketType element in response xsd from required to optional.

Updated MarketBaseSchedule and EIMEntityMarketBaseSchedule request xsd specifitaion to indicate valid resourceType enumeration values

Page 7 of 166


TABLE OF CONTENTS

1 Introduction .................................................................................................. 16

1.1 Purpose ................................................................................................................................ 16

1.2 Related Documents ............................................................................................................. 16

2 Document Release Notes ........................................................................... 17

2.1 Version 3.5.x ........................................................................................................................ 17

2.2 Version 3.6.x ........................................................................................................................ 17

3 Retrieve Conformed Dispatch Notice ........................................................ 19

3.1 Operation Details ................................................................................................................. 19

3.2 Conformed Dispatch Notice Request .................................................................................. 19

3.2.1 Element Table .......................................................................................................... 19

3.3 Conformed Dispatch Notice Response ................................................................................ 20

3.3.1 Element Table .......................................................................................................... 20

4 Retrieve Contract Usage ............................................................................. 23


4.2 Contract Usage Request ...................................................................................................... 23

4.2.1 Element Table .......................................................................................................... 23

4.3 Contract Usage Response ................................................................................................... 24

4.3.1 Element Table .......................................................................................................... 24

5 Retrieve Convergence Bid Awards ............................................................ 26

5.1 Operation details .................................................................................................................. 26

5.2 Convergence Bid Awards Request ...................................................................................... 26

5.2.1 Element Table .......................................................................................................... 26

5.3 Convergence Bid Awards Response ................................................................................... 27

5.3.1 Element Table .......................................................................................................... 27

6 Retrieve CRR Adjustment Constraints ...................................................... 29


6.2 CRR AdjustmentConstraints Request ................................................................................. 29

6.2.1 Element Table .......................................................................................................... 29

6.3 CRR AdjustmentConstraints Response ............................................................................... 30

6.3.1 Element Table .......................................................................................................... 30

7 Retrieve CRR Adjustment Flow Impact ..................................................... 32


7.2 CRR Adjustment FlowImpact Request ................................................................................ 32

Page 8 of 166


7.2.1 Element Table .......................................................................................................... 32

7.3 CRR AdjustmentFlowImpact Response .............................................................................. 33

7.3.1 Element Table .......................................................................................................... 33

8 Retrieve CRR Adjustment Prices ............................................................... 34


8.2 CRR AdjustmentPrices Request .......................................................................................... 34

8.2.1 Element Table .......................................................................................................... 34

8.3 CRR AdjustmentPrices Response ....................................................................................... 35

8.3.1 Element Table .......................................................................................................... 35

9 Retrieve Default Bid Curves ....................................................................... 36


9.2 Default Bid Curves Request................................................................................................. 36

9.2.1 Element Table .......................................................................................................... 36

9.3 Default BidCurves Response ............................................................................................... 37

9.3.1 Element Table .......................................................................................................... 37

10 Retrieve Default RMR Costs ....................................................................... 39

10.1 Operation Details ............................................................................................................... 39

10.2 Default RMR Costs Request .............................................................................................. 39

10.2.1 Element Table .......................................................................................................... 39

10.3 Default RMR Costs Response ........................................................................................... 40

10.3.1 Element Table .......................................................................................................... 40

11 Retrieve Expected Energy .......................................................................... 41


11.2 Expected Energy Request ................................................................................................. 41

11.2.1 Element Table .......................................................................................................... 41

11.3 Expected Energy Response .............................................................................................. 42

11.3.1 Element Table .......................................................................................................... 42

12 Retrieve Expected Energy Allocation Details ........................................... 44


12.2 ExpectedEnergyAllocationDetails Request ....................................................................... 45

12.2.1 Element Table .......................................................................................................... 45

12.3 ExpectedEnergyAllocationDetails Response..................................................................... 46

12.3.1 Element Table .......................................................................................................... 46

13 Retrieve Finally Qualified Load Following Capacity ................................. 48


13.2 Finally Qualified Load Following Capacity Request .......................................................... 48

Page 9 of 166


13.2.1 Element Table .......................................................................................................... 48

13.3 Finally Qualified Load Following Capacity Response ........................................................ 50

13.3.1 Element Table .......................................................................................................... 50

14 Retrieve Flex Ramp Capacity ..................................................................... 52


14.2 Flex Ramp Capacity Request ............................................................................................ 52

14.2.1 Element Table .......................................................................................................... 52

14.3 Flex Ramp Capacity Response ......................................................................................... 53

14.3.1 Element Table .......................................................................................................... 53

15 Retrieve ISO Commitment Cost Details ..................................................... 55


15.2 ISO Commitment Cost Details Request ............................................................................ 55

15.2.1 Element Table .......................................................................................................... 55

15.3 ISO Commitment Cost Details Response .......................................................................... 56

15.3.1 Element Table .......................................................................................................... 56

16 Retrieve Market Awards .............................................................................. 58


16.2 Market Awards Request ..................................................................................................... 58

16.2.1 Element Table .......................................................................................................... 58

16.3 Market Awards Response .................................................................................................. 60

16.3.1 Element Table .......................................................................................................... 60

17 Retrieve MPM Results ................................................................................. 63


17.2 MPM Results Request ....................................................................................................... 63

17.2.1 Element Table .......................................................................................................... 63

17.3 MPM Results Response .................................................................................................... 64

17.3.1 Element Table .......................................................................................................... 64

18 Retrieve RMR Dispatches ........................................................................... 66


18.2 RMR Dispatches Request.................................................................................................. 66

18.2.1 Element Table .......................................................................................................... 66

18.3 RMR Dispatches Response ............................................................................................... 67

18.3.1 Element Table .......................................................................................................... 67

19 Retrieve Schedule Prices ............................................................................ 69


19.2 Schedule Prices Request ................................................................................................... 69

Page 10 of 166


19.2.1 Element Table .......................................................................................................... 69

19.3 Schedule Prices Response ................................................................................................ 72

19.3.1 Element Table .......................................................................................................... 72

20 Retrieve Start Up Shut Down Instructions ................................................ 75


20.2 Start Up Shut Down Instructions Request ......................................................................... 75

20.2.1 Element Table .......................................................................................................... 75

20.3 Start Up Shut Down Instructions Response ...................................................................... 76

20.3.1 Element Table .......................................................................................................... 76

21 Retrieve Two Day Ahead MSSA Load Forecast ........................................ 79


21.2 Two Day MSSA Load Forecast Request ........................................................................... 79

21.2.1 Element Table .......................................................................................................... 79

21.3 Two Day MSSA Load Forecast Response ........................................................................ 80

21.3.1 Element Table .......................................................................................................... 80

22 Retrieve Unit Commitments........................................................................ 81


22.2 Unit Commitments Request ............................................................................................... 81

22.2.1 Element Table .......................................................................................................... 81

22.3 Unit Commitments Response ............................................................................................ 82

22.3.1 Element Table .......................................................................................................... 82

23 Retrieve Non Dispatchable Time Ranges .................................................. 84


23.2 Non Dispatchable Time Ranges Request .......................................................................... 84

23.2.1 Element Table .......................................................................................................... 84

23.3 Non Dispatchable Time Ranges Response ....................................................................... 85

23.3.1 Element Table .......................................................................................................... 85

24 Retrieve Market Schedules ......................................................................... 87


24.2 Market Schedules Request ................................................................................................ 87

24.2.1 Element Table .......................................................................................................... 87

24.3 Market Schedules Response ............................................................................................. 89

24.3.1 Element Table .......................................................................................................... 89

25 Retrieve Market Forecast ............................................................................ 92


25.2 Market Forecast Request ................................................................................................... 92

Page 11 of 166


25.2.1 Element Table .......................................................................................................... 92

25.3 Market Forecast Response ............................................................................................... 93

25.3.1 Element Table .......................................................................................................... 93

26 Retrieve EIM Transfer .................................................................................. 95


26.2 EIM Transfer Request ....................................................................................................... 95

Element Table ........................................................................................................................ 95

26.3 EIM Transfer Response .................................................................................................... 96

Element Table ........................................................................................................................ 96

27 Retrieve EIM Test Results ........................................................................... 98


27.2 EIM Test Results Request ................................................................................................. 98

Element Table ........................................................................................................................ 98

27.3 EIM Test Results Response .............................................................................................. 99

Element Table ........................................................................................................................ 99

28 Retrieve Load Base Schedules ................................................................ 103

28.1 Operation Details ............................................................................................................. 103

28.2 Load Base Schedules Request........................................................................................ 103

Element Table ...................................................................................................................... 103

28.3 Load Base Schedules Response ..................................................................................... 104

Element Table ...................................................................................................................... 104

29 Retrieve EIM Entity Market Base Schedules ........................................... 107


29.2 EIM Entity Market Base Schedules Request ................................................................... 107

Element Table ...................................................................................................................... 107

29.3 EIM Entity Market Base Schedules Response ................................................................ 108

Element Table ...................................................................................................................... 108

30 Retrieve Market Base Schedules ............................................................. 110


30.2 Market Base Schedules Request .................................................................................... 110

Element Table ...................................................................................................................... 110

30.3 Market Base Schedules Response .................................................................................. 111

Element Table ...................................................................................................................... 111

31 Retrieve CMRI Inter-tie Resource Transaction ID ................................... 113


31.2 CMRI Inter-tie Resource Transaction ID Request ........................................................... 113

Page 12 of 166


Element Table ...................................................................................................................... 113

31.3 CMRI Inter-tie Resource Transaction ID Response ........................................................ 114

Element Table ...................................................................................................................... 114

32 Retrieve EIM Entity CMRI Inter-tie Resource Transaction ID ................. 116


32.2 EIM Entity CMRI Inter-tie Resource Transaction ID Request .......................................... 116

Element Table ...................................................................................................................... 116

32.3 EIM Entity CMRI Inter-tie Resource Transaction ID Response ....................................... 117

Element Table ...................................................................................................................... 117

33 Retrieve EIM Transfer Limit ...................................................................... 119


33.2 EIM Transfer Limit Request ............................................................................................. 119

Element Table ...................................................................................................................... 119

33.3 EIM Transfer Limit Response .......................................................................................... 120

Element Table ...................................................................................................................... 120

34 Retrieve EIM Entity Transfer Limit ........................................................... 122


34.2 EIM Entity Transfer Limit Request ................................................................................... 122

Element Table ...................................................................................................................... 122

34.3 EIM Entity Transfer Limit Response ................................................................................ 123

Element Table ...................................................................................................................... 123

35 Retrieve EIM Bid Capacity Percentage .................................................... 125


35.2 EIM Bid Capacity Percentage Request ........................................................................... 125

Element Table ...................................................................................................................... 125

35.3 EIM Bid Capacity Percentage Response ......................................................................... 126

Element Table ...................................................................................................................... 126

36 Retrieve EIR Forecast ............................................................................... 128


36.2 EIR Forecast Request ...................................................................................................... 128

36.2.1 Element Table ........................................................................................................ 128

36.3 EIR Forecast Response ................................................................................................... 129

36.3.1 Element Table ........................................................................................................ 129

37 Retrieve EIM Interchange Schedule Data ................................................ 131


37.2 EIM Interchange Schedule Data Request ....................................................................... 131

Page 13 of 166


37.2.1 Element Table ........................................................................................................ 131

37.3 EIM Interchange Schedule Data Response ..................................................................... 132

37.3.1 Element Table ........................................................................................................ 132

38 Retrieve Greenhouse Gas Cap Data ........................................................ 134


38.2 Greenhouse Gas Cap Data Request ............................................................................... 134

38.2.1 Element Table ........................................................................................................ 134

38.3 Greenhouse Gas Cap Data Response ............................................................................ 135

38.3.1 Element Table ........................................................................................................ 135

39 Retrieve Electricity Price Index ................................................................ 136


39.2 Electricity Price Index Request ........................................................................................ 136

39.2.1 Element Table ........................................................................................................ 136

39.3 Electricity Price Index Response ..................................................................................... 137

39.3.1 Element Table ........................................................................................................ 137

40 Retrieve Resource Level Movement ........................................................ 139


40.2 Resource Level Movement Request ................................................................................ 139

40.2.1 Element Table ........................................................................................................ 139

40.3 Resource Level Movement Response ............................................................................. 140

40.3.1 Element Table ........................................................................................................ 140

41 Retrieve Resource Movement Point ........................................................ 142


41.2 Resource Movement Point Request ................................................................................ 143

41.2.1 Element Table ........................................................................................................ 143

41.3 Resource Movement Point Response ............................................................................. 144

41.3.1 Element Table ........................................................................................................ 144

42 Retrieve Daily Electricity Price Index ....................................................... 145


42.2 Daily Electricity Price Index Request ............................................................................... 145

42.2.1 Element Table ........................................................................................................ 145

42.3 Daily Electricity Price Index Response ............................................................................ 146

42.3.1 Element Table ........................................................................................................ 146

43 Retrieve Actual Limitation Values ............................................................ 147


43.2 Actual Limitations Values Request .................................................................................. 147

Page 14 of 166


43.2.1 Element Table ........................................................................................................ 147

43.3 Actual Limitation Values Response ................................................................................. 148

43.3.1 Element Table ........................................................................................................ 148

44 Retrieve External Default Commitment Cost .......................................... 149


44.2 External Default Commitment Cost Request ................................................................... 149

44.2.1 Element Table ........................................................................................................ 149

44.3 External Default Commitment Cost Response ................................................................ 150

44.3.1 Element Table ........................................................................................................ 150

45 Retrieve Resource Opportunity Cost ....................................................... 151


45.2 Resource Opportunity Cost Request ............................................................................... 152

45.2.1 Element Table ........................................................................................................ 152

45.3 Resource Opportunity Cost Response ............................................................................ 152

45.3.1 Element Table ........................................................................................................ 152

46 Retrieve Gas Burn Resource Data ........................................................... 154


46.2 Gas Burn Resource Data Request .................................................................................. 154

46.2.1 Element Table ........................................................................................................ 154

46.3 Gas Burn Resource Data Response ............................................................................... 156

46.3.1 Element Table ........................................................................................................ 156

47 Retrieve Gas Burn Summary Data ........................................................... 157


47.2 Gas Burn Summary Data Request .................................................................................. 157

47.2.1 Element Table ........................................................................................................ 157

47.3 Gas Burn Summary Data Response ............................................................................... 159

47.3.1 Element Table ........................................................................................................ 159

48 Fault Return ............................................................................................... 162

48.1 Fault Return ..................................................................................................................... 162

Element Table ...................................................................................................................... 162

49 XML Element Reference ............................................................................ 163

49.1 Data Type Facets ............................................................................................................. 163

Element Table ...................................................................................................................... 163

Schema (StandardOutput.xsd) ............................................................................................. 165

50 Appendix – dateTime Data Type .............................................................. 166

Page 15 of 166


Page 16 of 166


1 Introduction

1.1 Purpose This document describes request and response XSDs related to the Customer Market Results Interface (CMRI) system.

1.2 Related Documents For more information on current or past project initiative releases, please refer to the release planning page at http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx .

http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx

Page 17 of 166


2 Document Release Notes

2.1 Version 3.5.x This document release version affects the following system data interface specifications:

#

Service Schema Version #

Major Minor

1 new retrieveEIRForecast RequestResourceForecast_v1.xsd

ResourceForecast_v1.xsd 1 v20140401

2.2 Version 3.6.x

This document release version affects the following system data interface specifications. The following interface specifications are initial versions. The ISO intends to publish any changes to these interface specifications six weeks prior to the start of market simulation.

#

Service Schema Version #

Major Minor

1 new retrieveDailyElectricityPriceIndex

RequestDailyElectricityPriceIndex_v1.xsd

DailyElectricityPriceIndex_v1.xsd

1 v20171001

2 new retrieveActualLimitationValues

RequestActualLimitationValues_v1.xsd

ActualLimitationValues_v1.xsd

1 v20171001

3 new retrieveExternalDefaultCommitmentCost

RequestExternalDefaultCommitmentCost_v1.xsd

ExternalDefaultCommitmentCost_v1.xsd

1 v20171001

4 new retrieveResourceOpportunityCost

RequestResourceOpportunityCost_v1.xsd

ResourceOpportunityCost_v1.xsd

1 v20171001

5 new retrieveGasBurnResourceData

RequestGasBurnResourceData_v1.xsd

GasBurnResourceData_v1.xsd

1 v20171001

6 new retrieveGasBurnSummaryData

RequestGasBurnSummaryData_v1.xsd

GasBurnSummaryData_v1.xsd

1 v20171001

7 update retrieveEIMEntityMarketBaseSchedules

RequestMarketBaseSchedules_v1.xsd

MarketBaseSchedules_v1.xsd

1 v20171001

Page 18 of 166


8 update retrieveMarketBaseSchedules



1 v20171001

9 new retrieveEIMBidCapacityPercentage_v2

RequestEIMBidCapacityPercentage_v2.xsd

EIMBidCapacityPercentage_v2.xsd

2 v20171001

The following interface specifications are currently in planning phase and more details will become available over the next few weeks.

#

Service Version #

Major Minor

1 Upcoming new service retrieveIntervalRegulationMileage 1 v20171001

http://dev-tools.ete.wepex.net/stash/projects/CMRI/repos/cmri_api_artifacts/browse/3.6.3/CMRI-ArtifactsPackage_v1_2_Fall2017Release/EIMBidCapacityPercentage/20171001/retrieveEIMBidCapacityPercentage_v2.wsdl

http://dev-tools.ete.wepex.net/stash/projects/CMRI/repos/cmri_api_artifacts/browse/3.6.3/CMRI-ArtifactsPackage_v1_2_Fall2017Release/EIMBidCapacityPercentage/20171001/retrieveEIMBidCapacityPercentage_v2.wsdl

http://dev-tools.ete.wepex.net/stash/projects/CMRI/repos/cmri_api_artifacts/browse/3.6.3/CMRI-ArtifactsPackage_v1_2_Fall2017Release/EIMBidCapacityPercentage/20171001/RequestEIMBidCapacityPercentage_v2.xsd

http://dev-tools.ete.wepex.net/stash/projects/CMRI/repos/cmri_api_artifacts/browse/3.6.3/CMRI-ArtifactsPackage_v1_2_Fall2017Release/EIMBidCapacityPercentage/20171001/RequestEIMBidCapacityPercentage_v2.xsd

http://dev-tools.ete.wepex.net/stash/projects/CMRI/repos/cmri_api_artifacts/browse/3.6.3/CMRI-ArtifactsPackage_v1_2_Fall2017Release/EIMBidCapacityPercentage/20171001/EIMBidCapacityPercentage_v2.xsd

Page 19 of 166


3 Retrieve Conformed Dispatch Notice

3.1 Operation Details The service has one operation with three message types. All input and output messages are in XML format.

Operation Message Types

Message WSDL XSD

Retrieve ConformedDispatchNotice

Input RetrieveConformedDispatchNoticeRequest

retrieveConformedDispatchNotice_DocAttachRequest

retrieveConformedDispatchNotice_v1.wsdl

retrieveConformedDispatchNotice_v1_DocAttach.wsdl

RequestConformedDispatchNotice_v1.xsd

Output RetrieveConformedDispatchNoticeResponse

retrieveConformedDispatchNotice_DocAttachResponse

ConformedDispatchNotice_v1.xsd

Fault faultReturnType StandardOutput.xsd

3.2 Conformed Dispatch Notice Request

3.2.1 Element Table

Element Data Description Type Req’d

Message Header (optional)

TimeDate Application level relevant time and date for when this instance of the message was produced.

dateTime Yes

Source Source system which provides data for this service. string Yes

Version Minor Version Identifier; Date reflecting the release this latest version update was related to.

string Yes

Message Payload

dateTimeStart Starting DateTime of the time period for which the data is requested.

dateTime Yes

dateTimeEnd Ending DateTime of the time period for which the data is requested.

Maximum of 31 days can be included in this report.

dateTime Yes

scheduling Coordinator

The unique identifier for a scheduling coordinator (SC). String Yes

Page 20 of 166



resource The unique identifier for a resource.

(InterTie resources can be either a registered resource id from MF or by a SIBR formed transaction ID)

string No

3.3 Conformed Dispatch Notice Response

3.3.1 Element Table


Message Header


dateTime Yes



string Yes

Message Payload

ConformedDispNotice class

resource (in ConformedDispNotice class)

The unique identifier for a resource.


string Yes

Scheduling Coordinator

The unique identifier for a scheduling coordinator (SC). string Yes

tradeDate The trade day to which the current record pertains (in California Prevailing Time).

date No

HR The hour of the trade day to which the current record pertains (in California Prevailing Time).

integer No

intervalStartTime Start time of the market interval dateTime Yes

intervalEndTime End time of the market interval dateTime No

VoltageSupport

Flag Voltage Support Flag. This field indicates if the unit was dispatched for voltage support. Valid values are Y (for yes) and N (for no).

string Yes

dispatchMW DEC MW value dispatched for local voltage support float No

UnitSubstitution

Page 21 of 166



Precedence The precedence for unit substitution. The lower number has a higher precedence.

integer Yes

resource (in SubstitutableUnit class)

The unique identifier for the substituting resource.


string Yes

MW Scheduled MW value for the substituting resource. float Yes

DayAheadResult

energy (in DayAheadResults class)

Sum of energy schedules in the Day-Ahead market. float No

spin Sum of Ancillary Service Spinning Awards. float No

nonSpin Sum of Ancillary Service Non-Spinning Awards. float No

regUp Sum of Ancillary Service Regulation Up Awards. float No

regDown Sum of Ancillary Service Regulation Down Awards. float No

RMRDispatch (in DayAheadResults class)

Dispatched/scheduled value that was either manually or generated by the market run, pursuant to the RMR Contract.

float No

CCR (in DayAheadResults class)

Corresponds to the Competitive Constraint Run value for the Day-Ahead market

float No

RealTimeResult

RMRDispatchEnergyTotal (in RealTimeResults class)

Sum (six intervals) of the RMR Dispatch Energy float No

CCR (in RealTimeResults class)

Corresponds to the Competitive Constraint Run value for the Real-Time market

float No

RMRDispatchEnergy

intervalNum The interval number. An interval represents a specific part of a trade hour to which the current record pertains. A trade hour may comprise of one or more intervals, of equal duration, based on the interval duration. For example, if the interval duration is 60 minutes, the trade hour will comprise of only one interval of 60 minutes. If, on the other hand, the interval duration is 15 minutes, the trade hour will comprise of four intervals of 15 minutes each. The intervals are numbered sequencially starting with the earliest one numbered 1.

integer No

energy (in RMRDispatchEnergy class)

RMR Dispatch Energy per 10-minute intervals. float Yes

Page 22 of 166



dispatchIntervalStartTime

Start time of the dispatch energy interval dateTime Yes

dispatchIntervalEndTime

End time of the dispatch energy interval dateTime No

Page 23 of 166


4 Retrieve Contract Usage



Message WSDL XSD

retrieveContractUsage

Input retrieveContractUsageRequest

retrieveContractUsage_DocAttachRequest

retrieveContractUsage_v2.wsdl

retrieveContractUsage_v2_DocAttach.wsdl

RequestContractUsage_v2.xsd

Output retrieveContractUsageResponse

retrieveContractUsage_DocAttachResponse

ContractUsage_v2.xsd


4.2 Contract Usage Request

4.2.1 Element Table




dateTime Yes



string Yes

Message Payload


dateTime Yes



dateTime Yes

Page 24 of 166



marketType The identifier for the market type. Only one market type is allowed in the request.

Valid values are DAM (for day ahead market), and RTM (for real-time market)

string Yes

scheduling CoordinatorList

The unique identifier for a scheduling coordinator (SC).

At least one SCID is required.

string Yes

resourceList The unique identifier for a resource.


string No

4.3 Contract Usage Response

4.3.1 Element Table


Message Header


dateTime Yes



string Yes

Message Payload



string Yes



marketType The identifier for the market type.


string Yes


date No


integer No

Page 25 of 166



intervalNum The interval number. An interval represents a specific part of a trade hour to which the current record pertains. A trade hour may comprise of one or more intervals.

In the case of the CRN report, it would be 1 to 6 intervals per hour; covering a 10-minute interval duration period.

integer No

MW Refers to the self-schedule quantity in MW float Yes

contractType Refers to the contract type of the self-schedule transaction ; represented as:

ETC - Existing Transmission Contract

TOR - Transmission Ownership Rights

string Yes

contractReferenceNumber

Refers to the specific contract identification number issued by the California ISO to Scheduling Coordinators transactions under Existing Contracts or TORs (Transmission Ownership Rights).

string Yes



Page 26 of 166


5 Retrieve Convergence Bid Awards

5.1 Operation details The service has one operation with three message types. All input and output messages are in XML format.


Message WSDL XSD

retrieveConvergenceBidAwards

Input retrieveConvergenceBid AwardsRequest

retrieveConvergenceBidAwards_DocAttachRequest

retrieveConvergenceBidAwards_v2.wsdl

retrieveConvergenceBidAwards_v2_DocAttach.wsdl

RequestConvergenceBidAwards_v2.xsd

Output RetrieveConvergenceBid AwardsResponse

retrieveConvergenceBidAwards_DocAttachResponse

ConvergenceBidAwards_v2.xsd


5.2 Convergence Bid Awards Request

5.2.1 Element Table




dateTime Yes


Version Minor version identifier; Date reflecting the release this latest version update was related to.

string Yes

Message Payload


dateTime Yes

dateTimeEnd Ending DateTime of the time period for which the data is requested. Maximum of 31 days can be included in this report.

dateTime Yes


The list of the unique identifier for a scheduling coordinator (SC).

String Yes

Page 27 of 166



Pnode The list of PNode or APNode ID associated with the node where convergence bidding occurred

String No

virtualBidType Indicates whether this is a virtual demand or supply bid.

Valid values are: “VIRTUAL SUPPLY” or “VIRTUAL DEMAND”

String No

5.3 Convergence Bid Awards Response

5.3.1 Element Table


Message Header


dateTime Yes


Version Minor version identifier; Date reflecting the release this latest version update was related to.

string Yes

Message Payload

Pnode The PNode or APNode ID associated with the node where convergence bidding occurred

string Yes

isIntertie The flag indicating whether the award is for an intertie or not.

Valid Values:

Yes – indicates that the award is for an intertie

No – indicates that the award is not for an intertie

string Yes



flowgate Primary Tie Required if the virtual bid Pnode or Apnode is external to CAISO: this is modeled as a flowgate with either the to or from being an external HostControlArea

String No


date Yes

virtualBidType Indicates whether this is a virtual demand or supply bid.

Valid values are: “VIRTUAL SUPPLY” or “VIRTUAL DEMAND”

string Yes


integer Yes

MW This is the cleared convergence bid MW float Yes

Page 28 of 166





Page 29 of 166


6 Retrieve CRR Adjustment Constraints



Message WSDL XSD

RetrieveCRRAdjustmentConstraints

Input retrieveCRRAdjustmentConstraintsRequest

retrieveCRRAdjustmentConstraints_DocAttachRequest"

retrieveCRRAdjustmentConstraints_v1.wsdl

retrieveCRRAdjustmentConstraints_v1_DocAttach.wsdl

RequestCRRAdjustmentData_v1.xsd

Output retrieveCRRAdjustmentConstraintsResponse

retrieveCRRAdjustmentConstraints_DocAttachResponse

CRRAdjustmentData_v1.xsd


6.2 CRR AdjustmentConstraints Request

6.2.1 Element Table




dateTime Yes



String Yes

Message Payload


dateTime Yes


dateTime Yes

Scheduling CoordinatorList


string Yes

Page 30 of 166



ConstraintList The list of unique identifier of the transmission constraint that impacted the CRR portfolio due to convergence bidding

string No

6.3 CRR AdjustmentConstraints Response

6.3.1 Element Table


Message Header


dateTime Yes



String Yes

Message Payload

Note: The response CRRAdjustmentData schema is used for all three following services: CRRAdjustmentPrices, CRRAdjustmentConstraints, and CRRAdjustmentFlowImpact. The data elements described below are those relevant in providing the output for the retrieveCRRAdjustmentConstraints service only.

tradeDate The market trading day on when the CRR settlement rule is applicable on

date No

schedulingCoordinator

Unique identifier of the scheduling coordinator certified by the CAISO to submit convergence bids via a convergence bidding agreement

string Yes

name The unique identifier of the transmission constraint that impacted the CRR portfolio due to convergence bidding

string Yes

node The Full Network Model node identifier associated with the transmission constraint

string No


integer No

HASPPhysical Flag indicating either of the following:

YES = Denotes that the node’s impact to the CRR

settlement rule was due to physical bidding activity, that

is reduced in the HASP market

NO = Denotes that the node’s impact to the CRR settlement rule was due to convergence bidding activity

string No

Page 31 of 166





Page 32 of 166


7 Retrieve CRR Adjustment Flow Impact



Message WSDL XSD

RetrieveCRRAdjustmentFlowImpact

Input retrieveCRRAdjustmentFlowImpactRequest

retrieveCRRAdjustmentFlowImpact_DocAttachRequest

retrieveCRRAdjustmentFlowImpact_v1.wsdl

retrieveCRRAdjustmentFlowImpact_v1_DocAttach.wsdl

RequestCRRAdjustmentData_v1.xsd

Output retrieveCRRAdjustmentFlowImpactResponse

retrieveCRRAdjustmentFlowImpact_DocAttachResponse



7.2 CRR Adjustment FlowImpact Request

7.2.1 Element Table




dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes



string Yes

Page 33 of 166




string No

7.3 CRR AdjustmentFlowImpact Response

7.3.1 Element Table


Message Header


dateTime Yes



string Yes

Message Payload

Note: The response CRRAdjustmentData schema is used for all three following services: CRRAdjustmentPrices, CRRAdjustmentConstraints, and CRRAdjustmentFlowImpact. The data elements described below are those relevant in providing the output for the retrieveCRRAdjustmentFlowImpact service only.


date No


Unique identifier of the scheduling coordinator certified by the CAISO to submit convergence bids via a convergence bidding agreement

string Yes

CBEMGroup The convergence bidding entity group name that coincides with a CRR Holder Name

string No


string Yes


integer No

MW The total hourly amount of flow (MW) impacted by the CRR settlement rule

float No



Page 34 of 166


8 Retrieve CRR Adjustment Prices



Message WSDL XSD

Retrieve CRRAdjustmentPrices

Input retrieveCRRAdjustmentPricesRequest

retrieveCRRAdjustmentPrices_DocAttachRequest

retrieve CRRAdjustmentPrices_v1.wsdl

CRRAdjustmentPrices_v1_DocAttach.wsdl

RequestCRRAdjustmentDataNoHour_v1.xsd

Output retrieveCRRAdjustmentPricesResponse

retrieveCRRAdjustmentPrices_DocAttachResponse



8.2 CRR AdjustmentPrices Request

8.2.1 Element Table




dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes



string Yes


string No

Page 35 of 166


8.3 CRR AdjustmentPrices Response

8.3.1 Element Table


Message Header


dateTime Yes



string Yes

Message Payload

Note: The response CRRAdjustmentData schema is used for all three following services: CRRAdjustmentPrices, CRRAdjustmentConstraints, and CRRAdjustmentFlowImpact. The data elements described below are those relevant in providing the output for the retrieveCRRAdjustmentPrices service only.


date No


Unique identifier of the Scheduling Coordinator certified by the CAISO who is a CRR Holder entity

string Yes


string Yes

CRR The CRR unique identifier impacted by the CRR settlement rule due to convergence bidding

string No


integer No

Price The calculated price which is the difference between the Day-Ahead and Real-Time due to convergence bidding with impact on the CRR portfolio

float No



Page 36 of 166


9 Retrieve Default Bid Curves



Message WSDL XSD

Retrieve DefaultBid Curves

Input retrieveDefaultBid CurvesRequest

retrieveDefaultBidCurves_DocAttachRequest

retrieveDefaultBidCurves_v1.wsdl

retrieveDefaultBidCurves_v1_DocAttach.wsdl

RequestDefaultBid Curves_v1.xsd

Output retrieveDefaultBid CurvesResponse

retrieveDefaultBidCurves_DocAttachResponse

DefaultBidCurves_v1.xsd


9.2 Default Bid Curves Request

9.2.1 Element Table




dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes

marketTypeList The identifier for the market type. Valid values are DAM (for day ahead market), and RTM (for the HASP reports).

string Yes

Page 37 of 166





defaultBidTypeList This element represents the basis on which the default bid price curve is created. Valid values are COST (for cost basis), LMP (for LMP basis), and NEGOTIATED (for negotiated price as the basis).

string No



string No

TimePeriodList The time period to which the default bid price curve applies. Valid values are ON_PEAK (for on-peak hours), and OFF_PEAK (for off-peak hours).

All 24 hours are set to off-peak on holidays as defined by WSCC

On regular days- Monday thru Saturday, hour-ending 7 to hour-ending 22 are on-peak; and the rest of the hours including Sunday is off-peak

string No

9.3 Default BidCurves Response

9.3.1 Element Table


Message Header


dateTime Yes



string Yes

Message Payload



string Yes

resourceType The type of resource. Valid values are GEN (for a generating resoruce), LOAD (for a load resource) and ITIE (for an intertie resource).

string Yes

Page 38 of 166



configuration The unique identifier for a configuration of an MSG (multi-stage generator) resource.

This element will be populated when the transaction applies to an MSG resource; otherwise this element will not be included in the output payload.

string No



marketType The identifier for the market type. Valid values are DAM (for day ahead market), and RTM (for the HASP reports).

string Yes


date No

timePeriod The time period to which the default bid price curve applies. Valid values are ON_PEAK (for on-peak hours), and OFF_PEAK (for off-peak hours).

All 24 hours are set to off-peak on holidays as defined by WSCC

On regular days- Monday thru Saturday, hour-ending 7 to hour-ending 22 are on-peak; and the rest of the hours including Sunday is off-peak

string Yes

defaultBidType This element represents the basis on which the default bid price curve is created. Valid values are COST (for cost basis), LMP (for LMP basis), and NEGOTIATED (for negotiated price as the basis).

string Yes

startTime The effective start datetime for the default bid curve (in California Prevailing Time).

dateTime No

endTime The effective end datetime for the default bid curve (in California Prevailing Time).

dateTime No

adderFlag A flag to indicate if bid adder value has been applied to the bid.

string Yes

segmentNum The segment number for the bid price curve. integer Yes

MW The MW value for the specified segment of the bid price curve. float Yes

price The price ($ per MW) value for the specified segment of the bid price curve.

float Yes

segmentBidType For a LMP bid, this element represents the bid type of the segment. Valid values are COST (for cost basis), LMP (for LMP basis), and NEGOTIATED (for negotiated price as the basis).

string No



Page 39 of 166


10 Retrieve Default RMR Costs



Message WSDL XSD

RetrieveDefaultRMRCosts

Input RetrieveDefaultRMRCostsRequest

retrieveDefaultRMRCosts_DocAttachRequest

RetrieveDefaultRMRCosts_v1.wsdl

retrieveDefaultRMRCosts_v1_DocAttach.wsdl

RequestDefaultRMRCosts_v1.xsd

Output RetrieveDefaultRMRCostsResponse

retrieveDefaultRMRCosts_DocAttachResponse

DefaultRMRCosts_v1.xsd


10.2 Default RMR Costs Request

10.2.1 Element Table




dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes



Page 40 of 166





String No

10.3 Default RMR Costs Response



Message Header


dateTime Yes



string Yes

Message Payload

resource



string Yes




date No



minLoadCost Default minimum load cost. float Yes

segmentNum The segment number for the startup cost curve. integer Yes

minutes Cooling time in minutes for the segment of the startup cost curve.

float Yes

price Price in dollars for for the segment of the startup cost curve. float Yes

Page 41 of 166


11 Retrieve Expected Energy



Message WSDL XSD

RetrieveExpectedEnergy

Input RetrieveExpectedEnergyRequest

retrieveExpectedEnergy_DocAttachRequest

RetrieveExpectedEnergy _v1.wsdl

retrieveExpectedEnergy_v1_DocAttach.wsdl

RetrieveExpectedEnergy _v2.wsdl

retrieveExpectedEnergy_v2_DocAttach.wsdl

RequestExpectedEnergy_v1.xsd

RequestExpectedEnergy_v2.xsd

Output RetrieveExpectedEnergyResponse

retrieveExpectedEnergy_DocAttachResponse

ExpectedEnergy _v1.xsd

ExpectedEnergy _v2.xsd


11.2 Expected Energy Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes



Page 42 of 166





String No

11.3 Expected Energy Response



Message Header


dateTime Yes



string Yes

Message Payload

resource



string Yes



string No




date No

intervalDuration The duration of an interval in minutes (in California Prevailing Time).

integer No


integer No

Page 43 of 166




integer No

energy TypeCode Energy component for which the settlement allocation is based on.

Examples are: Optimal Energy, Standard Ramping Energy, Ramping Energy Deviation, Residual Energy, Minimum Load Energy, SLIC Energy, Exceptional Dispatch Energy, RMR Energy, MSSLF Energy, Real-Time Self-Scheduled Energy, Pumping Energy, etc.

Note: For a listing of all of the valid EE types, reference The

BPM for Market Operations, Appendix C, Section C.4

string Yes

expectedEnergy The expected energy value in MWH unit. float Yes



MSS-OE overlapping Indicates that the MSS load following energy overlaps with the optimal energy (Y/N)

string No

RTMarketType Real-time market type that distinguishes between 15 minute and 5 minute market results. Only applies to energyTypeCodes: MLE, SE, EDE, OE, PE, IIE.

Valid values:

FMM = Fifteen-minute market (15min)

RTD = Real-time dispatch market (5min)

string No

Page 44 of 166


12 Retrieve Expected Energy Allocation Details



Message WSDL XSD

retrieveExpectedEnergyAllocation

Details

Input RetrieveExpectedenergyallocationdetailsRequest

retrieveExpectedEnergyAllocationDetails_DocAttachRequest

retrieveExpectedEnergyAllocationDetails_v2.wsdl

retrieveExpectedEnergyAllocationDetails_v2_DocAttach.wsdl

retrieveExpectedEnergyAllocationDetails_v3.wsdl

retrieveExpectedEnergyAllocationDetails_v3_DocAttach.wsdl

RequestExpectedEnergyAllocationDetails_v2.xsd

RequestExpectedEnergyAllocationDetails_v3.xsd

Output RetrieveExpectedEnergyAllocationDetailsResponse

retrieveExpectedEnergyAllocationDetails_DocAttachResponse

ExpectedEnergyAllocationDetails_v2.xsd

ExpectedEnergyAllocationDetails_v3.xsd


Page 45 of 166


12.2 ExpectedEnergyAllocationDetails Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes



marketServiceTypeList

Market Service Type. Market Service Type depends on the SC’s bid curve and market results. Valid values are ME (Market Energy Capacity), SR (Spin Capacity), NR (Non-spin Capacity), DAC (Day-Ahead Energy Capacity), DEC (Derate Capacity), NO_BID (when no bid segment is associated with the record) and FCS (Forecast)

String No



String No

energyBidType Distinguishes results that were based on final mitigated energy bid s (Final) or results that were based on default energy bids (Default);

Valid values: Final or Default

Only one type is allowed per request.

string Yes

Page 46 of 166


12.3 ExpectedEnergyAllocationDetails Response



Message Header


dateTime Yes



string Yes

Message Payload

resource



String Yes



String No




date No


integer No


integer No


integer No

marketServiceType Market Service Type. Market Service Type depends on the SC’s bid curve and market results. Valid values are ME (for Market Energy Capacity), SR (for Spin Capacity), NR (for Non-spin Capacity), DAC (for Day-Ahead Energy Capacity), DEC (for Derate Capacity), NO_BID (when no bid segment is associated with the record) and FCS (Forecast)

string Yes

Page 47 of 166



energyTypeCode Energy component for which the settlement allocation is based on.

Examples are: Optimal Energy, Standard Ramping Energy, Ramping Energy Deviation, Residual Energy, Minimum Load Energy, SLIC Energy, Exceptional Dispatch Energy, RMR Energy, MSSLF Energy, Real-Time Self-Scheduled Energy, Pumping Energy, etc.

Note: For a listing of all of the valid EE types, reference The BPM for Market Operations, Appendix C, Section C.4

string Yes

bidPrice The price awarded per Market Service Type from the SC’s Bid Curve in dollar $ unit

float No

expectedEnergy The expected energy value in MWH unit. float Yes



MSS-OE overlapping Indicates that the MSS load following energy overlaps with the optimal energy (Y/N)

string No

energyBidType Distinguishes results that were based on final mitigated energy bid (Final) or results that were based on default energy bids (Default);

Valid values: Final or Default

As the request only allows one type, thus the output corresponds to the requested type either Final or Default datasets; ie output will not contain both types.

string Yes

RTMarketType Real-time market type that distinguishes between 15 minute and 5 minute market results. Only applies to energyTypeCodes: MLE, SE, EDE, OE, PE, IIE.

Valid values:

FMM = Fifteen-minute market (15min)

RTD = Real-time dispatch market (5min)

string No

Page 48 of 166


13 Retrieve Finally Qualified Load Following Capacity



Message WSDL XSD

Retrieve Finally QualifiedLoadFollowingCapacity

Input RetrieveFinallyQualifiedLoadFollowingCapacityRequest

retrieveFinallyQualifiedLoadFollowingCapacity_DocAttachRequest

RetrieveFinallyQualifiedLoadFollowingCapacity_v1.wsdl

retrieveFinallyQualifiedLoadFollowingCapacity_v1_DocAttach.wsdl

RequestFinallyQualifiedLoadFollowingCapacity_v1.xsd

Output RetrieveFinallyQualifiedLoadFollowingCapacityResponse

retrieveFinallyQualifiedLoadFollowingCapacity_DocAttachResponse

FinallyQualifiedLoadFollowingCapacity_v1.xsd


13.2 Finally Qualified Load Following Capacity Request





dateTime Yes



string Yes

Message Payload


dateTime Yes

Page 49 of 166




dateTime Yes

marketTypeList The identifier for the market type. Valid value is DAM (for day ahead market.

String Yes



resourceTypeList The type of resource. valid values for this service are GEN & PUMP

String No

LFCTypeList This field indicates if the schedule is for Load Following Up or Load Following Down capacity. Valid values are UP (for Load Following Up Capacity) and DOWN (for Load Following Down Capacity).

String No



String No

Page 50 of 166


13.3 Finally Qualified Load Following Capacity Response



Message Header


dateTime Yes



string Yes

Message Payload

resource



string Yes



marketType The identifier for the market type. Valid value is DAM (for day ahead market)

string Yes


date No

resourceType The type of resource. The only valid value for this service is GEN (for a generating resource).

string Yes


integer No

LFCType This field indicates if the schedule is for Load Following Up or Load Following Down capacity. Valid values are UP (for Load Following Up Capacity) and DOWN (for Load Following Down Capacity).

string Yes


integer No

intervalNum The interval number. An interval represents a specific part of a trade hour to which the current record pertains. A trade hour may comprise of one or more intervals, of equal duration, based on the interval duration. For example, if the interval duration is 60 minutes, the trade hour will comprise of only one interval of 60 minutes. If, on the other hand, the interval duration is 15 minutes, the trade hour will comprise of four intervals of 15 minutes each. The intervals are numbered sequentially starting with the earliest one numbered 1.

integer No


Page 51 of 166




MW Load Following Capacity in MW for the interval. float Yes

Page 52 of 166


14 Retrieve Flex Ramp Capacity



Message WSDL XSD

retrieveFlexRampCapacity

Input RetrieveFlexRampCapacityRequest

retrieveFlexRampCapacity_DocAttachRequest

retrieveFlexRampCapacity_v1.wsdl

retrieveFlexRampCapacity_v1_DocAttach.wsdl

RequestFlexRampCapacity_v1.xsd

Output RetrieveFlexRampCapacityResponse

retrieveFlexRampCapacity_DocAttachResponse

FlexRampCapacity_v1.xsd


14.2 Flex Ramp Capacity Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes


The unique identifier/s for a scheduling coordinator (SC). String Yes

Page 53 of 166



marketTypeList The identifier for the market type. Valid values are:

RTM (for the RTPD/15-min market)

DAM (for the day ahead market)

Note: With the Flexible Ramping – Phase 2 project, market results will only be relevant for the “RTM” market.

String Yes

productList The identifier of the product type. Valid values are:

FRU (for “Flex Ramp Up”)

FRD (for “Flex Ramp Down”)

Note: With the Flexible Ramping – Phase 2 project, only the

product “FRU” – Flex Ramp Up market results will only be relevant .

String No

resourceList The unique identifier for the resource/s.


String No

14.3 Flex Ramp Capacity Response



Message Header


dateTime Yes



string Yes

Message Payload



string Yes



string No



Page 54 of 166



marketType The identifier for the market type. Values are:

RTM (for the RTPD/15-min market)

DAM (for the day ahead market)

Note: With the Flexible Ramping – Phase 2 project, market results will only be relevant for the “RTM” market.

string Yes


date No

intervalDuration The duration of an interval in minutes.

Note: With the Flexible Ramping – Phase 2 project, this value will be “15” minutes, as market results will only be relevant for the “RTPD 15-minute market.

integer No

product The product associated with the current record. Values are:

FRU (for “Flex Ramp Up”)

FRD (for “Flex Ramp Down”)

Note: With the Flexible Ramping – Phase 2 project, only the

product “FRU” – Flex Ramp Up market results will only be relevant .

string Yes


integer No

intervalNum The interval number. An interval represents a specific part of a trade hour to which the current record pertains. A trade hour may comprise of one or more intervals, of equal duration, based on the interval duration. For example, if the interval duration is 15 minutes, the trade hour will comprise of four intervals of 15 minutes each. The intervals are numbered sequentially starting with the earliest one numbered 1.

integer No



MW Capacity MW for the current record. float Yes

Page 55 of 166


15 Retrieve ISO Commitment Cost Details



Message WSDL XSD

Retrieve retrieveISOCommitmentCostDetails

Input RequestISOCommitmentCostDetails

retrieveISOCommitmentCostDetails_DocAttachRequest

retrieveISOCommitmentCostDetails_v1.wsdl

retrieveISOCommitmentCostDetails_v1_DocAttach.wsdl

retrieveISOCommitmentCostDetails_v2.wsdl

retrieveISOCommitmentCostDetails_v2_DocAttach.wsdl

RequestISOCommitmentCostDetails_v1.xsd

RequestISOCommitmentCostDetails_v2.xsd

Output Retrieve retrieveISOCommitmentCostDetails

retrieveISOCommitmentCostDetails_DocAttachResponse

ISOCommitmentCostDetails_v1.xsd

ISOCommitmentCostDetails_v2.xsd


15.2 ISO Commitment Cost Details Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes



Page 56 of 166





String No

15.3 ISO Commitment Cost Details Response



Message Header


dateTime Yes



string Yes

Message Payload

resource



string Yes



string No



string Yes


date No


integer No


integer No

intervalNum The interval number. An interval represents a specific part of a trade hour to which the current record pertains. A trade hour may comprise of one or more intervals, of equal duration, based on the interval duration. For example, if the interval duration is 10 minutes, the trade hour will comprise of six intervals.

integer No

Page 57 of 166





marketType Market Type will be RTM for Real Time, RUC or IFM string Yes

StartUpCost Start Up Cost for the Resource float No

StartUpCostEligibilityFlag Eligibility Flag for the Start Up Cost float No

ShutDownCost Pump Shut Down Cost for the Resource float No

ShutDownCostEligibilityFlag Eligibility Flag for the Pump Shut Down Cost String No

NoLoadCost

(aka Minimum Load Cost)

Minimum Load Cost for the Resoruce float No

NoLoadCostEligibilityFlag Eligibility Flag for the Minimum Load String No

PumpingCost Pump Shut Down Cost for the Resource float No

PumpingCostEligibilityFlag Eligibility Flag for the Pump Shut Down Cost String No

RMRCommitmentFlag Eligibility Flag for the RMR Commitment String No

transitionCost This is the bid cost recovery eligible transition cost for the multi-stage generator (MSG) resource

float No

transitionCostEligibilityFlag This is the eligibility flag for the Transition Cost string No

adjStartUpNotificationPeriod Startup Time Period; Number of minutes; Notification time is the time from when resource gets notified of StartUp till it gets synchronized to grid (reach Pmin); ramping time included. 15 minute adder is included to account for possible rounding by the RTUC commitment process.

integer No

adjTransitionNotificationPeriod Transition Time Period; Number of minutes; Notification time is the time from when resource gets notified of Transition till it gets synchronized to grid (reach Pmin of To-Config); ramping time included. 15 minute adder is included to account for possible rounding by the RTUC commitment process.

integer No

Page 58 of 166


16 Retrieve Market Awards



Message WSDL XSD

retrieveMarket Awards

Input retrieveMarketAwardsRequest

retrieveMarketAwards_DocAttachRequest

retrieveMarketAwards_v3.wsdl

retrieveMarketAwards_v3_DocAttach.wsdl

retrieveMarketAwards_v4.wsdl

retrieveMarketAwards_v4_DocAttach.wsdl

RequestMarket Awards_v3.xsd

RequestMarket Awards_v4.xsd

Output retrieveMarketAwardsResponse

retrieveMarketAwards_DocAttachResponse

MarketAwards_v3.xsd

MarketAwards_v4.xsd


16.2 Market Awards Request



Message Header (required)


dateTime Yes



string Yes

Message Payload


dateTime Yes

dateTimeEnd Ending DateTime of the time period for which the data is requested. Maximum of 31 days can be included in this report. Note: To request RTD market awards, data ranging from n

intervals up to a maximum of one hour can only be included in

the report.

dateTime Yes

Page 59 of 166



marketType The identifier for the higher-level market type. Valid values are DAM (for day ahead market), and RTM (corresponding to the HASP or RTUC execution-type’s).

string Yes

executionType The identifier for the execution or lower level market run process. Valid combination values:

marketType executionType

DAM IFM

RTM HASP

RTM RTUC (RTPD/15-min)

RTM RTD (RTD/5-min)

string Yes



resourceTypeList The type of resource. Valid values are GEN (for a generating resource), LOAD (for a load resource) and ITIE (for an intertie resource).

string No

resourceSubTypeList A further classification of a resource. Valid values are PL (for participating load) , NPL (for non-participating load), GEN (for generator), PUMP (for pump-storage generators), ITIE_I (for Import Intertie), ITIE_E (for Export Intertie), SYNC (for sync condenser).

string No

ProductList The product associated with the current record. Valid values are EN (for energy), RU (for Reg Up), RD (for Reg Down), SR (for Spinning Reserve), NR (for Non-spinning Reserve), RC_CAP (for RUC Capacity), RC_AWD (for RUC Award), LFU (for Load Following Up Capacity), LFD (for Load Following Down Capacity), RMU (for Regulation Up Mileage), RMD (for Regulation Down Mileage), IEEA(imbalance energy export allocation for EIM resources – Fall 2014), RC ( for RUC schedule), FRU (Flexible Ramping Up), FRD (Flexible Ramping Down)

string No

ScheduleTypeList Indicates whether the award was from the CAISO market or self-provided. Valid values are MARKET (for CAISO award) , SELF (for self-provided) and CLEARED (Total schedule/award which is the total of the market schedule/award and the self-schedule/self-provision MWs.)

string No

ContractTypeList This field will not be populated. string No

LocationList Unique identifier for either the LAP (for Load Aggregation Point) or pnode (for Price Node).

string No

SchedulingPointList Unique identifier of the scheduling point. string No

DirectionList This element indicates the flow of energy/capacity in or out of the CAISO Control Area. Valid values are I (for Import) and E (for Export).

string No

Page 60 of 166



ResourceList The unique identifier for a resource.

( InterTie resources can be either a registered resource id from MF or by a SIBR formed transaction ID)

string No

energyTypeList The energy type for the schedule. Valid values are FIRM (for Firm energy), NFIRM (for Non-Firm energy), DYN (for Dynamic Interchange), WHL (for Wheeling), and UNT_CNTG (for Unit Contingent).

string No

bindingFlagList Indicates if the schedule is binding. Valid values are Y (for Yes) and N (for No).

string No

16.3 Market Awards Response



Message Header


dateTime Yes



string Yes

Message Payload



string Yes

resourceType The type of resource. Valid values are GEN (for a generating resource), LOAD (for a load resource) and ITIE (for an intertie resource).

string Yes

resourceSubType A further classification of a resource. Valid values are PL (for participating load) , NPL (for non-participating load), , GEN (for generator), PUMP (for pump-storage generators), ITIE_I (for Import Intertie), ITIE_E (for Export Intertie), SYNC (for sync condenser).

string No



string No

Page 61 of 166





marketType The identifier for the higher-level market type. Valid values are DAM (for day ahead market), and RTM (corresponding to the HASP or RTUC execution-type’s).

string Yes



DAM IFM

RTM HASP


RTM RTD (RTD/5-min)

string Yes


date No


integer No

product The product associated with the current record. Valid values are EN (for energy), RU (for Reg Up), RD (for Reg Down), SR (for Spinning Reserve), NR (for Non-spinning Reserve), RC_CAP (for RUC Capacity), RC_AWD (for RUC Award), LFU (for Load Following Up Capacity), LFD (for Load Following Down Capacity), RMU (for Regulation Up Mileage), RMD (for Regulation Down Mileage) ,IEEA(imbalance energy export allocation for EIM resources – Fall 2014), RC (for RUC schedule), FRU (Flexible Ramping Up), FRD (Flexible Ramping Down)

string Yes

scheduleType Indicates whether the award was from the CAISO market or self-provided. Valid values are MARKET (for CAISO awar,SELF (for self-provided) and CLEARED ( TODO)

string No

contractType This field will not be populated. string No

location Unique identifier for either the LAP (Load Aggregation Point) or pnode (Price Node).

string No

SchedulingPoint Unique identifier of the scheduling point. string No

energyType The energy type for the schedule. Valid values are FIRM (for Firm energy), NFIRM (for Non-Firm energy), DYN (for Dynamic Interchange), WHL (for Wheeling), and UNT_CNTG (for Unit Contingent).

string No

ASRegion The unique identifier for the Ancillary Services Region (AS Region) the resource belongs to.

string No

direction This element indicates the flow of energy/capacity in or out of the CAISO Control Area. Valid values are I (for Import) and E (for Export).

string No

Page 62 of 166



bindingFlag Indicates if the schedule is binding. Valid values are Y (for Yes) and N (for No).

string No


integer No


integer No



MW Scheduled MW for the current record. float Yes

tiePointUsedForFlow ID of tie that is used. Primary tie ID if primary tie is available. If primary tie is out, then it is secondary tie ID.

String No

Page 63 of 166


17 Retrieve MPM Results



Message WSDL XSD

RetrieveMPM Results

Input retrieveMPMResultsRequest

retrieveMPMResults_DocAttachRequest

retrieveMPMResults_v2.wsdl

retrieveMPMResults_v2.wsdl

retrieveMPMResults_v2_DocAttach.wsdl

retrieveMPMResults_v3_DocAttach.wsdl

RequestMPMResults_v2.xsd

RequestMPMResults_v3.xsd

Output retrieveMPMResultsResponse

retrieveMPMResults_DocAttachResponse

MPMResults_v2.xsd

MPMResults_v3.xsd


17.2 MPM Results Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes

marketType The identifier for the market type. Valid values are DAM (for day ahead market), and RTM (corresponding to the HASP or RTUC execution-type’s).

String Yes

Page 64 of 166





DAM IFM

RTM HASP


RTD (RTD/5-min)

String Yes





String No

17.3 MPM Results Response



Message Header


dateTime Yes



string Yes

Message Payload

resource



string Yes


string Yes

Page 65 of 166





string No



marketType The identifier for the market type. Valid values are DAM (for day ahead market), and RTM (corresponding to the HASP or RTUC execution-type’s).

string Yes



DAM IFM

RTM HASP


RTD (RTD/5-min)

string Yes


date No

HR The trade hour for which the bid has been mitigated (in California Prevailing Time).

integer No




segmentNum The segment number for the bid price curve. integer Yes

MW The MW value for the specified segment of the bid price curve. float Yes

price The price ($ per MW) value for the specified segment of the bid price curve.

float Yes

Page 66 of 166


18 Retrieve RMR Dispatches



Message WSDL XSD

RetrieveRMRDispatches

Input RetrieveRMRDispatchesRequest

retrieveRMRDispatches_DocAttachRequest

RetrieveRMRDispatches_v1.wsdl

retrieveRMRDispatches_v1_DocAttach.wsdl

RequestRMRDispatches_v1.xsd

Output RetrieveRMRDispatchesResponse

retrieveRMRDispatches_DocAttachResponse

RMRDispatches_v1.xsd


18.2 RMR Dispatches Request





dateTime Yes



string Yes

Message Payload

Page 67 of 166




dateTime Yes


dateTime Yes

marketTypeList The identifier for the market type. Valid value is DAM (for day ahead market).

String Yes





String No

18.3 RMR Dispatches Response



Message Header


dateTime Yes



string Yes

Message Payload

resource



string Yes




date No

marketType The identifier for the market type. Valid value is DAM (for day ahead market).

string No


integer Yes

schedMW Day-Ahead Energy Schedule cleared and scheduled through the IFM run, in MW unit

float Yes

Page 68 of 166



RMRFlag RMR Flag indicating if the resource was dispatched under the RMR Contract. This will be set to ‘Yes’ when it was:

Manually dispatched by an Operator; or

Generated by the market run where the unit has an AC (All Constraints) schedule value greater than the CC (Competitive Constraint) schedule, even if the (IFM) Day-Ahead Schedule is zero.

Valid values are Y (for yes) and N (for no).

string Yes



Page 69 of 166


19 Retrieve Schedule Prices



Message WSDL XSD

Retrieve Schedule Prices

Input retrieveSchedulePricesRequest

retrieveSchedulePrices_DocAttachRequest

RetrieveSchedule Prices_v3.wsdl

RetrieveSchedule Prices_v3_DocAttach.wsdl

RetrieveSchedule Prices_v4.wsdl

RetrieveSchedule Prices_v4_DocAttach.wsdl

RequestSchedule Prices_v3.xsd

RequestSchedule Prices_v4.xsd

Output retrieveSchedulePricesResponse

retrieveSchedulePrices_DocAttachResponse

SchedulePrices_v3.xsd

SchedulePrices_v4.xsd


19.2 Schedule Prices Request



Message Header (Required)


dateTime Yes



string Yes

Message Payload


dateTime Yes

Page 70 of 166



dateTimeEnd Ending DateTime of the time period for which the data is requested. Request limitations:

executionType Limit

RTD (RTD/5-min) All versions, data ranging from n intervals up to a maximum of one hour can only be included in the report

RTUC (RTPD/15-min) Version 4 - Data ranging from n intervals up to a maximum of one hour can only be included in the report

Others Maximum of 31 days

dateTime Yes

marketType The identifier for the market type. Valid values are DAM (for day ahead market), and RTM (corresponding to the HASP or RTUC or RTD execution-type’s).

string Yes



DAM IFM

RTM HASP


RTM RTD (RTD/5-min)

string Yes




string No

resourceSubTypeList A further classification of a resource. Valid values are PL (for participating load) , NPL (for non-participating load), , GEN (for generator), PUMP (for pump-storage generators), ITIE_I (for Import Intertie), ITIE_E (for Export Intertie), SYNC (for sync condenser).

string No

ProductList The product associated with the current record. Valid values are EN (for energy), RU (for Reg Up), RD (for Reg Down), SR (for Spinning Reserve), NR (for Non-spinning Reserve), RC (for RUC), RMU (for Regulation Up Mileage), RMD (for Regulation Down Mileage), IEEA (for imbalance energy export allocation)

string No

Page 71 of 166



priceTypeList This element represents the type of price on the current record. Valid values are LMP (for Locational Marginal Price; LMP = EN + LOSS + CONGESTION), ASMP (for Ancillary Service Marginal Price), EN (for Energy component of LMP price), LOSS (for Loss component of LMP price), CONGESTION (for Congestion component of LMP price), RUC (for RUC price) , GHG ( for Green House Gas ) and FRMP ( Flexible Ramping Marginal Price)

string No

ResourceList The unique identifier for a resource.


string No

schedulingPointList Unique identifier of the scheduling point. string No

DirectionList This element indicates the flow of energy/capacity in or out of the CAISO Control Area. Valid values are I (for Import) and E (for Export).

string No

energyTypeList The energy type for the schedule. Valid values are FIRM (for Firm energy), NFIRM (for Non-Firm energy), DYN (for Dynamic Interchange), WHL (for Wheeling), and UNT_CNTG (for Unit Contingent).

string No

bindingFlagList Indicates if the schedule is binding. Valid values are Y (for Yes) and N (for No).

string No

Page 72 of 166


19.3 Schedule Prices Response



Message Header


dateTime Yes



string Yes

Message Payload

Resource The unique identifier for a resource.


string Yes


string Yes


string No



marketType The identifier for the market type. Valid values are DAM (for day ahead market), and RTM (corresponding to the HASP,RTUC or RTD execution-type’s).

string Yes



DAM IFM

RTM HASP


RTM RTD ( RTD /5-min)

string Yes


date No

intervalDuration The duration of an interval in minutes. integer No

Page 73 of 166



Product The product associated with the current record. Valid values are EN (for energy), RU (for Reg Up), RD (for Reg Down), SR (for Spinning Reserve), NR (for Non-spinning Reserve),RC (for RUC), IEEA (for imbalance energy export allocation), FRU ( Flexible Ramping Up) , FRD (Flexible Ramping Down)

string Yes

bindingFlag Indicates if the schedule is binding. Valid values are Y (for Yes) and N (for No).

string No

priceType This element represents the type of price on the current record. Valid values are LMP (for Locational Marginal Price; LMP = EN + LOSS + CONGESTION), ASMP (for Ancillary Service Marginal Price), EN (for Energy component of LMP price), LOSS (for Loss component of LMP price), CONGESTION (for Congestion component of LMP price), RUC (for RUC price),GHG ( for Green House Gas ) and FRMP ( Flexible Ramping Marginal Price)

string Yes

schedulingPoint Unique identifier of the scheduling point. string No

Direction This element indicates the flow of energy/capacity in or out of the CAISO Control Area. Valid values are I (for Import) and E (for Export).

string No


string No


integer No


integer No



Price This element represents the price associated with the current record.

float No

FlexibleRampingPriceBreakdown (optional)

flexibleRampingPrice Resource specific flexible ramp price breakdown into each host control area group

float Yes

hostControlAreaGroup Host control area group identifier string Yes

Page 74 of 166


Page 75 of 166


20 Retrieve Start Up Shut Down Instructions



Message WSDL XSD

RetrieveStartUp ShutDown Instruction

Input RetrieveStartUpShut DownInstructionRequest

retrieveStartUpShutDownInstructions_DocAttachRequest

RetrieveStartUpShutDownInstructions_v1. wsdl

retrieveStartUpShutDownInstructions_v1_DocAttach.wsdl

RequestStartUp ShutDownInstructions_v1.xsd

Output RetrieveStartUpShut DownInstructionResponse

retrieveStartUpShutDownInstructions_DocAttachResponse

StartUpShutDown Instructions_v1.xsd


20.2 Start Up Shut Down Instructions Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes

Page 76 of 166






String No

instructionSourceList This element represents the source where the instruction originated. The valid values are RUC (for Residual Unit Commitment process), and ELC (For Extremely Long Start Commitment process).

String No

instructionTypeList The type of instruction. Valid values are: STARTUP (for a start up instruction), TRANSITION (for a multi-stage generator or MSG transition instruction)

String No

resourceList The unique identifier for a resource. String No

operatingModeList This element represents whether the unit is operating in generating or pumping mode. Valid values are GEN (for generating mode), and PUMP (for pumping mode).

String No


String No

20.3 Start Up Shut Down Instructions Response



Message Header


dateTime Yes

Source Source system which provides data for this service.

string Yes


string Yes

Message Payload

resource



string Yes

Page 77 of 166




string Yes


string No


This element will only be populated when the record is a startup instruction of an MSG unit; otherwise this element will not be included in the output payload for transition instructions.

string No

transitionFromConfiguration

A transition connects two configurations. This element represents the starting configuration identifier of the transition for an MSG (multi-stage generator) resource.

This element will be populated when the InstructionType of the record is a “Transition”; otherwise this element will not be included in the output payload.

string No

transitionToConfiguration

A transition connects two configurations. This element represents the ending configuration identifier of the transition for an MSG (multi-stage generator) resource.

This element will be populated when the InstructionType of the record is a “Transition”; otherwise this element will not be included in the output payload.

string No




date No

instructionSource This element represents the source where the instruction originated. The valid values are RUC (for Residual Unit Commitment process), and ELC (For Extremely Long Start Commitment process).

string Yes

instructionType The type of instruction. Valid values are: STARTUP (for a start up instruction), TRANSITION (for a multi-stage generator or MSG transition instruction)

string Yes

startTime If the instructionType of the record is:

“Startup”, then this element is the start date and time, in California Prevailing Time, when the unit should be online, i.e. expected to be at the Minimum Load Level;

“Transition”, then this element is the (start) date and time, in California Prevailing Time, when the multi-stage generator (MSG) unit should start its transitioning process.

dateTime No

Page 78 of 166



endTime If the instructionType of the record is:

“Startup”, then this element’s data value is NULL;

“Transition”, then this element is the (end) date and time, in California Prevailing Time, when the multi-stage generator (MSG) unit should complete its transitioning process.

dateTime No

bindingFlag A flag to indicate if the instruction is binding

NOTE: Startup instructions from RUC or the ELC process will always be binding.

string Yes

instructionCost The cost associated with the instruction. float Yes

operatingMode This element represents whether the unit is operating in generating or pumping mode. Valid values are GEN (for generating mode), and PUMP (for pumping mode).

string No

startTime_GMT If the instructionType of the record is:

“Startup”, then this element is the start date and time, in Greenwich Mean Time (GMT), when the unit should be online, i.e. expected to be at the Minimum Load Level;

“Transition”, then this element is the (start) date and time, in Greenwich Mean Time (GMT), when the multi-stage generator (MSG) unit should start its transitioning process.

dateTime Yes

endTime_GMT If the instructionType of the record is:

“Startup”, then this element’s data value is NULL;

“Transition”, then this element is the (end) date and time, in Greenwich Mean Time (GMT), when the multi-stage generator (MSG) unit should complete its transitioning process.

dateTime No

Page 79 of 166


21 Retrieve Two Day Ahead MSSA Load Forecast



Message WSDL XSD

retrieveTwoDayMSSALoadForecast

Input RetrieveTwoDayMSSALoadForecastRequest

retrieveTwoDayMSSALoadForecast_DocAttachRequest

retrieveTwoDayMSSALoadForecast_v1.wsdl

retrieveTwoDayMSSALoadForecast_v1_DocAttach.wsdl

RequestTwoDayMSSALoadForecast_v1.xsd

Output RetrieveTwoDayMSSALoadForecastResponse

retrieveTwoDayMSSALoadForecast_DocAttachResponse

TwoDayMSSALoadForecast_v1.xsd


21.2 Two Day MSSA Load Forecast Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes



Page 80 of 166


21.3 Two Day MSSA Load Forecast Response



Message Header


dateTime Yes



string Yes

Message Payload



MSSZone A geographically contiguous system located within a single zone which has been operating as electric utility for a number of years prior to the CAISO Operations Date as a municipal utility, water district, irrigation district, state agency or federal power marketing authority.

string Yes


date No


integer No



MW MW for the TradeHourData float Yes

Page 81 of 166


22 Retrieve Unit Commitments



Message WSDL XSD

RetrieveUnitCommitments

Input RetrieveUnitCommitmentsRequest

retrieveUnitCommitments_DocAttachRequest

retrieveUnitCommitments_v1.wsdl

retrieveUnitCommitments_v1_DocAttach.wsdl

RequestUnitCommitments_v1.xsd

Output RetrieveUnitCommitmentsResponse

retrieveUnitCommitments_DocAttachResponse

UnitCommitments_v1.xsd

Fault FaultReturnType StandardOutput.xsd

22.2 Unit Commitments Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes



Page 82 of 166




String No


String No

operatingModeList This element represents whether the unit is operating in generating or pumping mode. Valid values are GEN (for generating mode), and PUMP (for pumping mode).

string No

commitmentTypeList This element represents the source where the commitment originated. For the purpose of this report, a commitment can be self commitment or can originate from the market. When the commitment is originated from the market, it can be originated by either the IFM process or the RUC process of the market. Valid values are SELF (for self commitment), IFM (for IFM process of market), and RUC (for RUC process of market).

string No



string No

22.3 Unit Commitments Response



Message Header


dateTime Yes



string Yes

Message Payload

resource



string Yes

Page 83 of 166




string Yes



string No



marketType The identifier for the market type. Valid values are DAM (for day ahead market), and RTM (for the HASP reports).

string Yes


date No


string No

operatingMode This element represents whether the unit is operating in generating or pumping mode. Valid values are GEN (for generating mode), and PUMP (for pumping mode).

string No

commitmentType This element represents the source where the commitment originated. For the purpose of this report, a commitment can be self commitment or can originate from the market. When the commitment is originated from the market, it can be originated by either the IFM process or the RUC process of the market. Valid values are SELF (for self commitment), IFM (for IFM process of market), and RUC (for RUC process of market).

string Yes

startTime The start date and time, in California Prevailing Time, of the commitment.

dateTime No

endTime The end date and time, in California Prevailing Time, of the commitment.

dateTime No

startTime_GMT The start date and time, in Greenwich Mean Time (GMT), of the commitment.

dateTime Yes

endTime_GMT The end date and time, in Greenwich Mean Time (GMT), of the commitment.

dateTime Yes

Page 84 of 166


23 Retrieve Non Dispatchable Time Ranges



Message WSDL XSD

Retrieve NonDispatchableTimeRanges

Input retrieveNonDispatchableTimeRangesRequest

retrieveNonDispatchableTimeRanges_DocAttachRequest

retrieveNonDispatchableTimeRanges_v1.wsdl

retrieveNonDispatchableTimeRanges_v1_DocAttach.wsdl

Request NonDispatchableTimeRanges_v1.xsd

Output retrieveNonDispatchableTimeRangesResponse

retrieveNonDispatchableTimeRanges_DocAttachResponse

NonDispatchableTimeRanges_v1.xsd


23.2 Non Dispatchable Time Ranges Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes




string Yes

Page 85 of 166





string No

23.3 Non Dispatchable Time Ranges Response



Message Header


dateTime Yes



string Yes

Message Payload

resource



string Yes



startTime The start time of the startup ramp/transition ramp time periods, forbidden region time periods, or DOP correction; provided in Pacific time

dateTime No

endTime The end time of the startup ramp/transition ramp time periods, forbidden region time periods, or DOP correction; provided in Pacific time

dateTime No

startTime_GMT The start time of the startup ramp/transition ramp time periods, forbidden region time periods, or DOP correction; provided in Greenwich Mean Time (GMT) time

dateTime Yes

endTime_GMT The end time of the startup ramp/transition ramp time periods, forbidden region time periods, or DOP correction; provided in Greenwich Mean Time (GMT) time

dateTime Yes

Page 86 of 166



fromConfiguration This element represents the starting configuration identifier of the transition for an MSG (multi-stage generator) resource.

This element will be populated when the “nonDispatchableType” of the record is a “Transition” (“TRANS”)

string No

toConfiguration If the “nonDispatchableType” is a Startup (“SU”), this

represents the configuration ID of the MSG resource.

If the “nonDispatchableType” is a Transition (“TRANS”), this

element represents the ending configuration identifier of the transition for an MSG (multi-stage generator) resource.

string No

nonDispatchableType This element identifies the type of time period in which a unit is moving up or down but cannot be dispatched.

Valid values:

SU - for the resource Startup ramp time

TRANS – for the MSG resource Transition ramp time

FOR – for Forbidden Region; where the unit DOPs are within

the forbidden region.

DOP – for Dispatch Operating Point; where a DOP correction

is performed due to verbal dispatch

string Yes

Page 87 of 166


24 Retrieve Market Schedules



Message WSDL XSD

retrieveMarket Schedules

Input retrieveMarket SchedulesRequest

retrieveMarket Schedules_DocAttachRequest

retrieveMarket Schedules _v2.wsdl

retrieveMarket Schedules _v3.wsdl

retrieveMarket Schedules _v2_DocAttach.wsdl

retrieveMarket Schedules _v3_DocAttach.wsdl

RequestMarket Schedules _v2.xsd

RequestMarket Schedules _v3.xsd

Output retrieveMarket SchedulesResponse

retrieveMarket Schedules_DocAttachResponse

Market Schedules_v2.xsd

Market Schedules_v3.xsd


24.2 Market Schedules Request





dateTime Yes


Version Minor Version Identifier. This identifier will be used to determine the specific minor version of the desired response structure.

string Yes

Message Payload


Note: To request RTUC Advisory schedules, data ranging from n intervals up to a maximum of one day can be included in the report.

To request RTD advisory schedules, data ranging from n intervals up to a maximum of one hour can only be included in the report.

dateTime Yes

Page 88 of 166




dateTime Yes

executionType The type of process executed under the market run. Valid combination values:


DAM IFM

RTM HASP


RTM RTD (RTD/5-min)

string Yes

marketType The identifier for the market run.

Valid values are DAM (for day ahead market), and RTM (for real-time market; corresponding to the HASP or RTUC execution-types).

Per Fall 2014 release, CMRI will include executionType RTD/5-min data records

string Yes

bindingFlag Indicates if the schedule is binding. Valid values are Y (for Yes) and N (for No or Advisory).

Note: Per Spring 2014 release, only RTPD or RTUC advisory data results i.e “bindingFlag=N” will be available.

string No

product The product associated with the current record. Valid values are EN (for energy), RU (for Reg Up), RD (for Reg Down), SR (for Spinning Reserve), NR (for Non-spinning Reserve), RC_CAP (for RUC Capacity), RC_AWD (for RUC Award), LFU (for Load Following Up Capacity), LFD (for Load Following Down Capacity), RMU (for Regulation Up Mileage), RMD (for Regulation Down Mileage), IEEA ( for imbalance energy export allocation – Fall 2014 release), FRU (for Flexible Ramping Up), FRD (for Flexible Ramping Down).

string No



string No

scheduleType Indicates whether the award was from the CAISO market or self-provided. Valid values are MARKET (for CAISO award), SELF (for self-provided), CLEARED (Total schedule/award which is the total of the market schedule/award and the self-schedule/self-provision MWs.)

string No




string Yes

Page 89 of 166


24.3 Market Schedules Response



Message Header


dateTime Yes


Version Minor Version Identifier; This will match the minor version requested.

string Yes

Message Payload



string No



DAM IFM

RTM HASP


RTM RTD (RTD/5-min)

Per Fall 2014 release, RTD executionType will be added.

string Yes

marketType The identifier for the higher-level market type. Valid values are DAM (for day ahead market), and RTM (for real-time market; corresponding to the HASP or RTUC, RTD execution-types).

Per Fall 2014 release RTD advisory data results will be available.

string Yes



string Yes

Page 90 of 166




Note: Per Spring 2014, this data element will not be provided for advisory schedules.

string No


Note: Per Spring 2014, this data element will not be provided

for advisory schedules.

string No



bindingFlag Indicates if the schedule is binding. Valid values are Y (for Yes) and N (for No or Advisory).

Note: Per Spring 2014 release, only RTPD or RTUC advisory

data results i.e “bindingFlag= N” will be provided/available.

string No

contractType Note: This data element will not be provided. string No

direction This element indicates the flow of energy/capacity in or out of the CAISO Control Area. Valid values are I (for Import) and E (for Export).


string No




string No

location Unique identifier for either the LAP (Load Aggregation Point) or pnode (Price Node).



string No

marketEndTime End time of the market horizon in Greenwich Mean Time (GMT)



datetime No

marketEndTime_PPT End time of the market horizon in Pacific Prevailing Time (PPT)



datetime No

marketStartTime Start time of the market horizon in Greenwich Mean Time (GMT)

datetime No

Page 91 of 166



marketStartTime_PPT

Start time of the market horizon in Pacific Prevailing Time (PPT)

datetime No

product The product associated with the current record. Valid values are EN (for energy), RU (for Reg Up), RD (for Reg Down), SR (for Spinning Reserve), NR (for Non-spinning Reserve), RC_CAP (for RUC Capacity), RC_AWD (for RUC Award), LFU (for Load Following Up Capacity), LFD (for Load Following Down Capacity), RMU (for Regulation Up Mileage), RMD (for Regulation Down Mileage), IEEA ( for imbalance energy export allocation for EIM resources – Fall 2014), FRU (for Flexible Ramping Up), FRD (for Flexible Ramping Down)

string Yes

scheduleType Indicates whether the award was from the CAISO market or self-provided. Valid values are MARKET (for CAISO award), SELF (for self-provided), CLEARED (Total schedule/award which is the total of the market schedule/award and the self-schedule/self-provision MWs.)

string No

schedulingPoint Unique identifier of the scheduling point.


string No

ASRegion The unique identifier for the Ancillary Services Region (AS Region) the resource belongs to.



string No

intervalStartTime Start time of the interval within the market run in Greenwich Mean Time (GMT)

datetime Yes

intervalEndTime End time of the interval within the market run in Greenwich Mean Time (GMT)

datetime No

intervalStartTime_PPT

Start time of the interval within the market run in Pacific Prevailing Time (PPT)

datetime No

intervalEndTime_PPT End time of the interval within the market run in Pacific Prevailing Time (PPT)

datetime No

MW Scheduled MW for the current record. float Yes

tiePointUsedForFlow ID of tie that is used. Primary tie ID if primary tie is available. If primary tie is out, then it is secondary tie ID.

String No

Page 92 of 166


25 Retrieve Market Forecast



Message WSDL XSD

retrieveMarketForecast

Input retrieveMarketForecastRequest

retrieveMarketForecast_DocAttachRequest

retrieveMarketForecast _v1.wsdl

retrieveMarketForecast _v1_DocAttach.wsdl

RequestResourceForecast _v1.xsd

Output retrieveMarketForecastResponse

retrieveMarketForecast_DocAttachResponse

ResourceForecast_v1.xsd


25.2 Market Forecast Request





dateTime Yes



string Yes

Message Payload

The requestResourceForecast.xsd is used for both services: EIRForecast and MarketForecast.

The data elements described below are those relevant in providing the request for the retrieveMarketForecast service only.



dateTime Yes


dateTime Yes

resource The unique identifier for a resource. string No

Page 93 of 166






string Yes

eligibleIntermittentResForecastType

This element is not applicable for requesting market level forecast.

string No

marketForecastType Type of market forecast (ie final forecast used in the market run):

Valid values:

RTUC: Real Time Unit Commitment; 15-minute forecast used

in the RTUC/RTPD market run

RTD: Real Time Dispatch; 5-minute forecast used in the RTD

market run


string Yes

25.3 Market Forecast Response



Message Header


dateTime Yes



string Yes

Message Payload (MarketForecast)

The ResourceForecast.xsd is used for both services: EIRForecast and MarketForecast.

The data elements described below are those relevant in providing the response for the retrieveMarketForecast service only.



string Yes



Page 94 of 166



marketForecastType Type of market forecast (ie final forecast used in the market run):

Valid values:

RTUC: Real Time Unit Commitment; 15-minute forecast used

in the RTUC/RTPD market run

RTD: Real Time Dispatch; 5-minute forecast used in the RTD

market run

string Yes

energyForecastType Energy forecast type.

Valid values:

EPF: Energy Production Forecast

ECF: Energy Consumption Forecast

string Yes

marketEndTime End time of the market horizon in Greenwich Mean Time (GMT)

datetime No

marketEndTime_PPT End time of the market horizon in Pacific Prevailing Time (PPT)

datetime No

marketStartTime Start time of the market horizon in Greenwich Mean Time (GMT)

datetime Yes

marketStartTime_PPT

Start time of the market horizon in Pacific Prevailing Time (PPT)

datetime No


datetime Yes


datetime No

intervalStartTime_PPT

Start time of the interval within the market run in Pacific Prevailing Time (PPT)

datetime No

intervalEndTime_PPT End time of the interval within the market run in Pacific Prevailing Time (PPT)

datetime No

MW Resource-level forecast in MW unit of measurement


float Yes

Page 95 of 166


26 Retrieve EIM Transfer


Note: This service will not provide any data starting Fall 2015 deployment. EIM transfer MW at resource level can be retrieved using MarketAwards API.


Message WSDL XSD

retrieveEIMTransfe

Input retrieveEIMTransferRequest

retrieveEIMTransfer_DocAttachRequest

retrieveEIMTransfer_v1.wsdl

retrieveEIMTransfer _v1_DocAttach.wsdl

RequestEIMTransfer_v1.xsd

Output retrieveEIMTransferResponse

retrieveEIMTransfer_DocAttachResponse

EIMTransfer_v1.xsd


26.2 EIM Transfer Request

Element Table




dateTime Yes



string Yes

Message Payload



dateTime Yes


dateTime Yes

Page 96 of 166






RTM RTD (5-min)

string No


Valid value is RTM (for real-time market; corresponding to the RTUC and RTD execution-types).

If executiontype and marketType are not supplied, the response will include all the values from the RTUC and RTD execution types in the requested time interval.

string No


The unique identifier for a EIM Entity

At least one identifier is required.

string Yes

26.3 EIM Transfer Response

Element Table


Message Header


dateTime Yes



string Yes

Message Payload (EIMTransferRecord)


The unique identifier for the EIM entity. string Yes

marketType The identifier for the higher-level market type. Valid type is RTM (for real-time market; corresponding to the RTUC and RTD execution-types).

string Yes

Page 97 of 166






RTM RTD (RTD/5-min)

string Yes

fromEIMBalancingAuthorityArea

From Energy Imbalance Market Balancing Authority Area String Yes

toEIMBalancingAuthorityArea

To Energy Imbalance Market Balancing Authority Area String Yes

Intertie Intertie ID of the tie line connecting from EIMBalancingAuthorityArea and toEIMBalancingAuthorityArea

String Yes

transmissionServiceProvider

Transmission Service Provider (TSP) ID

String Yes

TradeIntervalData


datetime Yes


datetime No

EIMTransferMW Energy Imbalance Market (EIM) transfer MW amount float Yes

Page 98 of 166


27 Retrieve EIM Test Results

27.1 Operation Details

The service has one operation with three message types. All input and output messages are in XML format.


Message WSDL XSD

retrieveEIMTestResults

Input retrieveEIMTestResultsRequest

retrieveEIMTestResults_DocAttachRequest

retrieveEIMTestResults_v1.wsdl

retrieveEIMTestResults_v2.wsdl

retrieveEIMTestResults _v1_DocAttach.wsdl

retrieveEIMTestResults _v2_DocAttach.wsdl

RequestEIMTestResult_v1.xsd

RequestEIMTestResult_v2.xsd

Output retrieveEIMTestResultsResponse

retrieveEIMTestResults_DocAttachResponse

EIMTestResults_v1.xsd

EIMTestResults_v2.xsd


27.2 EIM Test Results Request

Element Table




dateTime Yes


Version Minor Version Identifier. This minor version identifier will be used to determine the specific version of response.

string Yes

Message Payload

RequestBaseScheduleTestResultsRecords



dateTime Yes


dateTime Yes

Page 99 of 166




Per 2014 Fall release, this element is not applicable.Only use marketType in the request


DAM IFM


RTM RTD (5-min)

string No


Valid value are DAM and RTM ( for day ahead market, IFM is corresponding execution type and for real-time market; corresponding to the RTUC and RTD execution-types).

string No

inputTimeType Base schedule input time. (T-1D for DA , T-75,T-55 and T-40 for RT )

String No


The unique identifier for the EIM entity.

At least one ID is required.

string Yes

27.3 EIM Test Results Response

Element Table


Message Header


dateTime Yes


Version Minor Version Identifier. This will match the minor version requested.

string Yes

Message Payload (EIMTestResultsRecord)



string Yes

Page 100 of 166



energyImbalanceMarketBalancingAuthorityArea

Energy imbalance market balancing authority area identifier. String Yes

inputTimeType Base schedule input time. (T-1D for DA , T-75,T-55 and T-40 for RT )

string Yes

marketType The identifier for the higher-level market type. Valid types are DAM ( corresponding execution-type is IFM) and RTM (for real-time market; corresponding to the RTUC and RTD execution-types),

string Yes


Per Fall 2014, system will not populate this element.


DAM IFM


RTM RTD (RTD/5-min)

string No

TradeIntervalData

intervalStartTime Start time of the interval within the market run in Greenwich Mean Time (GMT) ( This is hourly)

datetime Yes


datetime No

EIMBaseScheduleBalancingTest

Base Schedule Balancing Test Result Class

Base Schedule Balancing Test Result Container

DAM: This base schedule balancing test for each EIM BAA is to compare the base schedule total load and total supply. If Load-Supply exceeds 1% threshold, test fails. Otherwise, test passes.

RTM: It is deemed under-schedule for the hour if the sum of base schedules of non-participating resources and the sum of the highest quantity offers in the energy bid range from EIM Participating Resources is less than the total demand forecast for the associated EIM Entity BAA.(resources include interchange with other BAAs.).

RTM: It is deemed over-schedule if the sum of base schedules from non-participating resources and the sum of the lowest quantity offers in the energy bid range from EIM Participating Resources is greater than the total demand forecast.

testResult Base Schedule Balancing Test result: Pass or Fail or Success String Yes

imbalanceAmount Imbalance amount in MW float No

Page 101 of 166



imbalancePercentage Imbalance amount in percentage: Imbalance MW/Demand forecast value

float No

imbalanceDirection Over Schedule or Under Schedule string No

requirementAmount Requirement MW amount for the test float No

EIMTransmissionFeasibilityTest Class

DAM: This base schedule balancing test for each EIM BAA is to compare the base schedule total load and total supply. If Load-Supply exceeds 1% threshold, test fails. Otherwise, test passes.

RTM: It is deemed under-schedule for the hour if the sum of base schedules of non-participating resources and the sum of the highest quantity offers in the energy bid range from EIM Participating Resources is less than the total demand forecast for the associated EIM Entity BAA. (resources include interchange with other BAAs.).

RTM: It is deemed over-schedule if the sum of base schedules from non-participating resources and the sum of the lowest quantity offers in the energy bid range from EIM Participating Resources is greater than the total demand forecast.

testResult Base Schedule Transmission Feasibility Test result: Pass or Fail String Yes

EIMTransFeasibilityTestDetail Class

constraintName

Constraint Name String Yes

constraintType Valid values are NOMOGRAM, INTERTIE and FLOWGATE

String Yes

direction

the direction of a Flow Gate

E and I for Intertie and Flow Gate

String No

flowGateStation Flow Gate From station String No

curveID Curve Id Integer No

segmentID Segment ID Integer No

violationAmount Constraint violation MW amount Float Yes

violationPercentage Contraint violation in percentage Float Yes

EIMFlexibleRampRequirementSufficiencyTest

Flexible Ramping Requirement Sufficiency Test Result Container. This is only applicable to RTM.

testResult Base Schedule Flexible Ramping Requirement Sufficiency Test result: Pass or Fail

String Yes


Page 102 of 166



testIndicator For each trading hour, there will be four flexible ramp capacity requirement sufficiency tests: 1. ramp time duration is the first 15-minute interval; 2. ramp time duration is 30-minutes spanning two 15-minute intervals; 3. ramp time duration is 45-minutes spanning three 15-minute intervals; 4. ramp time duration is 60 minutes spanning the four 15-minute intervals

String Yes

EIMFlexibleRampReqTestDetails Class

rampType Ramp Types ( UP and DOWN)

String Yes

insufficiencyAmount shortage MW amount Float No

insufficiencyPercentage

Shortage MW in % Float No

EIMBidRangeCapacityTest Class

Class for bid range capacity test. This is performed if the balancing test fails.

testResult Pass and Fail and Success

If EIM entity selects ISO demand forecast option-Pass or Fail

If EIM entity selects its own demand forecast option- Success

String Yes


additionalDecrementalRequirement

Additional decremental requirements due to excess supply Float No

additionalIncrementalRequirement

Additional incremental requirements due to insufficient supply Float No

imbalanceAmount Imbalance amount in MW Float No

imbalancePercentage Imbalance percentage Float No

imbalanceDirection OVER or UNDER ( Over schedule or Under Schedule) String No

Page 103 of 166


28 Retrieve Load Base Schedules




Message WSDL XSD

retrieveLoadBaseSchedules

Input retrieveLoadBaseSchedulesRequest

retrieveLoadBaseSchedules_DocAttachRequest

retrieveLoadBaseSchedules_v1.wsdl

retrieveLoadBaseSchedules _v1_DocAttach.wsdl

RequestLoadBaseSchedules_v1.xsd

Output retrieveLoadBaseSchedulesResponse

retrieveLoadBaseSchedules_DocAttachResponse

LoadBaseSchedules_v1.xsd


28.2 Load Base Schedules Request

Element Table




dateTime Yes



string Yes

Message Payload

RequestLoadBaseSchedulesRecord



dateTime Yes


dateTime Yes

Page 104 of 166




Per Fall 2014, this element is not applicable in the request


DAM IFM


RTM RTD (5-min)

string No

inputTimeType

Base schedule input time

Valid values are: T - 1D, T - 75, T - 55 and T - 40

marketType inputTimeType

DAM T - 1D

RTM T - 75

RTM T - 55

RTM T - 40

String No

marketType The identifier for the higher-level market type. Valid values are DAM (for day ahead market), and RTM (for real-time market; corresponding to the RTUC or RTD execution-types)

At least one marketType is required.

string No


The unique identifier for the EIM entity


string Yes

EnergyImbalanceMarketBalancingAuthorityArea

Energy imbalance market balancing authority area. String No

28.3 Load Base Schedules Response

Element Table


Message Header

Page 105 of 166




dateTime Yes



string Yes

Message Payload

BaseScheduleRecord


The unique identifier for the EIM Entity. string Yes

marketType The identifier for the higher-level market type. Valid values are DAM (for day ahead market), and RTM (for real-time market; corresponding to the RTUC or RTD execution-types).

string Yes


Per Fall 2014, this element is not applicable in the response.


DAM IFM


RTM RTD (RTD/5-min)

string No

inputTimeType

Base schedule input time

Valid values are: T - 1D, T - 75, T - 55 and T - 40

marketType inputTimeType

DAM T - 1D

RTM T - 75

RTM T - 55

RTM T - 40

String Yes

energyImbalanceMarketBalancingAuthorityArea

Energy imbalance market balancing authority area. String Yes

resource Unique identifier of a resource. InterTie resources can be represented by either a registered resource ID from MF or by a SIBR formed transaction ID.

String Yes

TradeIntervalData class


datetime Yes

Page 106 of 166




datetime No

baseSchedule Base Schedule amount

float Yes

Page 107 of 166


29 Retrieve EIM Entity Market Base Schedules




Message WSDL XSD

retrieveEIMEntityMarketBaseSchedules

Input retrieveEIMEntityMarketBaseSchedulesRequest

retrieveEIMEntityMarketBaseSchedules_DocAttachRequest

retrieveEIMEntityMarketBaseSchedules_v1.wsdl

retrieveEIMEntityMarketBaseSchedules _v1_DocAttach.wsdl


Output retrieveEIMEntityMarketBaseSchedulesResponse

retrieveEIMEntityMarketBaseSchedules_DocAttachResponse



29.2 EIM Entity Market Base Schedules Request

Element Table




dateTime Yes



string Yes

Message Payload

RequestMarketBaseScheduleRecord

Page 108 of 166





dateTime Yes


dateTime Yes

marketType The identifier for the higher-level market type. Valid values are DAM and RTM. Only one market type is allowed.

String Yes

executionType Type of process in which the transaction applies to. Per 2014 Fall release, this element is not applicable.Only use marketType in the request

String No

inputTimeType Base schedule input time type

Valid values are

T-1D, T-75, T-55 and T-40

String No

resourceTypeList The type of resource. Valid values are GEN (for a generating resource) and ITIE (for an intertie resource).

string No


The unique identifier for a EIM Entity.

(At least one ID is required.)

string Yes

resource The unique identifier for a resource

(Inter-tie resources can be either a registered resource id from MF or by a SIBR formed transaction ID)

String No

29.3 EIM Entity Market Base Schedules Response

Element Table


Message Header


dateTime Yes



string Yes

Message Payload

Page 109 of 166



BaseScheduleRecord


The unique identifier for the EIM Entity scheduling coordinator. String Yes


string Yes


String No



String Yes

resourceType The type of resource. string Yes

configuration MSG configuration ID String No

inputTimeType Base schedule input time

Valid values are

T-1D, T-75, T-55 and T-40

String Yes



datetime Yes


datetime No

baseSchedule Base Schedule Amount Float Yes

product The product associated with the current record. Values values are EN, RU ,RD, SR and NR

string Yes

Page 110 of 166


30 Retrieve Market Base Schedules




Message WSDL XSD

retrieveMarketBaseSchedules

Input retrieveMarketBaseSchedulesRequest

retrieveMarketBaseSchedules_DocAttachRequest

retrieveMarketBaseSchedules_v1.wsdl

retrieveMarketBaseSchedules _v1_DocAttach.wsdl


Output retrieveMarketBaseSchedulesResponse

retrieveMarketBaseSchedules_DocAttachResponse



30.2 Market Base Schedules Request

Element Table




dateTime Yes



string Yes

Message Payload

RequestMarketBaseScheduleRecord



dateTime Yes

Page 111 of 166




dateTime Yes

marketType The identifier for the higher-level market type. Valid values are DAM and RTM. Only one market type is allowed.

string Yes


String No


Valid values are

T-1D, T-75, T-55 and T-40

String No

resourceTypeList The type of resource. Valid values are GEN (for a generating resource) and ITIE (for an intertie resource).

string No


The unique identifier for scheduling coordinator


string Yes



String No

30.3 Market Base Schedules Response

Element Table


Message Header


dateTime Yes



string Yes

Message Payload (MarketBaseSchedules)

BaseScheduleRecord

Page 112 of 166




The unique identifier for a scheduling coordinator (SC that is associated with resource in MF)

string Yes


string Yes


String No


Valid values are

T-1D, T-75, T-55 and T-40

String No



String Yes

resourceType The type of resource. string Yes

configuration MSG configuration ID String No



datetime Yes


datetime No

baseSchedule Base Schedule Amount Float Yes

product The product associated with the current record. Values values are EN, RU ,RD, SR and NR

string Yes

Page 113 of 166


31 Retrieve CMRI Inter-tie Resource Transaction ID




Message WSDL XSD

retrieveCMRIInterTieResourceTransactionID

Input retrieveCMRIInterTieResourceTransactionIDRequest

retrieveCMRIInterTieResourceTransactionID_DocAttachRequest

retrieveCMRIInterTieResourceTransactionID_v1.wsdl

retrieveCMRIInterTieResourceTransactionID_v1_DocAttach.wsdl

RequestCMRIInterTieResourceTransactionID_v1.xsd

Output retrieveCMRIInterTieResourceTransactionIDResponse

retrieveCMRIInterTieResourceTransactionID_DocAttachResponse

CMRIInterTieResourceTransactionID_v1.xsd


31.2 CMRI Inter-tie Resource Transaction ID Request

Element Table




dateTime Yes

Source Source system which provides data for this service. String Yes


String Yes

Message Payload

Page 114 of 166






String Yes

31.3 CMRI Inter-tie Resource Transaction ID Response

Element Table


Message Header


dateTime Yes



string Yes

Message Payload ( RegisteredInterTie)

RegisteredInterTie/MRID

SIBR generated Transaction ID. SCID-LID-TID-D-BT[-ET-PSE]

• SCID: Scheduling Coordinator identifier (required);

• LID: Intertie Scheduling Point identifier (required);

• TID is the Primary Intertie identifier (required);

• D: Direction (required): I for Import and E for Export;

• BT: Bid Type (required): P for physical and V for virtual;

• ET: Energy Type (single character, required for physical transactions): F for firm, N for non-firm, U for unit-contingent, D for Dynamic Interchange, and W for wheeling; and

PSE is a registered Purchase-Selling Entity identifier (required for physical transactions, allow PSE, PSE.1, PSE.2, ..., PSE.9)

String Yes

SecondaryFlowgate/mrid

Alternate flowgate ID if Alternate Intertie is available.

String No

Page 115 of 166



AggregatedPnode/mrid Schedule Hub or Schedule Point ID String No

IndividualPnode/mrid Schedule Hub or Schedule Point ID String No

PrimaryFlowgate/mrid Primary flowgate ID.

String Yes

SchedulingCoordinator/mrid

Scheduling Coordinators (SCs) that are registered with the CAISO

String Yes

Direction I: Import E: Export

String Yes

energyProductType Firm Energy : "FIRM” Non Firm Energy : "NFRM" Dynamic Interchange : "DYN" Wheeling : "WHEEL" Unit Contingency : "UCTG"

String Yes

purchaseServiceEntity MasterFile registered Purchase Selling Entity(PSE) String Yes

WheelingResource/mrid Wheeling resource String No

WheelingResource/registeredFlag

Resource flag to indicate MasterFile registered resource ID ( YES OR NO)

String No

Page 116 of 166


32 Retrieve EIM Entity CMRI Inter-tie Resource Transaction ID




Message WSDL XSD

retrieveEIMEntityCMRIInterTieResourceTransactionID

Input retrieveEIMEntityCMRIInterTieResourceTransactionIDRequest

retrieveEIMEntityCMRIInterTieResourceTransactionID_DocAttachRequest

retrieveEIMEntityCMRIInterTieResourceTransactionID_v1.wsdl

retrieveEIMEntityCMRIInterTieResourceTransactionID_v1_DocAttach.wsdl

RequestCMRIInterTieResourceTransactionID_v1.xsd

Output retrieveEIMEntityCMRIInterTieResourceTransactionIDResponse

retrieveEIMEntityCMRIInterTieResourceTransactionID_DocAttachResponse

CMRIInterTieResourceTransactionID_v1.xsd


32.2 EIM Entity CMRI Inter-tie Resource Transaction ID Request

Element Table




dateTime Yes

Source Source system which provides data for this service. String Yes


String Yes

Page 117 of 166



Message Payload



At least one identifer is required.

String Yes

32.3 EIM Entity CMRI Inter-tie Resource Transaction ID Response

Element Table


Message Header


dateTime Yes



string Yes

Message Payload ( RegisteredInterTie)

RegisteredInterTie/MRID

SIBR generated Transaction ID. SCID-LID-TID-D-BT[-ET-PSE]

• SCID: Scheduling Coordinator identifier (required);

• LID: Intertie Scheduling Point identifier (required);

• TID is the Primary Intertie identifier (required);

• D: Direction (required): I for Import and E for Export;

• BT: Bid Type (required): P for physical and V for virtual;

• ET: Energy Type (single character, required for physical transactions): F for firm, N for non-firm, U for unit-contingent, D for Dynamic Interchange, and W for wheeling; and

PSE is a registered Purchase-Selling Entity identifier (required for physical transactions, allow PSE, PSE.1, PSE.2, ..., PSE.9)

String Yes

Page 118 of 166



SecondaryFlowgate/mrid

Alternate flowgate ID if Alternate Intertie is available.

String

No

AggregatedPnode/mrid Schedule Hub or Schedule Point ID String No

IndividualPnode/mrid Schedule Hub or Schedule Point ID String No

PrimaryFlowgate/mrid Primary flowgate ID. String Yes

SchedulingCoordinator/mrid

Scheduling Coordinators (SCs) that are registered with the CAISO

String Yes

direction I: Import E: Export

String Yes

energyProductType Firm Energy : "FIRM” Non Firm Energy : "NFRM" Dynamic Interchange : "DYN" Wheeling : "WHEEL" Unit Contingency : "UCTG"

String Yes

purchaseServiceEntity

MasterFile registered Purchase Selling Entity(PSE)

String

Yes

WheelingResource/mrid Wheeling resource String No

WheelingResource/registeredFlag

Resource flag to indicate MasterFile registered resource ID ( YES OR NO)

String No

Page 119 of 166


33 Retrieve EIM Transfer Limit



Message WSDL XSD

retrieveEIMTransferLimit

Input retrieveEIMTransferLimitRequest

retrieveEIMTransfer_DocAttachRequest

retrieveEIMTransferLimit_v1.wsdl

retrieveEIMTransferLimit_v1_DocAttach.wsdl

RequestEIMTransferLimit_v1.xsd

Output retrieveEIMTransferLimitResponse

retrieveEIMTransferLimit_DocAttachResponse

EIMTransferLimit_v1.xsd


33.2 EIM Transfer Limit Request

Element Table


Message Header(Required)


dateTime Yes



string Yes

Message Payload



dateTime Yes


dateTime Yes

Page 120 of 166






RTM RTD (5-min)

string Yes



String Yes




String Yes

33.3 EIM Transfer Limit Response

Element Table


Message Header


dateTime Yes



string Yes




string Yes


string Yes




RTM RTD (RTD/5-min)

string Yes

Page 121 of 166



resource Energy Transfer System resource identifier String Yes

TradeIntervalData


datetime Yes


datetime No

highLimit High limit of Energy Imbalance Market (EIM) transfer per Energy Transfer System Resource (ETSR). The high limit indicating the maximum limit that can be transferred from a group.

float No

lowLimit Low limit of Energy Imbalance Market (EIM) transfer per Energy Transfer System Resource (ETSR). The lower limit indicating the minimum limit that can be transferred from a group.

float No

Page 122 of 166


34 Retrieve EIM Entity Transfer Limit



Message WSDL XSD

retrieveEIMEntityTransferLimit

Input retrieveEIMEntityTransferLimitRequest

retrieveEIMEntityTransfer_DocAttachRequest

retrieveEIMEntityTransferLimit_v1.wsdl

retrieveEIMEntityTransferLimit_v1_DocAttach.wsdl

RequestEIMTransferLimit_v1.xsd

Output retrieveEIMEntityTransferLimitResponse

retrieveEIMEntityTransferLimit_DocAttachResponse

EIMTransferLimit_v1.xsd


34.2 EIM Entity Transfer Limit Request

Element Table




dateTime Yes



string Yes

Message Payload



dateTime Yes


dateTime Yes

Page 123 of 166






RTM RTD (5-min)

string Yes



String Yes


The unique identifier of the EIM entity.


String Yes

34.3 EIM Entity Transfer Limit Response

Element Table


Message Header


dateTime Yes



string Yes



The unique identifier for the resource scheduling coordinator.

string Yes


string Yes

Page 124 of 166






RTM RTD (RTD/5-min)

string Yes

resource Energy Transfer System resource identifier String Yes

TradeIntervalData


datetime Yes


datetime No

highLimit High limit of Energy Imbalance Market (EIM) transfer per Energy Transfer System Resource (ETSR). The high limit indicating the maximum limit that can be transferred from a group.

float No

lowLimit Low limit of Energy Imbalance Market (EIM) transfer per Energy Transfer System Resource (ETSR). The lower limit indicating the minimum limit that can be transferred from a group.

float No

Page 125 of 166


35 Retrieve EIM Bid Capacity Percentage



Message WSDL XSD

retrieveEIMBidCapacityPercentage

Input retrieveEIMBidCapacityPercentageRequest

retrieveEIMBidCapacity_DocAttachRequest

retrieveEIMBidCapacityPercentage_v1.wsdl

retrieveEIMBidCapacityPercentage_v1_DocAttach.wsdl


Output retrieveEIMBidCapacityPercentageResponse

retrieveEIMBidCapacityPercentage_DocAttachResponse



35.2 EIM Bid Capacity Percentage Request

Element Table




dateTime Yes



string Yes

Message Payload

Page 126 of 166




Note: Being that the resultset of this report spans an entire month (15th to 15th), the report output is based on data where its request “dateTimeStart” is between the effective start and end period. The request will ignore“dateTimeEnd” value, even though this is required per schema definition.

Example: Data is effective 01/15/2015 to 02/15/2015. To request for this dataset, the input can be any “dateTimeStart” date between 01/15/2015 and 02/15/2015. For this particular case, dateTimeStart =“2015-01-15T08:00:00-00:00”.

dateTime Yes


Please refer to the notation under the “dateTimeEnd” element.

dateTime Yes


The unique identifier for the EIM Entity


string Yes

35.3 EIM Bid Capacity Percentage Response

Element Table


Message Header


dateTime Yes



string Yes

Message Payload (EIMBidCapacityPerformance)

startTime_GMT Start time in Greenwich Mean Time (GMT). datetime Yes

endTime_GMT End time in Greenwich Mean Time (GMT). datetime Yes

balancingAuthorityArea Energy Imbalance market (EIM) balancing authority area name.

String Yes

TradeIntervalData

Page 127 of 166



direction The direction of the schedules being analyzed. Valid values are E (export) or I ( Import)

String Yes

HR Trade Hour Integer Yes

percentageDelivered The Percentage of MW delivered versus Scheduled for the referenced hour at the referenced Upper or Lower Percentile.

float Yes

percentageLevel The Percentile being reported.Valid values are LOWER or UPPER

String Yes

Page 128 of 166


36 Retrieve EIR Forecast



Message WSDL XSD

retrieveEIRForecast

Input retrieveEIRForecastRequest

retrieveEIRForecast_DocAttachRequest

retrieveEIRForecast _v1.wsdl

retrieveEIRForecast _v1_DocAttach.wsdl

RequestResourceForecast _v1.xsd

Output retrieveEIRForecastResponse

retrieveEIRForecast_DocAttachResponse

ResourceForecast_v1.xsd


36.2 EIR Forecast Request





dateTime Yes



string Yes

Message Payload

The requestResourceForecast.xsd is used for both services: EIRForecast and MarketForecast.

The data elements described below are those relevant in providing the request for the retrieveEIRForecast service only.



dateTime Yes


dateTime Yes


Page 129 of 166




The unique identifier for a scheduling coordinator (SC) or the exception resource ACL (Access Control List) group identifier (examples: EXC_SC01_1234, EXC_SC02,555)

At least one SCID or ACL group identifier is required.

string Yes


Type of Eligible Intermittent Resources (EIR) forecast.

Valid values:

DA: Day-ahead hourly forecast

HAFinal: Hour-ahead final forecast (locked)

HARolling: Hour-ahead forecast including the first final and

the next six advisory forecasts


string Yes

marketForecastType This element is not applicable for requesting EIR Forecast. string No

36.3 EIR Forecast Response



Message Header


dateTime Yes



string Yes

Message Payload (EligibleIntermittentForecast)

The ResourceForecast.xsd is used for both services: EIRForecast and MarketForecast.

The data elements described below are those relevant in providing the response for the retrieveEIRForecast service only.

resource The unique identifier for a resource. string Yes


The unique identifier for a scheduling coordinator (SC), owner of the resource

string Yes

Page 130 of 166




Type of Eligible Intermittent Resources (EIR) forecast.

Valid values:

DA: Day-ahead hourly forecast

HAFinal: Hour-ahead final forecast (locked)

HARolling: Hour-ahead forecast including the first final and

the next 6 advisory forecasts

string Yes

tradeDate This element will not be provided in the response. date No

HR This element will not be provided in the response. integer No

intervalDuration This element will not be provided in the response. integer No

intervalStartTime Start time of the market interval (GMT) dateTime Yes

intervalEndTime End time of the market interval (GMT dateTime No

MW Resource-level forecast in MW unit of measurement float Yes

Page 131 of 166


37 Retrieve EIM Interchange Schedule Data



Message WSDL XSD

retrieveEIMInterchangeScheduleData

Input retrieveEIMInterchangeScheduleDataRequest

retrieveEIMInterchangeScheduleData_DocAttachRequest

retrieveEIMInterchangeScheduleData_v1.wsdl

retrieveEIMInterchangeScheduleData_v1_DocAttach.wsdl

RequestEIMInterchangeScheduleData_v1.xsd

Output retrieveEIMInterchangeScheduleDataResponse

retrieveEIMInterchangeScheduleData_DocAttachResponse

EIMInterchangeScheduleData_v1.xsd


37.2 EIM Interchange Schedule Data Request





dateTime Yes



string Yes

Message Payload


Maximum of one day can be included in this report.

dateTime Yes


dateTime Yes

Page 132 of 166






string Yes

37.3 EIM Interchange Schedule Data Response



Message Header


dateTime Yes



string Yes

Message Payload

checkOutType Identifies type of check out. For this API, only “AFTER_THE_FACT applies.

string No

directionType Direction type. Valid values are:

I = Import

E = Export

string No

energyType Energy product type. Valid values are:

EN, NR, RC, RD, RU, SR

string No

intervalLength Duration of the interval in terms of minutes integer No

marketType Market type. Valid values are:

DAM = Day-Ahead Market

RTM = Real-Time Market (for this API, this only applies)

string No

operatingDate Operating date, hour. Represents the current hour for the start of the Interchange Schedule.

datetime Yes

scheduleType Schedule type. Valid values are:

DYN = Dynamic interchange

FIRM = Firm Energy

NFRM = Non-firm Energy

UCTG = Unit Contingency

WHL = Wheeling

string No

Page 133 of 166



InterTie/mrid Unique interTie identifier string No

IrregularTimePoints/

startDateTime

The start date time stamp for each timepoint for value1 and/or value2.

datetime Yes


endDateTime

The end date time stamp for each timepoint for value1 and/or value2.

datetime No


value1

The first value at the time. The meaning of the value is defined by the derived type of the associated schedule.

float Yes

RegisteredInterTie/

mrid

Unique identifier of the interchange schedule resource string Yes

RegisteredInterTie/

registeredFlag

Resource flag to indicate MasterFile registered resource ID. string Yes

RegisteredInterTie/


Identifier of the EIM Entity of the interchange schedule resource

string Yes

Page 134 of 166


38 Retrieve Greenhouse Gas Cap Data



Message WSDL XSD

retrieve GreenHouseGasCapData

Input retrieve GreenHouseGasCapDataRequest

retrieve GreenHouseGasCapData_DocAttachRequest

retrieve GreenHouseGasCapData_v1.wsdl

retrieve GreenHouseGasCapData_v1_DocAttach.wsdl

Request GreenHouseGasCapData_v1.xsd

Output retrieve GreenHouseGasCapDataResponse

retrieve GreenHouseGasCapData_DocAttachResponse

GreenHouseGasCapData_v1.xsd


38.2 Greenhouse Gas Cap Data Request





dateTime Yes



string Yes

Message Payload



dateTime Yes


dateTime Yes

Page 135 of 166




The unique identifier for the scheduling coordinator.


string Yes


Valid values are DAM (for day ahead market), and RTM (for real-time market).

Note: For fall 2016 release, only “RTM” applies.

string No

resource Unique identifier for the resource. string No

38.3 Greenhouse Gas Cap Data Response



Message Header


dateTime Yes



string Yes

Message Payload

intervalStartTime Start time of the market interval in GMT dateTime Yes

intervalEndTime End time of the market interval in GMT dateTime No



Note: For fall 2016 release, only “RTM” applies.

resource Unique identifier for the resource. string Yes


Unique identifier for the scheduling coordinator (SC). string Yes

greenHouseGasCap EIM Greenhouse gas bid cap (maximum cost) in $/MWH unit string No

Page 136 of 166


39 Retrieve Electricity Price Index



Message WSDL XSD

retrieve ElectricityPriceIndex

Input retrieve ElectricityPriceIndexRequest

retrieve ElectricityPriceIndex_DocAttachRequest

retrieve ElectricityPriceIndex_v1.wsdl

retrieve ElectricityPriceIndex_v1_DocAttach.wsdl

Request ElectricityPriceIndex_v1.xsd

Output retrieve ElectricityPriceIndexResponse

retrieve ElectricityPriceIndex_DocAttachResponse

ElectricityPriceIndex_v1.xsd


39.2 Electricity Price Index Request





dateTime Yes



string Yes

Message Payload

Page 137 of 166




Note: Being that the resultset of this report could span an entire month (1st to 31st) maximum, the report output is based on data where its request “dateTimeStart” is between the effective start and end period. The application will ignore “dateTimeEnd” value, even though this is required per schema definition.

Example: Data is effective 10/01/2016 to 10/31/2016. To request for this dataset, the input can be any “dateTimeStart” date between 10/01/2016 and 10/31/2016.

dateTime Yes


dateTime Yes




string Yes


39.3 Electricity Price Index Response



Message Header


dateTime Yes



string Yes

Message Payload



Unique identifier for the scheduling coordinator (SC). string Yes

timePeriod Denotes the On or Off peak time period

Valid values: ON_PEAK, OFF_PEAK

string Yes

retailElectricityPriceIndex

The retail electricity price for auxiliary power used in start-up costs for generators.

float No

wholesaleElectricityPriceIndex

The wholesale electricity price for auxiliary power used in start-up costs for generators.

float No

Page 138 of 166



electricityPriceIndex The Electricity Price Index that will be as in input in the day-ahead and real-time market to calculate the auxiliary power portion of start-up costs.

float Yes

electricityPriceIndexType

Corresponds to the type of the electricity price index as input to the day-ahead and real-time market.

string Yes

startTime_GMT Effective start time in GMT Datetime Yes

endTime_GMT Effective end time in GMT datetime Yes

Page 139 of 166


40 Retrieve Resource Level Movement



Message WSDL XSD

retrieve ResourceLevelMovement

Input retrieve ResourceLevelMovementRequest

retrieve ResourceLevelMovement_DocAttachRequest

retrieve ResourceLevelMovement_v1.wsdl

retrieve ResourceLevelMovement_v1_DocAttach.wsdl

RequestResourceMovement_v1.xsd

Output retrieve ResourceLevelMovementResponse

retrieve ResourceLevelMovement_DocAttachResponse

ResourceMovement_v1.xsd


40.2 Resource Level Movement Request





dateTime Yes



string Yes

Message Payload

The requestResourceMovement.xsd is used for both services: ResourceLevelMovement and ResourceMovementPoint


dateTime Yes

Page 140 of 166




Maximum of one hour request for both 15min/RTUC and 5min/RTD retrieval of results.

dateTime Yes





string Yes


Applicable value is RTM (for real-time market; corresponding to the RTD or RTUC execution-types).

Only one marketType is allowed.

string Yes

executionType The type of process executed under the market run. Valid/applicable combination values:



RTM RTD (RTD/5-min)

Only one executionType is allowed.

string Yes

40.3 Resource Level Movement Response



Message Header


dateTime Yes



string Yes

Message Payload

The ResourceMovement.xsd is used for both services: ResourceLevelMovement and ResourceMovementPoint.

The data elements described below are those relevant in providing the response for the retrieveResourceLevelMovement service only.

Page 141 of 166



resource The unique identifier for the resource. string Yes

configuration Configuration ID of MSG resource.

Note: Resource Level Movement is defined at the plant level, thus this element will not be provided.

string No





string Yes




RTM RTD (RTD/5-min)

string Yes

product Type of resource level movement. Valid values are:

UMU = Uncertainty Movement Up *

UMD = Uncertainty Movement Up *

UM = Uncertainty Movement **

FMU = Forecasted Movement Up *

FMD = Forecasted Movement Up *

FM = Forecasted Movement **

* = Applicable for data prior to fall 2016 Flexible Ramping project activation

** = Applicable for data on/after fall 2016 Flexible Ramping project activation

string Yes

intervalStartTime Start time of the interval in Greenwich Mean Time (GMT) datetime Yes

intervalEndTime End time of the interval in Greenwich Mean Time (GMT) datetime No

MW Amount of uncertainty movement or forecasted movement float No

Page 142 of 166


41 Retrieve Resource Movement Point



Message WSDL XSD

retrieve ResourceMovementPoint

Input retrieve ResourceMovementPointRequest

retrieve ResourceMovementPoint_DocAttachRequest

retrieve ResourceMovementPoint_v1.wsdl

retrieve ResourceMovementPoint_v1_DocAttach.wsdl

RequestResourceMovement_v1.xsd

Output retrieve ResourceMovementPointResponse

retrieve ResourceMovementPoint_DocAttachResponse

ResourceMovement_v1.xsd


Page 143 of 166


41.2 Resource Movement Point Request





dateTime Yes



string Yes

Message Payload

The requestResourceMovement.xsd is used for both services: ResourceLevelMovement and ResourceMovementPoint


dateTime Yes


Maximum of one hour request for both 15min/RTUC and 5min/RTD retrieval of results.

dateTime Yes





string Yes



Only one marketType is allowed.

string Yes




RTM RTD (RTD/5-min)

Only one executionType is allowed.

string Yes

Page 144 of 166


41.3 Resource Movement Point Response



Message Header


dateTime Yes



string Yes

Message Payload

The ResourceMovement.xsd is used for both services: ResourceLevelMovement and ResourceMovementPoint.

The data elements described below are those relevant in providing the response for the retrieveResourceMovementPoint service only.

resource The unique identifier for the resource. string Yes

configuration Configuration ID of MSG resource.

Note: Resource Level Movement is defined at the plant level, thus this element will not be provided.

string No





string Yes




RTM RTD (RTD/5-min)

string Yes

movementPoint Movement energy point, valid values are:

MOVEMENT_START = Denotes starting point of the movement based on the binding interval

MOVEMENT_END = Denotes end point of the movement based on the first advisory interval

string Yes



MW MW amount for resource movement calculation float No

Page 145 of 166


42 Retrieve Daily Electricity Price Index



Message WSDL XSD

retrieveDailyElectricityPriceIndexRequest

Input retrieveDailyElectricityPriceIndexRequest

retrieveDailyElectricityPriceIndex_DocAttachRequest

retrieveDailyElectricityPriceIndex_v1.wsdl

retrieveDailyElectricityPriceIndex_v1_DocAttach.wsdl

RequestDailyElectricityPriceIndex_v1.xsd

Output retrieveDailyElectricityPriceIndexResponse

retrieveDailyElectricityPriceIndex_DocAttachResponse

DailyElectricityPriceIndex_v1.xsd


42.2 Daily Electricity Price Index Request





dateTime Yes



string Yes

Message Payload


dateTime Yes

Page 146 of 166




dateTime Yes




string Yes



String Yes


42.3 Daily Electricity Price Index Response



Message Header


dateTime Yes



string Yes

Message Payload


schedulingCoordinator Unique identifier for the scheduling coordinator (SC). string Yes



String Yes

electricityPriceIndex The Electricity Price Index that will be as in input in the day-ahead and real-time market to calculate the auxiliary power portion of start-up costs.

float Yes


intervalEndTime End time of the interval in Greenwich Mean Time (GMT) datetime Yes

electricityPriceIndexType Corresponds to the type of the electricity price index as input to the day-ahead and real-time market.

string Yes

Page 147 of 166


43 Retrieve Actual Limitation Values



Message WSDL XSD

retrieveActualLimitationValuesRequest

Input retrieveActualLimitationValuesRequest

retrieveActualLimitationValues_DocAttachRequest

retrieveActualLimitationValues_v1.wsdl

retrieveActualLimitationValues_v1_DocAttach.wsdl

RequestActualLimitationValues_v1.xsd

Output retrieveActualLimitationValuesResponse

retrieveActualLimitationValues_DocAttachResponse

ActualLimitationValues_v1.xsd


43.2 Actual Limitations Values Request





dateTime Yes



string Yes

Message Payload

Page 148 of 166




Note: Being that the resultset of this report could span an entire month (1st to 31st) maximum, the report output is based on data where its request “dateTimeStart” is between the effective start and end period. The application will ignore “dateTimeEnd” value, even though this is required per schema definition.


dateTime Yes


dateTime Yes




string Yes


43.3 Actual Limitation Values Response



Message Header


dateTime Yes



string Yes

Message Payload


schedulingCoordinator Unique identifier for the scheduling coordinator (SC) string Yes

actualOutput The output in MWH float Yes

actualRunHour The number of hours the unit had a run. integer Yes

actualStartUp The number of times a unit had a start up. integer Yes

startTime_GMT Starting DateTime of the time period for which the data is applicable.

dateTime Yes

Page 149 of 166



endTime_GMT Ending DateTime of the time period for which the data is applicable.

dateTime Yes

44 Retrieve External Default Commitment Cost



Message WSDL XSD

retrieveExternalDefaultCommitmentCostRequest

Input retrieveExternalDefaultCommitmentCostRequest

retrieveExternalDefaultCommitmentCost_DocAttachRequest

retrieveExternalDefaultCommitmentCost_v1.wsdl

retrieveExternalDefaultCommitmentCost_v1_DocAttach.wsdl

RequestExternalDefaultCommitmentCost_v1.xsd

Output retrieveExternalDefaultCommitmentCostResponse

retrieveExternalDefaultCommitmentCost_DocAttachResponse

ExternalDefaultCommitmentCost_v1.xsd


44.2 External Default Commitment Cost Request





dateTime Yes


Page 150 of 166




string Yes

Message Payload


dateTime Yes


dateTime Yes




string Yes


44.3 External Default Commitment Cost Response



Message Header


dateTime Yes



string Yes

Message Payload



minLoadCost Default minimum load cost value measured in $ dollar per hour.

float No



configuration Configuration ID of MSG resource. string No

publicationTimeStamp Time Stamp where all default commitment cost are updated from SIBR

datetime Yes

Page 151 of 166



StartUpCost.StartUpCosCurveSeg

A set of three curve segments comprised of the cooling time in mins, and price in dollar ($) unit

minutes cooling time in mins float Yes

price price in dollar ($) unit float Yes

Transition

fromConfiguration From Configuration ID for MSG resources only String Yes

toConfiguration To Configuration ID for MSG resources String Yes

TransitionCost Transition Cost float Yes

45 Retrieve Resource Opportunity Cost



Message WSDL XSD

retrieveResourceOpportunityCost_v1

Input retrieveResourceOpportunityCostRequest

retrieveResourceOpportunityCost_DocAttachRequest

retrieveResourceOpportunityCost_v1.wsdl

retrieveResourceOpportunityCost_v1_DocAttach.wsdl

RequestResourceOpportunityCost_v1.xsd

Output retrieveResourceOpportunityCostResponse

retrieveResourceOpportunityCost_DocAttachResponse

ResourceOpportunityCost_v1.xsd


Page 152 of 166


45.2 Resource Opportunity Cost Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes



String No




string Yes


opportunityCostGranularity

Valid values: DAILY or MONTHLY String Yes

45.3 Resource Opportunity Cost Response



Message Header


dateTime Yes



string Yes

Page 153 of 166



Message Payload



configuration Configuration ID of MSG resource. string No

fromConfiguration From Configuration ID for MSG resources only String No



marketType is required for

opportunityCostGranularity=’DAILY’ and will be ignored for opportunityCostGranularity= ‘MONTHLY’

String No

toConfiguration To Configuration ID for MSG resources String No

startTime_GMT Starting DateTime of the time period for which the data is applicable.

dateTime Yes

endTime_GMT Ending DateTime of the time period for which the data is applicable.

dateTime Yes

opportunityCost Opportunity cost adder: opportunity cost for start is adder for startup cost, opportunity cost for run hour is adder for minimum load cost, and opportunity cost for energy is adder for DEB cost. Resource can have one opportunity cost for one start up and/or one run hour, and/or one Energy

float Yes

opportunityCostType Opportunity cost type (negotiated/modeled) one res ID can have 1 opportunity cost type: Opportunity cost is for the commitment cost and Energy cost. Resource opportunity cost can be negotiated if standard model is not applicable. The value can be one of enumerated value ( CALCULATED or NEGOTIATED)

String No

useLimitType Limit type (start/runhour/energy), one res ID can have 1 or 2 or 3 limit types: use limit type include start up limit (Number of start of the unit for the year and/or month), run hour limit (number of hours unit can run for the year and/or month) and total MWh the unit can produce for the year and/or month. The value can be one of the enumerated value ( ENERGY, RUNHOURS or START)

String Yes

Page 154 of 166


46 Retrieve Gas Burn Resource Data



Message WSDL XSD

retrieveGasBurnResourceData_v1

retrieveGasBurnResourceData_v1_DocAttach

Input retrieveGasBurnResourceDataRequest

retrieveGasBurnResourceData_DocAttachRequest

retrieveGasBurnResourceData_v1.wsdl

GasBurnResource_v1_DocAttach.wsdl

RequestGasBurnResourceData_v1.xsd

Output retrieveGasBurnResourceDataResponse

retrieveGasBurnResourceData_DocAttachResponse

GasBurnResourceData_v1.xsd


46.2 Gas Burn Resource Data Request





dateTime Yes



string Yes

Message Payload


dateTime Yes


dateTime Yes

Page 155 of 166





DAM IFM

2DA IFM

DAM RUC

2DA RUC

RTM RTUC

string Yes


Valid values are DAM (for day ahead market), 2DA (for 2 day ahead market) and RTM (for real-time market).

String Yes

GasCompanyList

Gas Company unique identifiers List. This is required element. At least one identifier is required.

gasCompany The unique identifier for the Gas company.

string Yes

GasZoneList

GasZone unique identifiers List. This is optional element

name Unique name of the Gas Zone String Yes

summaryLevel The summary level at which the gas zone is defined.

The value is one of the value from following enumeration list.

FZONE - The Forecast Zone level

GASCO - The Gas Company level

GASMTR -The Gas Meter level

SAREA - The Service Area level

TZONE - The transmission Zone level

Note: The Gas Company level (GASCO) is only useful when a user has access to more than one Gas company and want to filter data for specific Gas Company.

string Yes

ResourceList

Resource unique identifiers List. This is optional element.


Page 156 of 166


46.3 Gas Burn Resource Data Response



Message Header


dateTime Yes



string Yes

Message Payload




DAM IFM

2DA IFM

DAM RUC

2DA RUC


string Yes

forecastZone The forecast zone string No

gasCompany The gas company string Yes

gasCustomerMeter The gas customer meter string Yes

marketStartTime The start time of the market dateTime No

marketEndTime The end time of the market dateTime No

marketType Valid values are DAM (for day ahead market), 2DA (for 2 day ahead market) and RTM (for real-time market).

String Yes

pipeline The pipeline string Yes


serviceArea The gas service area string Yes

transmissionZone The transmission zone string No

TradeIntervalData

gasBurn The gas burn data in MMcf. float Yes

Page 157 of 166



intervalStartTime Start time of the interval within the Market Run in Greenwich Mean Time.

dateTime Yes

intervalEndTime Start time of the interval within the Market Run in Greenwich Mean Time.

dateTime No

47 Retrieve Gas Burn Summary Data



Message WSDL XSD

retrieveGasBurnSu

mmaryData_v1

retrieveGasBurnSummaryData_v1_DocAttach

Input retrieveGasBurnSummaryDataRequest

retrieveGasBurnSummaryData_DocAttachRequest

retrieveGasBurnSummaryData_v1.wsdl

retrieveGasBurnSummaryData_v1_DocAttach.wsdl

RequestGasBurnSummaryData_v1.xsd

Output retrieveGasBurnSummaryDataResponse

retrieveGasBurnSummaryData_DocAttachResponse

GasBurnSummaryData_v1.xsd


47.2 Gas Burn Summary Data Request





dateTime Yes

Page 158 of 166





string Yes

Message Payload


dateTime Yes


dateTime Yes



DAM IFM

DAM RUC

2DA IFM

2DA RUC

RTM RTUC

string Yes

marketType The identifier for the market type


String Yes

GasCompanyList

Gas Company unique identifiers List. This is required element. At least one identifier is required.

gasCompany The unique identifier for the Gas company.

string Yes

GasZoneList

GasZone unique identifiers List. This is optional element

name Unique name of the Gas Zone String Yes








Note: The Gas Company level (GASCO) is only useful when a user has access to more than one Gas company and want to filter data for specific Gas Company.

string Yes

Page 159 of 166


47.3 Gas Burn Summary Data Response



Message Header


dateTime Yes



string Yes

Message Payload



String Yes



DAM IFM

DAM RUC

2DA RUC

RTM RTUC

2DA IFM

string Yes

marketStartTime The start time of the market dateTime No

marketEndTime The end time of the market dateTime No

TradeIntervalData

gasBurn The gas burn data in MMcf. float Yes

name Unique name of the gas zone string Yes

Page 160 of 166










string Yes

intervalStartTime Start time of the interval within the Market Run in Greenwich Mean Time.

dateTime Yes

intervalEndTime Start time of the interval within the Market Run in Greenwich Mean Time.

dateTime No

gasCompany The gas company string Yes

48 Retrieve EIM Bid Capacity Percentage v2



Message WSDL XSD

retrieveEIMBidCapacityPercentage

Input retrieveEIMBidCapacityPercentageRequest

retrieveEIMBidCapacity_DocAttachRequest

retrieveEIMBidCapacityPercentage_v2.wsdl

retrieveEIMBidCapacityPercentage_v2_DocAttach.wsdl


Output retrieveEIMBidCapacityPercentageResponse

retrieveEIMBidCapacityPercentage_DocAttachResponse



Page 161 of 166


48.2 EIM Bid Capacity Percentage Request

Element Table




dateTime Yes



string Yes

Message Payload


Note: Being that the resultset of this report could span an entire month (1st to 31st) maximum, the report output is based on data where its request “dateTimeStart” is between the effective start and end period. The application will ignore “dateTimeEnd” value, even though this is required per schema

definition.


dateTime Yes


Please refer to the notation under the “dateTimeEnd” element.

dateTime Yes




string Yes

48.3 EIM Bid Capacity Percentage Response

Element Table


Message Header


dateTime Yes


Page 162 of 166




string Yes

Message Payload (EIMBidCapacityPerformance)

startTime_GMT Start time in Greenwich Mean Time (GMT). datetime Yes

endTime_GMT End time in Greenwich Mean Time (GMT). datetime Yes

balancingAuthorityArea Energy Imbalance market (EIM) balancing authority area name.

String Yes

TradeIntervalData

HR Trade Hour Integer Yes

HighAbsoluteDelivered The high percentile is the absolute net hourly intertie over-scheduling.

float Yes

HighRelativeDelivered The high percentile is the relative net hourly intertie over-scheduling and will be set to zero if lower than a high percentile tolerance.

float Yes

LowAbsoluteDelivered The low percentile is the absolute net hourly intertie under-scheduling.

float Yes

LowRelativeDelivered The low percentile is the relative net hourly intertie under-scheduling and will be set to zero if higher than a low percentile tolerance.

float Yes

49 Fault Return

49.1 Fault Return The fault return message is the same for all CMRI services.

Element Table


id Event log identifier. string No

name Event log name. string No

description Event log description. string No

Page 163 of 166



type Event log type. string No

creationTime Event log creation time. date No

collectionType Event log collection type. string No

collectionQuantity Event log collection quantity. string No

Event.result Event result. string No

Event.id Event identifier. string No

Event.name Event name. string No

Event.description Event description. string No

Event.creationTime Event creation time. dateTime No

Event.severity Event severity. string No

Event.priority Event priority. string No

Event.sequence Number

Event sequence number. string No

Event.eventType Event type. string No

Service.id Service identifier. string No

Service.name Service name. string No

Service.description Service description. string No

Service.comments Service comments. string No

50 XML Element Reference

50.1 Data Type Facets

The following table lists frequently used elements and data types, facets that can be applied to the data type, and a description of the data type.

Element Table

Element Data Description Type Ma Max Length

resource Unique identifier for the resource. string

32

Page 164 of 166


Element Data Description Type Ma Max Length

configuration Configuration ID of MSG resource. string

32

fromConfiguration From Configuration ID for MSG resource

String 32

toConfiguration To Configuration ID for MSG resources

String 32



String 12



string 3

Page 165 of 166


Schema (StandardOutput.xsd)

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:m="http://www.caiso.com/soa/2006-06-13/StandardOutput.xsd"

xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.caiso.com/soa/2006-06-

13/StandardOutput.xsd" elementFormDefault="qualified">

<xs:element name="outputDataType" type="m:outputDataType"/>

<xs:complexType name="outputDataType">

<xs:sequence>

<xs:element name="EventLog" type="m:EventLog"

maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType>

<xs:complexType name="EventLog">

<xs:sequence>

<xs:element name="id" type="xs:string" minOccurs="0"/>

<xs:element name="name" type="xs:string" minOccurs="0"/>

<xs:element name="description" type="xs:string" minOccurs="0"/>

<xs:element name="type" type="xs:string" minOccurs="0"/>

<xs:element name="creationTime" type="xs:dateTime" minOccurs="0"/>

<xs:element name="collectionType" type="xs:string" minOccurs="0"/>

<xs:element name="collectionQuantity" type="xs:string" minOccurs="0"/>

<xs:element name="Event" type="m:Event" maxOccurs="unbounded"/>

<xs:element name="Service" type="m:Service" minOccurs="0"

maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType>

<xs:complexType name="Event">

<xs:sequence>

<xs:element name="result" type="xs:string"/>

<xs:element name="id" type="xs:string" minOccurs="0"/>

<xs:element name="name" type="xs:string" minOccurs="0"/>

<xs:element name="description" type="xs:string" minOccurs="0"/>

<xs:element name="creationTime" type="xs:dateTime" minOccurs="0"/>

<xs:element name="severity" type="xs:string" minOccurs="0"/>

<xs:element name="priority" type="xs:string" minOccurs="0"/>

<xs:element name="sequenceNumber" type="xs:string" minOccurs="0"/>

<xs:element name="eventType" type="xs:string" minOccurs="0"/>

</xs:sequence>

</xs:complexType>

<xs:complexType name="Service">

<xs:sequence>

<xs:element name="id" type="xs:string"/>

<xs:element name="name" type="xs:string"/>

<xs:element name="description" type="xs:string"/>

<xs:element name="comments" type="xs:string"/>

</xs:sequence>

</xs:complexType>

</xs:schema>

Page 166 of 166


51 Appendix – dateTime Data Type

The dateTime data type is used to specify a date and a time. Any valid XML datetime format with timezone can be used for the request, but the response will always follow one format. TimeZone information in the request and response is mandatory and it can either be specified as offset hours from UTC or use the “Z” timezone identifier.

The dateTime is specified in the following form YYYY-MM-DDThh:mm:ss[(+|-)hh:mm:ss] where:

where:

YYYY indicates the year

MM indicates the month

DD indicates the day

T indicates the start of the required time section

hh indicates the hour

mm indicates the minute

ss indicates the second

+ (plus) or - (minus) to specify an offset from the UTC time

OR

YYYY-MM-DDThh:mm:ssZ – The ‘Z’ at the end indicates that the timezone is in GMT/UTC format

Note: All components are required.

Request Examples of dateTime format:

2013-07-10T00:00:00-07:00 – offset of 7 hours based on Pacific Daylight Time

2013-01-20T00:00:00-08:00 – offset of 8 hours based on Pacific Standard Time

2013-01-20T08:00:00-00:00 – Timestamp in GMT/UTC

2013-07-10T07:00:00Z – Timestamp in GMT/UTC

Response Example of dateTime format:

2013-01-20T08:00:00-00:00 – Timestamp in GMT/UTC

2013-07-10T07:00:00-00:00– Timestamp in GMT/UTC

Note: There will be a standard output error response returned if the request refers to a datetime format other than the defined acceptable formats described above.