CAISO Market Results Interface (CMRI) Interface Specification Fall 2013 Release

(1)

CAISO Market Results Interface

(CMRI)

Interface Specification

Fall 2013 Release

Version: 1.2

September 3, 2013

(2)

Page2 of14

Information in this document is subject to change.

Revision History

Date Version Description

07/10/2013 1.0 Initial document release related to the Fall 2013 Release: RIMPR Project & CRN report.

07/11/2013 1.1 Under the MarketSchedules section, updated the data description of the "marketStartTime & intervalStartTime" elements from 'local' to 'pacific'

09/03/2013 1.2 Due to the postponement of RIMPR from Fall 2013 to the Spring 2014 release, removed the following realted APIs from this document:

• Retrieve ISO Commitment Cost Details • Retrieve Expected Energy Allocation Details • Retrieve Non Dispatchable Time Ranges • Retrieve Market Schedules

Only retained the API for CRN RetrieveContractUsage report for Fall 2013 release.

(3)

Page3 of14

T

ABLE OF

C

ONTENTS

1 Introduction ... 4

1.1 Purpose ... 4

1.2 Related Documents ... 4

2 Document Release Notes ... 5

2.1 Version 1.2 ... 5

3 Artifacts Package ... 6

3.1 CMRI Fall 2013 Release 1.2 ... 6

4 API Version Support ... 6

5 Retrieve Contract Usage ... 7

5.1 Operation Details ... 7

5.2 Contract Usage Request (RequestContractUsage_v1.xsd) ... 8

5.2.1 Element Table ... 8

5.2.2 Example File ... 8

5.3 Contract Usage Response (ContractUsage_v1.xsd) ... 9

5.3.2 Example file ... 10

5.4 Fault Return ... 11

5.4.2 Schema (StandardOutput.xsd) ... 12

5.4.3 Example XML File (StandardOutput.xml) ... 13

(4)

Page4 of14

1 Introduction

1.1 Purpose

This document describes CAISO Market Results Interface (CMRI) system APIs related to the Fall 2013 release:

• CRN - Contract Reference Number report

Document provides the WSDL, XSD, and XML information required by application programmers to create and send messages and to process response messages.

1.2 Related Documents

Fall 2013 Release Planning page:

(5)

Page5 of14

2 Document Release Notes

2.1 Version 1.2

This document release version 1.0 refers to the following new system data interface specifications:

Report: Contract Usage Reference

A new API version is available to provide the Contract Reference Number CRN report data in XML format via web service:

Service WSDL Request XSD Response XSD Internal Version

retrieve ContractUsage retrieveContractUsage_v 1.wsdl retrieveContractUsage_v 1_DocAttach.wsdl RequestContractUs age_v1.xsd ContractUsage_v1.x sd v20130401

(6)

Page6 of14

3 Artifacts Package

3.1 CMRI Fall 2013 Release 1.2

The artifacts package “CMRI_ArtifactsPackage_Fall2013Release_v1_2.zip” is posted under this page/header: Release Planning / Fall 2013 release / CMRI technical specifications at http://www.caiso.com/informed/Pages/ReleasePlanning/Default.aspx. CMRI_Fall2013Release_v1_2.zip contents: Version Files ContractUsage _v1 ContractUsage _v1.xsd requestContractUsage_v1.xsd retrieveContractUsage _v1.wsdl retrieveContractUsage_v1_DocAttach.wsdl sampleRequest ContractUsage _v1.xml sampleContractUsage _v1.xml

4 API Version Support

Endpoint Service Release API Support Notes

Contract Usage

Retrieve ContractUsage_PTRv1_AP

Retrieve ContractUsage _PTRv1_ DocAttach_AP

Fall 2013

This will be a new service to be deployed/supported per Fall 2013. External systems must refer to the Fall 2013 v1 version to retrieve the Contract Reference Number “CRN” XML data via web service.

Note: This API web service will replace retrieval of XML format files from the sFTP site.

(7)

Page7 of14

5 Retrieve Contract Usage

5.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 retrieveContract Usage Input retrieveContractUs ageRequest retrieveContractUs age_DocAttachReq uest retrieveContractUsage_ v1.wsdl * retrieveContractUsage_ v1_DocAttach.wsdl * RequestContractUsage _v1.xsd * Output retrieveContractUs ageResponse retrieveContractUs age_DocAttachRes ponse ContractUsage_v1.xsd *

Fault faultReturnType StandardOutput.xsd

* File is contained in the artifacts package located under: Release Planning / Fall 2013 release / CMRI technical specifications at

(8)

Page8 of14

5.2 Contract Usage Request (RequestContractUsage_v1.xsd)

5.2.1 Element Table

Element Data Description Type Req’d

tradeDateStart The start date for the date range for which the data is requested (in California Prevailing Time).

date Yes

tradeDateEnd The end date for the date range for which the data is requested (in California Prevailing Time).

date Yes

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

5.2.2 Example File

Refer to the “sampleRequestContractUsage_v1.xml” file contained in the artifacts package located under : Release Planning / Fall 2013 release / CMRI technical specifications at

(9)

Page9 of14

5.3 Contract Usage Response (ContractUsage_v1.xsd)

5.3.1 Element Table

Message Header

TimeDate The dateTime, in California Prevailing Time, when the payload is published.

dateTime Yes

Source The source of published data. The value for this payload is CAISO.

string Yes

Version Date reflecting the release this latest version update was related to. For Fall 2013 release, equal to “v20130401”

string Yes

Message Payload

resource The unique identifier for a resource. string Yes

scheduling Coordinator

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

marketType The identifier for the market type.

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

string Yes

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

date Yes

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

integer Yes

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 Yes

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

contractReferenceNu mber

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

(10)

Page10 of14

5.3.2 Example file

Refer to the “sampleContractUsage_v1.xml” file contained in the artifacts package under: Release Planning / Fall 2013 release / CMRI technical specifications at

(11)

Page11 of14

5.4 Fault Return

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

5.4.1 Element Table

id Event log identifier. string No

name Event log name. string No

description Event log description. string No

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

(12)

Page12 of14

5.4.2 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>

(13)

Page13 of14

5.4.3 Example XML File (

StandardOutput.xml

)

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

<outputDataType xmlns="

http://www.caiso.com/soa/2005-06-21/StandardOutput.xsd" xmlns:xsi=" http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.caiso.com/soa/2005-06-21/StandardOutput.xsd">

<id>String</id> <name>String</name>

<description>String</description> <type>String</type>

<creationTime>2011-08-13</creationTime> <collectionType>String</collectionType>

<collectionQuantity>String</collectionQuantity> <Event>

<result>String</result> <id>String</id>

<name>String</name>

<description>String</description>

<creationTime>2001-12-17T09:30:47.0Z</creationTime> <severity>String</severity>

<priority>String</priority>

<sequenceNumber>String</sequenceNumber> <eventType>String</eventType>

</Event> <Service>

<id>String</id> <name>String</name>

<description>String</description> <comments>String</comments> </Service>

</EventLog> </outputDataType>

(14)

Page14 of14

6 Appendix – dateTime Data Type

The dateTime data type is used to specify a date and a time.

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

Note: All components are required.

Examples:

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

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