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

Transcription

1 CAISO Market Results Interface (CMRI) Interface Specification Fall 2013 Release Version: 1.2 September 3, 2013

2 Revision History Date Version Description 07/10/ Initial document release related to the Fall 2013 Release: RIMPR Project & CRN report. 07/11/ Under the MarketSchedules section, updated the data description of the "marketstarttime & intervalstarttime" elements from 'local' to 'pacific' 09/03/ 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. Page 2 of 14

3 TABLE OF CONTENTS 1 Introduction Purpose Related Documents Document Release Notes Version Artifacts Package CMRI Fall 2013 Release API Version Support Retrieve Contract Usage Operation Details Contract Usage Request (RequestContractUsage_v1.xsd) Element Table Example File Contract Usage Response (ContractUsage_v1.xsd) Element Table Example file Fault Return Element Table Schema (StandardOutput.xsd) Example XML File (StandardOutput.xml) Appendix datetime Data Type Page 3 of 14

4 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: Page 4 of 14

5 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 v Page 5 of 14

6 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 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 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. Page 6 of 14

7 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 retrievecontractusage_ v1.wsdl * RequestContractUsage _v1.xsd * Output retrievecontractus age_docattachreq uest retrievecontractus ageresponse retrievecontractusage_ v1_docattach.wsdl * ContractUsage_v1.xsd * retrievecontractus age_docattachres ponse Fault faultreturntype StandardOutput.xsd * File is contained in the artifacts package located under: Release Planning / Fall 2013 release / CMRI technical specifications at Page 7 of 14

8 5.2 Contract Usage Request (RequestContractUsage_v1.xsd) 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 tradedateend The end date for the date range for which the data is requested (in California Prevailing Time). date 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 scheduling CoordinatorList The unique identifier for a scheduling coordinator (SC). At least one SCID is required. string resourcelist The unique identifier for a resource. string No 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 Page 8 of 14

9 5.3 Contract Usage Response (ContractUsage_v1.xsd) Element Table Element Data Description Type Req d Message Header TimeDate The datetime, in California Prevailing Time, when the payload is published. datetime Source The source of published data. The value for this payload is CAISO. string Version Date reflecting the release this latest version update was related to. For Fall 2013 release, equal to v string Message Payload resource The unique identifier for a resource. string scheduling Coordinator The unique identifier for a scheduling coordinator (SC). string markettype The identifier for the market type. Valid values are DAM (for day ahead market), and RTM (for real-time market) string tradedate The trade day to which the current record pertains (in California Prevailing Time). date HR The hour of the trade day to which the current record pertains (in California Prevailing Time). integer 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 MW Refers to the self-schedule quantity in MW float contracttype Refers to the contract type of the self-schedule transaction ; represented as: ETC - Existing Transmission Contract TOR - Transmission Ownership Rights string 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). string Page 9 of 14

10 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 Page 10 of 14

11 5.4 Fault Return The fault return message is the same for all CMRI services Element Table Element Data Description Type Req d 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 Service.comments Service comments. string No Page 11 of 14

12 5.4.2 Schema (StandardOutput.xsd) <?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:m=" xmlns:xs=" targetnamespace=" 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 12 of 14

13 5.4.3 Example XML File (StandardOutput.xml) <?xml version="1.0" encoding="utf-8"?> <outputdatatype xmlns=" 21/StandardOutput.xsd" xmlns:xsi=" xsi:schemalocation=" 21/StandardOutput.xsd"> <EventLog> <id>string</id> <name>string</name> <description>string</description> <type>string</type> <creationtime> </creationtime> <collectiontype>string</collectiontype> <collectionquantity>string</collectionquantity> <Event> <result>string</result> <id>string</id> <name>string</name> <description>string</description> <creationtime> t09: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> Page 13 of 14

14 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: T00:00:00-07:00 offset of 7 hours based on Pacific Daylight Time T00: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. Page 14 of 14