API Documentation for the PIRP Application - Rev. 1.2

533574506 Technical Interface Specification For PIRP Services Version: 1.2 533574506 Revision History Date Version By Description 05/11/09 0.1 Adriana Paraschiv Create document 05/19/2009 0.2 Adriana Paraschiv Include comments from the technical team 06/25/2009 1.0 Adriana Paraschiv Include solar information 07/02/2009 1.1 Adriana Paraschiv Include SOAP Requests 07/08/09 1.2 Adriana Paraschiv Removed WSDLs Page 2 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 TABLE OF CONTENTS 1 Introduction............................................................................................................................................................................... 9 1.1 Purpose ............................................................................................................................................................................................................................. 9 1.2 Contact Information ........................................................................................................................................................................................................... 9 1.3 Release Notes for PIRP .................................................................................................................................................................................................... 9 1.4 Related Documents ........................................................................................................................................................................................................... 9 1.5 Location of .XSD and .WSDL files ..................................................................................................................................................................................... 9 2 Services Overview .................................................................................................................................................................. 11 2.1 External Market Participant Web Services ...................................................................................................................................................................... 11 2.2 Service Dependencies ..................................................................................................................................................................................................... 11 3 Admin Service ......................................................................................................................................................................... 12 3.1 Business Scenario ........................................................................................................................................................................................................... 12 3.2 Service Level Agreement ................................................................................................................................................................................................ 12 3.3 Use Mode ........................................................................................................................................................................................................................ 12 3.4 Operation Details ............................................................................................................................................................................................................. 13 3.4.1 Operation Details – WSDL URLs ........................................................................................................................................................................ 13 3.5 WSDL .............................................................................................................................................................................................................................. 13 3.5.1 AdminService.wsdl .............................................................................................................................................................................................. 13 3.5.2 Admin Service table............................................................................................................................................................................................. 13 3.5.3 Example SOAP adminServiceRequest ............................................................................................................................................................... 13 4 Forecast Service ..................................................................................................................................................................... 15 4.1 Business Scenario ........................................................................................................................................................................................................... 15 Page 3 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 4.2 Service Level Agreement ................................................................................................................................................................................................ 15 4.3 Use Mode ........................................................................................................................................................................................................................ 15 4.4 Operation Details ............................................................................................................................................................................................................. 16 4.4.1 Operation Details – WSDL URLs ........................................................................................................................................................................ 16 4.5 WSDL .............................................................................................................................................................................................................................. 16 4.5.1 ForecastServicePort.wsdl .................................................................................................................................................................................... 16 4.5.2 Common data types table ................................................................................................................................................................................... 16 4.5.3 Submit Hour Ahead Forecast table ..................................................................................................................................................................... 17 4.5.4 Submit Day Ahead Forecast table ....................................................................................................................................................................... 18 4.5.5 Example SOAP submitHourAheadForecastRequest .......................................................................................................................................... 19 4.5.6 Example SOAP submitDayAheadForecastRequest ........................................................................................................................................... 22 5 Market Service Enhanced ...................................................................................................................................................... 25 5.1 Business Scenario ........................................................................................................................................................................................................... 25 5.2 Service Level Agreement ................................................................................................................................................................................................ 25 5.3 Use Mode ........................................................................................................................................................................................................................ 25 5.4 Operation Details ............................................................................................................................................................................................................. 26 5.4.1 Operation Details – WSDL URLs ........................................................................................................................................................................ 27 5.5 WSDL .............................................................................................................................................................................................................................. 27 5.5.1 MarketServiceEnhancedPort.wsdl ...................................................................................................................................................................... 27 5.5.2 Common data types table ................................................................................................................................................................................... 27 5.5.3 Get Hour Ahead Forecast Enhanced table ......................................................................................................................................................... 29 5.5.4 Get Hour Ahead Forecast Enhanced table ......................................................................................................................................................... 29 5.5.5 Get Day Ahead Forecast table ............................................................................................................................................................................ 30 5.5.6 Get Day Ahead Forecast table ............................................................................................................................................................................ 30 5.5.7 Get Rolling Hour Ahead Forecast table .............................................................................................................................................................. 31 5.5.8 Get Rolling Hour Ahead Forecast table .............................................................................................................................................................. 31 Page 4 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 5.5.9 Example SOAP getHourAheadForecastEnhancedRequestV1 ........................................................................................................................... 32 5.5.10 Example SOAP getHourAheadForecastEnhancedRequestV2 ........................................................................................................................... 33 5.5.11 Example SOAP getDayAheadForecastRequestV1 ............................................................................................................................................. 33 5.5.12 Example SOAP getDayAheadForecastRequestV2 ............................................................................................................................................. 34 5.5.13 Example SOAP getRollingHourAheadForecastRequestV1 ................................................................................................................................ 34 5.5.14 Example SOAP getRollingHourAheadForecastRequestV2 ................................................................................................................................ 35 6 Market Service ........................................................................................................................................................................ 36 6.1 Business Scenario ........................................................................................................................................................................................................... 36 6.2 Service Level Agreement ................................................................................................................................................................................................ 36 6.3 Use Mode ........................................................................................................................................................................................................................ 36 6.4 Operation Details ............................................................................................................................................................................................................. 37 6.4.1 Operation Details – WSDL URLs ........................................................................................................................................................................ 37 6.5 WSDL .............................................................................................................................................................................................................................. 38 6.5.1 MarketServicePort.wsdl ....................................................................................................................................................................................... 38 6.5.2 Common data types table ................................................................................................................................................................................... 38 6.5.3 Get Hour Ahead Forecast table ........................................................................................................................................................................... 39 6.5.4 Get Hour Ahead Forecast table ........................................................................................................................................................................... 40 6.5.5 Get Day Ahead Forecast table ............................................................................................................................................................................ 40 6.5.6 Get Day Ahead Forecast table ............................................................................................................................................................................ 41 6.5.7 Get Rolling Hour Ahead Forecast table .............................................................................................................................................................. 41 6.5.8 Get Rolling Hour Ahead Forecast table .............................................................................................................................................................. 42 6.5.9 Example SOAP getHourAheadForecastRequestV1 ........................................................................................................................................... 42 6.5.10 Example SOAP getHourAheadForecastRequestV2 ........................................................................................................................................... 44 6.5.11 Example SOAP getDayAheadForecastRequestV1 ............................................................................................................................................. 44 6.5.12 Example SOAP getDayAheadForecastRequestV2 ............................................................................................................................................. 45 6.5.13 Example SOAP getRollingHourAheadForecastRequestV1 ................................................................................................................................ 46 Page 5 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 6.5.14 Example SOAP getRollingHourAheadForecastRequestV2 ................................................................................................................................ 46 7 Meter Data Capture Service ................................................................................................................................................... 48 7.1 Business Scenario ........................................................................................................................................................................................................... 48 7.2 Service Level Agreement ................................................................................................................................................................................................ 48 7.3 Use Model........................................................................................................................................................................................................................ 48 7.4 Operation Details ............................................................................................................................................................................................................. 49 7.4.1 Operation Details – WSDL URLs ........................................................................................................................................................................ 49 7.5 WSDL .............................................................................................................................................................................................................................. 49 7.5.1 MeterDataPort.wsdl ............................................................................................................................................................................................. 49 7.5.2 Common data types table ................................................................................................................................................................................... 49 7.5.3 Get Hourly Meter Data table ................................................................................................................................................................................ 50 7.5.4 Get Daily Meter Data table .................................................................................................................................................................................. 51 7.5.5 Example SOAP getHourlyMeterDataRequest ..................................................................................................................................................... 51 7.5.6 Example SOAP getDailyMeterDataRequest ....................................................................................................................................................... 52 8 Operation Service ................................................................................................................................................................... 53 8.1 Business Scenario ........................................................................................................................................................................................................... 53 8.2 Service Level Agreement ................................................................................................................................................................................................ 53 8.3 Use Model........................................................................................................................................................................................................................ 53 8.4 Operation Details ............................................................................................................................................................................................................. 54 8.4.1 Operation Details – WSDL URLs ........................................................................................................................................................................ 54 8.5 WSDL .............................................................................................................................................................................................................................. 54 8.5.1 OperationsServicePort.wsdl ................................................................................................................................................................................ 54 8.5.2 Common data types table ................................................................................................................................................................................... 54 8.5.3 Get Interval Data table ........................................................................................................................................................................................ 55 8.5.4 Get Hour Ahead Availability table ........................................................................................................................................................................ 57 8.5.5 Get Day Ahead Availability table ......................................................................................................................................................................... 58 Page 6 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 8.5.6 Schema ............................................................................................................................................................................................................... 59 8.5.7 Example SOAP getIntervalDataRequest............................................................................................................................................................. 59 8.5.8 Example SOAP getHourAheadAvailabilityRequest ............................................................................................................................................. 60 8.5.9 Example SOAP getDayAheadAvailabilityRequest .............................................................................................................................................. 60 9 Solar Operation Service ......................................................................................................................................................... 62 9.1 Business Scenario ........................................................................................................................................................................................................... 62 9.2 Service Level Agreement ................................................................................................................................................................................................ 62 9.3 Use Model........................................................................................................................................................................................................................ 62 9.4 Operation Details ............................................................................................................................................................................................................. 63 9.4.1 Operation Details – WSDL URLs ........................................................................................................................................................................ 63 9.5 WSDL .............................................................................................................................................................................................................................. 63 9.5.1 SolarOperationsServicePort.wsdl........................................................................................................................................................................ 63 9.5.2 Common data types table ................................................................................................................................................................................... 63 9.5.3 Get Solar Interval Data table ............................................................................................................................................................................... 64 9.5.4 Get Hour Ahead Availability table ........................................................................................................................................................................ 67 9.5.5 Get Day Ahead Availability table ......................................................................................................................................................................... 68 9.5.6 Schema ............................................................................................................................................................................................................... 69 9.5.7 Example SOAP getSolarIntervalDataRequest .................................................................................................................................................... 69 9.5.8 Example SOAP getHourAheadAvailabilityRequest ............................................................................................................................................. 70 9.5.9 Example SOAP getDayAheadAvailabilityRequest .............................................................................................................................................. 70 10 Resource Service ................................................................................................................................................................... 72 10.1 Business Scenario ......................................................................................................................................................................................................... 72 10.2 Service Level Agreement .............................................................................................................................................................................................. 72 10.3 Use Model ..................................................................................................................................................................................................................... 72 10.4 Operation Details ........................................................................................................................................................................................................... 72 10.4.1 Operation Details – WSDL URLs ........................................................................................................................................................................ 73 Page 7 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 10.5 WSDL ............................................................................................................................................................................................................................ 73 10.5.1 OperationsServicePort.wsdl ................................................................................................................................................................................ 73 10.5.2 Get Resources table ............................................................................................................................................................................................ 73 10.5.3 Schema ............................................................................................................................................................................................................... 74 10.5.4 Example SOAP resourceServiceRequest ........................................................................................................................................................... 74 11 Uncorrected Hour Ahead Forecast Service .......................................................................................................................... 75 11.1 Business Scenario ......................................................................................................................................................................................................... 75 11.2 Service Level Agreement .............................................................................................................................................................................................. 75 11.3 Use Model ..................................................................................................................................................................................................................... 75 11.4 Operation Details ........................................................................................................................................................................................................... 75 11.4.1 Operation Details – WSDL URLs ........................................................................................................................................................................ 76 11.5 WSDL ............................................................................................................................................................................................................................ 76 11.5.1 UncorrectedHourAheadForecastServicePort.wsdl .............................................................................................................................................. 76 11.5.2 Get Resources table ............................................................................................................................................................................................ 76 11.5.3 Schema ............................................................................................................................................................................................................... 77 11.5.4 Example SOAP submitUncorrectedHourAheadForecastRequest ...................................................................................................................... 77 Page 8 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 1 Introduction 1.1 Purpose This document describes the FSP interface to CAISO’s PIRP Services. It provides the WSDL, XSD, and XML information required by application programmers to create and send messages and to process response messages. 1.2 Contact Information For any questions regarding this document or technical questions related to integrating applications with CAISO’s PIRP web services, please send email to tbd 1.3 Release Notes for PIRP None at this time 1.4 Related Documents n/a 1.5 Location of .XSD and .WSDL files The file names are listed in the Operational Details section of each service. All posted files can be found at the link below. The posted XSD represents the payload, all the supporting details including all the XSDs and WSDLs for each service are included in the posted zip file. The PIRP Web Services Interface Specification Document Set is available online at the locations indicated below. Doc. No. Document Name 1 AdminService.wsdl 2 ForecastServicePort.wsdl 3 MarketServiceEnhancedPort.wsdl 4 MarketServicePort.wsdl 5 MeterDataPort.wsdl Location Page 9 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Doc. No. Document Name 6 OperationsServicePort.wsdl 7 ResourceServicePort.wsdl 8 UncorrectedHourAheadForecastServicePort.wsdl 9 SolarOperationsService.wsdl Location 10 Page 10 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 2 Services Overview The Web Services provided to support FSP activities and View functions are intended for external Market Participants usage. 2.1 External Market Participant Web Services The external Market Participant Web Services for PIRP are: Service Schema Use Admin Service AdminService.wsdl Allows the PIRP administrator to configure the user and resource management Forecast Service ForecastServicePort.wsdl Allows FSP to submit forecasts Market Service Enhanced MarketServiceEnhancedPort.wsdl Allows Operations to retrieve forecasts Market Service MarketServicePort.wsdl Allows Operations to request forecasts Meter Data MeterDataPort.wsdl Allows Operations to request Meter data Operations Service OperationsServicePort.wsdl Allows Operations to request availability data Solar Operations Service SolarOperationsService.wsdl Allow Operations to request solar availility data Resource Service ResourceServicePort.wsdl Allows the PIRP administrator to configure the user and resource management Uncorrected Hour Ahead Forecast Service UncorrectedHourAheadForecastServicePort.wsdl Allows FSP to submit forecasts 2.2 Service Dependencies n/a Page 11 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 3 Admin Service 3.1 Business Scenario FSP submit forecast through an automated process using the API. 3.2 Service Level Agreement The following service level agreement defines the business and technical requirements for service availability and performance. Service availability 7/24 Expected size of payload (average and maximum) Less than 1MB Expected frequency (average and maximum) Longest time the service can be unavailable before business is impacted Business impact if is unavailable Expected response time for the service 5 min 3.3 Use Mode There is one web service involved:  AdminService Page 12 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 3.4 Operation Details The service has one operation with three message types. All messages are in XML format. Operation Message Types Message WSDL XSD AdminService Input AdminServiceRequest AdminService.wsdl AdminService.wsdl Output AdminServiceResponse Fault 3.4.1 Operation Details – WSDL URLs 3.5 WSDL 3.5.1 AdminService.wsdl 3.5.2 Admin Service table Elements Data Description Req’d XPath Message: Admin Service Request // AdminService / AdminServiceRequest AdminServiceRequest AdminService Message: Admin Service Response // AdminService/ AdminServiceResponse AdminServiceReturn AdminServiceReturn Type anyType anyType 3.5.3 Example SOAP adminServiceRequest Page 13 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 - <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsdd="http://xml.apache.org/axis/wsdd/"> <soapenv:Header /> - <soapenv:Body> <wsdd:AdminService>?</wsdd:AdminService> </soapenv:Body> </soapenv:Envelope> Page 14 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 4 Forecast Service 4.1 Business Scenario FSP submit forecast through an automated process using the API. 4.2 Service Level Agreement The following service level agreement defines the business and technical requirements for service availability and performance. Service availability 7/24 Expected size of payload (average and maximum) Less than 1MB Expected frequency (average and maximum) Once / hour / participant Longest time the service can be unavailable before business is impacted 30 min Business impact if is unavailable SC cannot submit schedules as PIR forecast; possible settlement disputes; workaround is to go to the PIRP browser to find a forecast Expected response time for the service 5 min 4.3 Use Mode There are two web services involved:  submitHourAheadForecast  submitDayAheadForecast Page 15 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 4.4 Operation Details The service has two operations with three message types each. All messages are in XML format. Operation Message Types Message WSDL XSD submitHourAheadForecast Input submitHourAheadForecastRequest ForecastServicePort.wsdl ForecastServicePort.wsdl Output submitHourAheadForecastResponse Fault WebserviceException Input submitDayAheadForecastRequest ForecastServicePort.wsdl ForecastServicePort.wsdl Output submitDayAheadForecastResponse Fault WebserviceException submitDayAheadForecast 4.4.1 Operation Details – WSDL URLs 4.5 WSDL 4.5.1 ForecastServicePort.wsdl 4.5.2 Common data types table Elements Data Description Req’d XPath Type Oper Date // ForecastService /OperDate month month Int dayOfMonth dayOfMonth Int year year Int Webservice Exception // ForecastService/WebserviceException Page 16 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Elements Data Description Req’d XPath Type errorCode Int messageText String pirpTimestamp dateTime ForecastConfirmation // ForecastService/ForecastConfirmation forecastId String actionType String pirpTimestamp dateTime 4.5.3 Submit Hour Ahead Forecast table Element Data Description Req’d XPath Message: Submit Hour Ahead Forecast Request //ForecastService/submitHourAheadForecastRequest houraheadforecast HourAheadForecast Type resId String operDate operDate beginHourEnding Int hourendingforecast ArrayOfHourEndingForecast operDate Array operDate Page 17 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’d XPath Type hourEnding Int mwForecast Double mwConfidenceMin Double mwConfidenceMax Double Message:Submit Hour Ahead Forecast Request Response //ForecastService/submitHourAheadForecastRequestResponse forecastConfirmation ForecastConfirmation Message: Webservice Exception // ForecastService / WebserviceException webserviceexception WebserviceException Complex XPath Type Complex 4.5.4 Submit Day Ahead Forecast table Element Data Description Req’d Message: Submit Day Ahead Forecast Request //ForecastService/ submitDayAheadForecastRequest dayaheadforecast DayAheadForecast resId String operDate OperDate Repeat for hour n={1..25} mwForecastHourEndn Double mwConfidenceMinHourEndn Double Page 18 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’d XPath mwConfidenceMaxHourEndn Type Double Message: Submit Day Ahead Forecast Response //ForecastService/ submitDayAheadForecastResponse forecastConfirmation ForecastConfirmation Message: Webservice Exception // ForecastService / WebserviceException webserviceexception WebserviceException Complex Complex 4.5.5 Example SOAP submitHourAheadForecastRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/ForecastService/1.0" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> <soapenv:Header /> - <soapenv:Body> - <ns:submitHourAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> - <houraheadforecast xsi:type="v1:HourAheadForecast" xmlns:v1="https://pirp.caiso.com/schemas/pirp/v1"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <beginHourEnding xsi:type="xsd:int">18</beginHourEnding> Page 19 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 - <hourendingforecast xsi:type="v1:ArrayOfHourEndingForecast" soapenc:arrayType="v1:HourEndingForecast[]"> - <hourendingforecast xsi:type="v1:HourEndingForecast"> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">18</hourEnding> <mwForecast xsi:type="xsd:double">20.0</mwForecast> </hourendingforecast> - <hourendingforecast xsi:type="v1:HourEndingForecast"> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">19</hourEnding> <mwForecast xsi:type="xsd:double">20.0</mwForecast> </hourendingforecast> - <hourendingforecast xsi:type="v1:HourEndingForecast"> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> Page 20 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 </operDate> <hourEnding xsi:type="xsd:int">20</hourEnding> <mwForecast xsi:type="xsd:double">20.0</mwForecast> </hourendingforecast> - <hourendingforecast xsi:type="v1:HourEndingForecast"> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">21</hourEnding> <mwForecast xsi:type="xsd:double">20.0</mwForecast> </hourendingforecast> - <hourendingforecast xsi:type="v1:HourEndingForecast"> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">22</hourEnding> <mwForecast xsi:type="xsd:double">20.0</mwForecast> </hourendingforecast> - <hourendingforecast xsi:type="v1:HourEndingForecast"> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> Page 21 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">23</hourEnding> <mwForecast xsi:type="xsd:double">20.0</mwForecast> </hourendingforecast> - <hourendingforecast xsi:type="v1:HourEndingForecast"> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">24</hourEnding> <mwForecast xsi:type="xsd:double">20.0</mwForecast> </hourendingforecast> </hourendingforecast> </houraheadforecast> </ns:submitHourAheadForecast> </soapenv:Body> </soapenv:Envelope> 4.5.6 Example SOAP submitDayAheadForecastRequest Page 22 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/ForecastService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:submitDayAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> - <dayaheadforecast xsi:type="v1:DayAheadForecast" xmlns:v1="https://pirp.caiso.com/schemas/pirp/v1"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">7</month> <dayOfMonth xsi:type="xsd:int">1</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <mwForecastHourEnd1 xsi:type="xsd:double">100.0</mwForecastHourEnd1> <mwForecastHourEnd2 xsi:type="xsd:double">100.0</mwForecastHourEnd2> <mwForecastHourEnd3 xsi:type="xsd:double">100.0</mwForecastHourEnd3> <mwForecastHourEnd4 xsi:type="xsd:double">100.0</mwForecastHourEnd4> <mwForecastHourEnd5 xsi:type="xsd:double">100.0</mwForecastHourEnd5> <mwForecastHourEnd6 xsi:type="xsd:double">100.0</mwForecastHourEnd6> <mwForecastHourEnd7 xsi:type="xsd:double">100.0</mwForecastHourEnd7> <mwForecastHourEnd8 xsi:type="xsd:double">100.0</mwForecastHourEnd8> <mwForecastHourEnd9 xsi:type="xsd:double">100.0</mwForecastHourEnd9> <mwForecastHourEnd10 xsi:type="xsd:double">100.0</mwForecastHourEnd10> <mwForecastHourEnd11 xsi:type="xsd:double">100.0</mwForecastHourEnd11> <mwForecastHourEnd12 xsi:type="xsd:double">100.0</mwForecastHourEnd12> Page 23 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 <mwForecastHourEnd13 xsi:type="xsd:double">100.0</mwForecastHourEnd13> <mwForecastHourEnd14 xsi:type="xsd:double">100.0</mwForecastHourEnd14> <mwForecastHourEnd15 xsi:type="xsd:double">100.0</mwForecastHourEnd15> <mwForecastHourEnd16 xsi:type="xsd:double">100.0</mwForecastHourEnd16> <mwForecastHourEnd17 xsi:type="xsd:double">100.0</mwForecastHourEnd17> <mwForecastHourEnd18 xsi:type="xsd:double">100.0</mwForecastHourEnd18> <mwForecastHourEnd19 xsi:type="xsd:double">100.0</mwForecastHourEnd19> <mwForecastHourEnd20 xsi:type="xsd:double">100.0</mwForecastHourEnd20> <mwForecastHourEnd21 xsi:type="xsd:double">100.0</mwForecastHourEnd21> <mwForecastHourEnd22 xsi:type="xsd:double">100.0</mwForecastHourEnd22> <mwForecastHourEnd23 xsi:type="xsd:double">100.0</mwForecastHourEnd23> <mwForecastHourEnd24 xsi:type="xsd:double">100.0</mwForecastHourEnd24> </dayaheadforecast> </ns:submitDayAheadForecast> </soapenv:Body> </soapenv:Envelope> Page 24 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 5 Market Service Enhanced 5.1 Business Scenario Market operators get the forecasts. 5.2 Service Level Agreement The following service level agreement defines the business and technical requirements for service availability and performance. Service availability 7/24 Expected size of payload (average and maximum) Less than 1MB Expected frequency (average and maximum) Once / hour / participant Longest time the service can be unavailable before business is impacted 30 min Business impact if is unavailable SC cannot submit schedules as PIR forecast; possible settlement disputes; workaround is to go to the PIRP browser to find a forecast Expected response time for the service 5 min 5.3 Use Mode There are six web services involved:  getHourAheadForecastEnhanced  getHourAheadForecastEnhanced  getDayAheadForecast  getDayAheadForecast  getRollingHourAheadForecast Page 25 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506  getRollingHourAheadForecast 5.4 Operation Details The service has six operations with three message types each. All messages are in XML format. Operation Message Types Message WSDL XSD getHourAheadForecastEnhanced Input getHourAheadForecastEnhancedRequest Output getHourAheadForecastEnhancedResponse MarketServiceEnhancedP ort.wsdl MarketServiceEnhancedPort .wsdl Fault webserviceexception Input getHourAheadForecastEnhancedRequest1 Output getHourAheadForecastEnhancedResponse 1 MarketServiceEnhancedP ort.wsdl MarketServiceEnhancedPort .wsdl Fault webserviceexception Input getDayAheadForecastRequest Output getDayAheadForecastResponse MarketServiceEnhancedP ort.wsdl MarketServiceEnhancedPort .wsdl Fault webserviceexception Input getDayAheadForecastRequest1 Output getDayAheadForecastResponse1 MarketServiceEnhancedP ort.wsdl MarketServiceEnhancedPort .wsdl Fault webserviceexception Input getRollingHourAheadForecastRequest Output getRollingHourAheadForecastResponse MarketServiceEnhancedP ort.wsdl MarketServiceEnhancedPort .wsdl Fault webserviceexception Input getRollingHourAheadForecastRequest1 Output getRollingHourAheadForecastResponse1 MarketServiceEnhancedP ort.wsdl MarketServiceEnhancedPort .wsdl Fault webserviceexception getHourAheadForecastEnhanced getDayAheadForecast getDayAheadForecast getRollingHourAheadForecast getRollingHourAheadForecast Page 26 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 5.4.1 Operation Details – WSDL URLs 5.5 WSDL 5.5.1 MarketServiceEnhancedPort.wsdl 5.5.2 Common data types table Elements Data Description Req’d XPath Type Oper Date // MarketServiceEnhanced /OperDate month month Int dayOfMonth dayOfMonth Int year year Int HA Forecast Enhanced // MarketServiceEnhanced / haforecastenhanced resId String operDate OperDate pirpTimestamp DateTime hourEnding Int mwForecast Double errantData String DA Forecast // MarketServiceEnhanced / daforecast resId String operDate OperDate pirpTimestamp DateTime Page 27 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Elements Data Description Req’d XPath Type Optional for Hour 25 Double Repeat for hour n={1..25} mwForecastHourEndn Rolling Hour Ahead Forecast // MarketServiceEnhanced / rollinghouraheadforecast resId String operDate OperDate beginHourEnding Int pirpTimestamp DateTime hourendingforecast ArrayOfHAHourEndingForecast Array HAHourEndingForecast [ ] operDate OperDate hourEnding Int mwForecast Double Webservice Exception // MarketServiceEnhanced /WebserviceException errorCode Int messageText String pirpTimestamp dateTime Forecast Confirmation // MarketServiceEnhanced /ForecastConfirmation forecastId String actionType String pirpTimestamp dateTime Page 28 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 5.5.3 Get Hour Ahead Forecast Enhanced table Element Data Description Req’d Message: Get Hour Ahead Forecast Enhanced Request XPath Type // MarketServiceEnhanced / getHourAheadForecastEnhancedRequest resId String operDate OperDate hourEnding Int Message: Get Hour Ahead Forecast Enhanced Response // MarketServiceEnhanced /getHourAheadForecastEnhancedResponse haforecastenhanced HAForecastEnhanced Message: Webservice Exception // MarketServiceEnhanced / WebserviceException WebserviceException WebserviceException Complex XPath Type Complex 5.5.4 Get Hour Ahead Forecast Enhanced table Element Data Description Message: getHourAheadForecastEnhancedRequest 1 Req’d // MarketServiceEnhanced / getHourAheadForecastEnhancedRequest1 resId string getHourAheadForecastEnhancedRespon se1 // MarketServiceEnhanced / getHourAheadForecastEnhancedResponse1 haforecastenhanced HAForecastEnhanced Message: Webservice Exception // MarketServiceEnhanced / WebserviceException Complex Page 29 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’d WebserviceException XPath Type WebserviceException Complex XPath Type 5.5.5 Get Day Ahead Forecast table Element Data Description Req’d Message: Get Day Ahead Forecast Request // MarketServiceEnhanced / getDayAheadForecastRequest ResId String operDate OperDate Message: Get Day Ahead Forecast Response // MarketServiceEnhanced / getDayAheadForecastResponse daforecast DAForecast Message: Webservice Exception // MarketServiceEnhanced / WebserviceException WebserviceException WebserviceException Complex XPath Type Complex 5.5.6 Get Day Ahead Forecast table Element Data Description Message: Get Day Ahead Forecast Request1 Req’d // MarketServiceEnhanced / getDayAheadForecastRequest1 resID String Message: Get Day Ahead Forecast Response1 // MarketServiceEnhanced / getDayAheadForecastResponse1 Page 30 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’d XPath Type daforecast DAForecast Complex Message: Webservice Exception // MarketServiceEnhanced / WebserviceException WebserviceException WebserviceException Complex XPath Type 5.5.7 Get Rolling Hour Ahead Forecast table Element Data Description Req’d Message: Get Rolling Hour Ahead Forecast Request // MarketServiceEnhanced / getRollingHourAheadForecastRequest resId String operDate OperDate hourEnding Int Message: Get Rolling Hour Ahead Forecast Response // MarketServiceEnhanced / getRollingHourAheadForecastResponse rollinghouraheadforecast RollingHourAheadForecast Message: Webservice Exception // MarketServiceEnhanced / WebserviceException WebserviceException WebserviceException Complex XPath Type Complex 5.5.8 Get Rolling Hour Ahead Forecast table Element Data Description Message: Get Rolling Hour Ahead Forecast Request1 Req’d // MarketServiceEnhanced / getRollingHourAheadForecastRequest1 Page 31 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’d XPath Type String resId Message: Get Rolling Hour Ahead Forecast Response1 // MarketServiceEnhanced / getRollingHourAheadForecastResponse1 rollinghouraheadforecast RollingHourAheadForecast Message: Webservice Exception // MarketServiceEnhanced / WebserviceException WebserviceException WebserviceException Complex Complex 5.5.9 Example SOAP getHourAheadForecastEnhancedRequestV1 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketServiceEnhanced/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getHourAheadForecastEnhanced soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">18</hourEnding> </ns:getHourAheadForecastEnhanced> </soapenv:Body> Page 32 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 </soapenv:Envelope> 5.5.10 Example SOAP getHourAheadForecastEnhancedRequestV2 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketServiceEnhanced/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getHourAheadForecastEnhanced soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> </ns:getHourAheadForecastEnhanced> </soapenv:Body> </soapenv:Envelope> 5.5.11 Example SOAP getDayAheadForecastRequestV1 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketServiceEnhanced/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getDayAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">7</month> <dayOfMonth xsi:type="xsd:int">1</dayOfMonth> <year xsi:type="xsd:int">2009</year> Page 33 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 </operDate> </ns:getDayAheadForecast> </soapenv:Body> </soapenv:Envelope> 5.5.12 Example SOAP getDayAheadForecastRequestV2 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketServiceEnhanced/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getDayAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> </ns:getDayAheadForecast> </soapenv:Body> </soapenv:Envelope> 5.5.13 Example SOAP getRollingHourAheadForecastRequestV1 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketServiceEnhanced/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getRollingHourAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> Page 34 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">18</hourEnding> </ns:getRollingHourAheadForecast> </soapenv:Body> </soapenv:Envelope> 5.5.14 Example SOAP getRollingHourAheadForecastRequestV2 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketServiceEnhanced/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getRollingHourAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> </ns:getRollingHourAheadForecast> </soapenv:Body> </soapenv:Envelope> Page 35 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 6 Market Service 6.1 Business Scenario Market operators get the forecasts. 6.2 Service Level Agreement The following service level agreement defines the business and technical requirements for service availability and performance. Service availability 7/24 Expected size of payload (average and maximum) Less than 1MB Expected frequency (average and maximum) Once / hour / participant Longest time the service can be unavailable before business is impacted 30 min Business impact if is unavailable SC cannot submit schedules as PIR forecast; possible settlement disputes; workaround is to go to the PIRP browser to find a forecast Expected response time for the service 5 min 6.3 Use Mode There are six web services involved:  getHourAheadForecast  getHourAheadForecast  getDayAheadForecast  getDayAheadForecast  getRollingHourAheadForecast Page 36 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506  getRollingHourAheadForecast 6.4 Operation Details The service has six operations with three message types each. All messages are in XML format. Operation Message Types Message WSDL XSD getHourAheadForecast Input getHourAheadForecastRequest MarketServicePort.wsdl MarketServicePort.wsdl Output getHourAheadForecastResponse Fault webserviceexception Input getHourAheadForecastRequest1 MarketServicePort.wsdl MarketServicePort.wsdl Output getHourAheadForecastResponse1 Fault webserviceexception Input getDayAheadForecastRequest MarketServicePort.wsdl MarketServicePort.wsdl Output getDayAheadForecastResponse Fault webserviceexception Input getDayAheadForecastRequest1 MarketServicePort.wsdl MarketServicePort.wsdl Output getDayAheadForecastResponse1 Fault webserviceexception Input getRollingHourAheadForecastRequest MarketServicePort.wsdl MarketServicePort.wsdl Output getRollingHourAheadForecastResponse Fault webserviceexception Input getRollingHourAheadForecastRequest1 MarketServicePort.wsdl MarketServicePort.wsdl Output getRollingHourAheadForecastResponse1 Fault webserviceexception getHourAheadForecast getDayAheadForecast getDayAheadForecast getRollingHourAheadForecast getRollingHourAheadForecast 6.4.1 Operation Details – WSDL URLs Page 37 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 6.5 WSDL 6.5.1 MarketServicePort.wsdl 6.5.2 Common data types table Elements Data Description Req’d XPath Type Oper Date // MarketService/OperDate month month Int dayOfMonth dayOfMonth Int year year Int Webservice Exception // MarketService /WebserviceException errorCode Int messageText String pirpTimestamp dateTime Forecast Confirmation // MarketService /ForecastConfirmation forecastId String actionType String pirpTimestamp dateTime HA Forecast // MarketService /haforecast resId String operDate OperDate pirpTimestamp DateTime Page 38 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Elements Data Description Req’d XPath Type hourEnding Int mwForecast Duble errantData String DA Forecast // MarketService /daforecast resId String operDate OperDate pirpTimestamp DateTime Repeat for hour n={1..25} mwForecastHourEndn Optional for Hour 25 Rolling Hour Ahead Forecast Double // MarketServiceEnhanced / rollinghouraheadforecast resId String operDate OperDate beginHourEnding Int pirpTimestamp DateTime hourendingforecast ArrayOfHAHourEndingForecast Array HAHourEndingForecast [ ] operDate OperDate hourEnding Int mwForecast Double 6.5.3 Get Hour Ahead Forecast table Page 39 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’d Message: Get Hour Ahead Forecast Request XPath Type // MarketService / getHourAheadForecastRequest resId String operDate OperDate hourEnding Int Message: Get Hour Ahead Forecast Response // MarketService / getHourAheadForecastResponse HA Forecast haforecast Message: Webservice Exception // MarketService / WebserviceException WebserviceException WebserviceException Complex XPath Type Complex 6.5.4 Get Hour Ahead Forecast table Element Data Description Message: Get Hour Ahead Forecast Request1 Req’d // MarketService/getHourAheadForecastRequest1 resId String Message: Get Hour Ahead Forecast Response1 // MarketService/getHourAheadForecastResponse1 HA Forecast haforecast Message: Webservice Exception // MarketService/ WebserviceException WebserviceException WebserviceException Complex Complex 6.5.5 Get Day Ahead Forecast table Page 40 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’d Message: Get Day Ahead Forecast Request XPath Type // MarketService/getDayAheadForecastRequest resId String operDate OperDate Message: Get Day Ahead Forecast Response // MarketService/getDayAheadForecastResponse DA Forecast daforecast Message: Webservice Exception // MarketService/ WebserviceException Webservice Exception WebserviceException Complex XPath Type Complex 6.5.6 Get Day Ahead Forecast table Element Data Description Req’d Message: Get Day Ahead Forecast Request1 // MarketService/getDayAheadForecastRequest1 resId String Message: Get Day Ahead Forecast Response1 // MarketService/getDayAheadForecastResponse1 DA Forecast daforecast Message: Webservice Exception // MarketService/ WebserviceException WebserviceException WebserviceException Complex Complex 6.5.7 Get Rolling Hour Ahead Forecast table Page 41 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Req’ d Data Description Message: Get Rolling Hour Ahead Forecast Request XPath Type // MarketService/getRollingHourAheadForecastRequest resId String operDate OperDate hourEnding Int Message: Get Rolling Hour Ahead Forecast Response // MarketService/getRollingHourAheadForecastResponse Rolling Hour Ahead Forecast rollinghouraheadforecast Message: Webservice Exception // MarketService/ WebserviceException WebserviceException WebserviceException Complex XPath Type Complex 6.5.8 Get Rolling Hour Ahead Forecast table Element Data Description Message: Get Rolling Hour Ahead Forecast Request1 Req’d // MarketService/getRollingHourAheadForecastRequest1 resId String Message: Get Rolling Hour Ahead Forecast Response1 // MarketService/getRollingHourAheadForecastResponse1 Rolling Hour Ahead Forecast rollinghouraheadforecast Message: Webservice Exception // MarketService/ WebserviceException WebserviceException WebserviceException Complex Complex 6.5.9 Example SOAP getHourAheadForecastRequestV1 Page 42 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getHourAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">18</hourEnding> </ns:getHourAheadForecast> </soapenv:Body> </soapenv:Envelope> Page 43 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 6.5.10 Example SOAP getHourAheadForecastRequestV2 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getHourAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> </ns:getHourAheadForecast> </soapenv:Body> </soapenv:Envelope> 6.5.11 Example SOAP getDayAheadForecastRequestV1 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getDayAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">7</month> <dayOfMonth xsi:type="xsd:int">1</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> Page 44 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 </ns:getDayAheadForecast> </soapenv:Body> </soapenv:Envelope> 6.5.12 Example SOAP getDayAheadForecastRequestV2 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getDayAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> </ns:getDayAheadForecast> </soapenv:Body> </soapenv:Envelope> Page 45 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 6.5.13 Example SOAP getRollingHourAheadForecastRequestV1 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getRollingHourAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">18</hourEnding> </ns:getRollingHourAheadForecast> </soapenv:Body> </soapenv:Envelope> 6.5.14 Example SOAP getRollingHourAheadForecastRequestV2 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MarketService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getRollingHourAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> Page 46 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> </ns:getRollingHourAheadForecast> </soapenv:Body> </soapenv:Envelope> Page 47 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 7 Meter Data Capture Service 7.1 Business Scenario Capture and store meter data 7.2 Service Level Agreement The following service level agreement defines the business and technical requirements for service availability and performance. Service availability 7/24 Expected size of payload (average and maximum) Less than 1MB Expected frequency (average and maximum) Once / 10 min / participant Longest time the service can be unavailable before business is impacted 30 min Business impact if is unavailable FSP cannot submit forecasts; possible settlement disputes; workaround is to go to the PIRP browser to find a forecast Expected response time for the service 5 min 7.3 Use Model There are two web services involved:  Get Hourly Meter Data  Get Daily Meter Data Page 48 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 7.4 Operation Details The service has two operations with three message types each. All messages are in XML format. Operation Message Types Message WSDL XSD getHourlyMeterData Input getHourlyMeterDataRequest MeterDataPort.wsdl MeterDataPort.wsdl Output getHourlyMeterDataResponse Fault WebserviceException Input getDailyMeterDataRequest MeterDataPort.wsdl MeterDataPort.wsdl Output getDailyMeterDataResponse Fault WebserviceException getDailyMeterData 7.4.1 Operation Details – WSDL URLs 7.5 WSDL 7.5.1 MeterDataPort.wsdl 7.5.2 Common data types table Elements Data Description Req’ d XPath Type Oper Date //MeterData Capture/OperDate month month Int dayOfMonth dayOfMonth Int year year Int Page 49 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Elements Data Description Req’ d Webservice Exception XPath Type // MeterData Capture/WebserviceException errorCode Int messageText String pirpTimestamp dateTime 7.5.3 Get Hourly Meter Data table Element Data Description Message: Get Hourly Meter Data Request Req’ d XPath Type // MeterData Capture/ getHourlyMeterDataRequest ResId String operDate OperDate hourEnding Int Message: Get Hourly Meter Data Response // MeterData Capture/ getHourlyMeterDataResponse metgenavaildata HourlyMeterDataRecord resId String operDate OperDate hourEnding Int mwGenerated Double timestamp dateTime Message: Webservice Exception // MeterData Capture/ WebserviceException Page 50 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d WebserviceException XPath Type WebserviceException Complex XPath Type 7.5.4 Get Daily Meter Data table Element Data Description Req’ d Message: Get Daily Meter Data Request // MeterData Capture/ getDailyMeterDataRequest resId String operDate dateTime Message: Get Daily Meter Data Response // MeterData Capture/ getDailyMeterDataResponse metgenavaildata DailyMeterDataRecord resId String operDate OperDate hourlyDataRecords HourlyMeterData[ ] Array hourEnding Int mwGenerated Double timestamp dateTime Message: Webservice Exception // MeterData Capture/ WebserviceException WebserviceException WebserviceException Complex 7.5.5 Example SOAP getHourlyMeterDataRequest Page 51 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MeterDataCaptureService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getHourlyMeterData soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> <operDate xsi:type="xsd:dateTime">2009-06-29T16:00:00</operDate> <hourEnding xsi:type="xsd:int">18</hourEnding> </ns:getHourlyMeterData> </soapenv:Body> </soapenv:Envelope> 7.5.6 Example SOAP getDailyMeterDataRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/MeterDataCaptureService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getDailyMeterData soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> <operDate xsi:type="xsd:dateTime">2009-06-29T16:00:00</operDate> </ns:getDailyMeterData> </soapenv:Body> </soapenv:Envelope> Page 52 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 8 Operation Service 8.1 Business Scenario Capture and store meteorological data related to wind generators 8.2 Service Level Agreement The following service level agreement defines the business and technical requirements for service availability and performance. Service availability 7/24 7/24 Expected size of payload (average and maximum) Less than 1MB Less than 1MB Expected frequency (average and maximum) Once / 10 min / participant Once / hour / particip Longest time the service can be unavailable before business is impacted 30 min 30 min Business impact if is unavailable FSP cannot submit forecasts; possible settlement disputes; workaround is to go to the PIRP browser to find a forecast SC cannot submit sc the PIRP browser to Expected response time for the service 5 min 5 min 8.3 Use Model There are four web services involved:  getIntervalData  getHourAheadAvailability  getDayAheadAvailability Page 53 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 8.4 Operation Details The service has three operations with three message types each. All messages are in XML format. Operation Message Types Message WSDL XSD getIntervalData Input getIntervalDataRequest Output getIntervalDataResponse OperationsServicePort.ws dl OperationsServicePort.w sdl Fault WebserviceException Input getHourAheadAvailabilityRequest Output getHourAheadAvailabilityResponse OperationsServicePort. wsdl OperationsServicePort.w sdl Fault WebserviceException Input getDayAheadAvailabilityRequest Output getDayAheadAvailabilityResponse OperationsServicePort. wsdl OperationsServicePort.w sdl Fault WebserviceException getHourAheadAvailability getDayAheadAvailability 8.4.1 Operation Details – WSDL URLs 8.5 WSDL 8.5.1 OperationsServicePort.wsdl 8.5.2 Common data types table Element Data Description Req’ d XPath Type Page 54 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d Hour Ending Availability XPath Type // OperationService /HourEndingAvailability operDate dateTime hourEnding Int mwAvailable Double Webservice Exception // OperationsService / WebserviceException errorCode Int messageText String pirpTimestamp Cmplex 8.5.3 Get Interval Data table Element Data Description Message: Get Interval Data Request Req’ d XPath Type // OperationService/getIntervalDataRequest resId String operDate dateTime hourEnding Int intervalId Int Message: Get Interval Data Response // OperationService/getIntervalDataResponse metgenavaildata MetGenAvailData resId String Page 55 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath Type operDate OperDate hourEnding Int intervalId Int mwGenerated Double mwAvailable Double mettowerdata ArrayOfMetTowerData[ ] Array metTowerId String airTemp Double barometricPressure Double windSpeedScalarAvg Double windDirectionUnitVectorAvg Double windSpeedVectorAvg Double windDirectionVectorAvg Double windSpeedStdDev Double windDirectionStdDev Double airQualityCodeDescription String airQualityPassFail String baroPressureCodeDescription String baroPressurePassFail String towerCodeDescription String towerPassFail String windDirCodeDescription String Page 56 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath Type windDirPassFail String windSpeedCodeDescription String windSpeedPassFail String pirpTimestamp dateTime intervalPassFail String intervalQualityCodeDescription String mwPassFail String mwQualityCodeDescription String Message: Webservice Exception // OperationService/WebserviceException WebserviceException WebserviceException 8.5.4 Get Hour Ahead Availability table Element Data Description Message: Get Hour Ahead Availability Request Req’ d XPath Type // OperationService/ getHourAheadAvailabilityRequest resId String operDate DateTime beginHourEnding Int Message: Get Hour Ahead Availability Response // OperationService/ getHourAheadAvailabilityResponse houraheadavailability HourAheadAvailability Page 57 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath Type resId String operDate dateTime beginHourEnding Int pirpTimestamp dateTime hourendingavailability HourEndingAvailability[ ] Array operDate dateTime hourEnding Int mwAvailable Double Message: Webservice Exception // OperationsService / WebserviceException WebserviceException WebserviceException Complex XPath Type 8.5.5 Get Day Ahead Availability table Element Data Description Message: Get Day Ahead Availability Request Req’ d // OperationsService / getDayAheadAvailabilityRequest resId String operDate dateTime Message: Get Day Ahead Availability Response // OperationsService /getDayAheadAvailabilityResponse dayaheadavailability resId String Page 58 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath Type operDate dateTime pirpTimestamp dateTime Repeat for hour n={1..25} mwAvailHourEndn double Message: Webservice Exception // OperationsService / WebserviceException WebserviceException WebserviceException Complex 8.5.6 Schema 8.5.7 Example SOAP getIntervalDataRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/OperationsService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getIntervalData soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">ETIWND_2_SOLAR</resId> <operDate xsi:type="xsd:dateTime">2009-06-29T05:00:00</operDate> <hourEnding xsi:type="xsd:int">14</hourEnding> <intervalId xsi:type="xsd:int">6</intervalId> </ns:getIntervalData> </soapenv:Body> </soapenv:Envelope> Page 59 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 8.5.8 Example SOAP getHourAheadAvailabilityRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/OperationsService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getHourAheadAvailability soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> <operDate xsi:type="xsd:dateTime">2009-06-30T16:00:00</operDate> <beginHourEnding xsi:type="xsd:int">18</beginHourEnding> </ns:getHourAheadAvailability> </soapenv:Body> </soapenv:Envelope> 8.5.9 Example SOAP getDayAheadAvailabilityRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/OperationsService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getDayAheadAvailability soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> <operDate xsi:type="xsd:dateTime">2009-06-30T16:00:00</operDate> </ns:getDayAheadAvailability> Page 60 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 </soapenv:Body> </soapenv:Envelope> Page 61 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 9 Solar Operation Service 9.1 Business Scenario Capture and store data used for Solar generators 9.2 Service Level Agreement The following service level agreement defines the business and technical requirements for service availability and performance. Service availability 7/24 Expected size of payload (average and maximum) Less than 1MB Expected frequency (average and maximum) Once / 10 min / participant Longest time the service can be unavailable before business is impacted 30 min Business impact if is unavailable FSP cannot submit forecasts; possible settlement disputes; workaround is to go to the PIRP browser to find a forecast Expected response time for the service 5 min 9.3 Use Model There are four web services involved:  getSolarIntervalData  getHourAheadAvailability  getDayAheadAvailability Page 62 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 9.4 Operation Details The service has three operations with three message types each. All messages are in XML format. Operation Message Types Message WSDL XSD getSolarIntervalData Input getSolarIntervalDataRequest Output getSolarIntervalDataResponse OperationsServicePort. wsdl OperationsServicePort.w sdl Fault WebserviceException Input getHourAheadAvailabilityRequest Output getHourAheadAvailabilityResponse OperationsServicePort. wsdl OperationsServicePort.w sdl Fault WebserviceException Input getDayAheadAvailabilityRequest Output getDayAheadAvailabilityResponse OperationsServicePort. wsdl OperationsServicePort.w sdl Fault WebserviceException getHourAheadAvailability getDayAheadAvailability 9.4.1 Operation Details – WSDL URLs 9.5 WSDL 9.5.1 SolarOperationsServicePort.wsdl 9.5.2 Common data types table Element Hour Ending Availability Data Description Req’ d XPath Type //Solar OperationService /HourEndingAvailability operDate dateTime Page 63 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath Type hourEnding Int mwAvailable Double Webservice Exception // SolarOperationsService / WebserviceException errorCode Int messageText String pirpTimestamp dateTime 9.5.3 Get Solar Interval Data table Element Data Description Message: GetSolar Interval Data Request Req’ d XPath Type // SolarOperationService/ getSolarIntervalDataRequest resId String operDate DateTime hourEnding Int intervalId Int Message: Get Solar Interval Data Response // SolarOperationService/ getSolarIntervalDataResponse solarmetgenavaildata SolarMetGenAvailData Page 64 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath Type resId String operDate dateTime hourEnding Int intervalId Int mwGenerated Double mwAvailable Double solarmettowerdata ArrayOfSolarMetTowerData [ ] Array metTowerId String towerCodeDescription String towerPassFail String airTemp airQualityCodeDescription airQualityPassFail windDirection Double windDirCodeDescription String windDirPassFail String windSpeed Double windSpeedCodeDescription String windSpeedPassFail String backpanelTemperature Double backpanelTemperatureCodeDesc ription String Page 65 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath Type backpanelTemperaturePassFail String globalHorizontalIrradiance Double globalHorizontalIrradianceCodeD escription String globalHorizontalIrradiancePassF ail String planeOfArrayIrradiance Double planeOfArrayIrradianceCodeDes cription String planeOfArrayIrradiancePassFail String directIrradiance Double directIrradianceCodeDescription String directIrradiancePassFail String customField1 Double customField1CodeDescription String customField1PassFail String customField2 Double customField2CodeDescription String customField2PassFail String customField3 Double customField3CodeDescription String customField3PassFail String customField4 Double Page 66 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath Type customField4CodeDescription String customField4PassFail String customField5 Double customField5CodeDescription String customField5PassFail String pirpTimestamp dateTime intervalPassFail String intervalQualityCodeDescription String mwPassFail String mwQualityCodeDescription String Message: Webservice Exception // SolarOperationService/WebserviceException WebserviceException WebserviceException 9.5.4 Get Hour Ahead Availability table Element Data Description Message: Get Hour Ahead Availability Request Req’ d XPath Type // SolarOperationService/ getHourAheadAvailabilityRequest resId String operDate dateTime beginHourEnding Int Page 67 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d Message: Get Hour Ahead Availability Response XPath Type // SolarOperationService/ getHourAheadAvailabilityResponse houraheadavailability HourAheadAvailability resId String operDate dateTime beginHourEnding Int pirpTimestamp dateTime hourendingavailability HourEndingAvailability[ ] Array operDate dateTime hourEnding Int mwAvailable Double Message: Webservice Exception // SolarOperationsService / WebserviceException WebserviceException WebserviceException Complex XPath Type 9.5.5 Get Day Ahead Availability table Element Data Description Message: Get Day Ahead Availability Request Req’ d // SolarOperationsService / getDayAheadAvailabilityRequest resId String operDate dateTime Message: Get Day Ahead Availability Response // SolarOperationsService /getDayAheadAvailabilityResponse Page 68 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath Type dayaheadavailability resId String operDate dateTime pirpTimestamp dateTime Repeat for hour n={1..25} mwAvailHourEndn double Message: Webservice Exception // SolarOperationsService / WebserviceException WebserviceException WebserviceException Complex 9.5.6 Schema 9.5.7 Example SOAP getSolarIntervalDataRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/SolarOperationsService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getSolarIntervalData soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">ETIWND_2_SOLAR</resId> <operDate xsi:type="xsd:dateTime">2009-06-28T15:00:00</operDate> <hourEnding xsi:type="xsd:int">15</hourEnding> <intervalId xsi:type="xsd:int">6</intervalId> </ns:getSolarIntervalData> Page 69 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 </soapenv:Body> </soapenv:Envelope> 9.5.8 Example SOAP getHourAheadAvailabilityRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/SolarOperationsService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getHourAheadAvailability soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">ETIWND_2_SOLAR</resId> <operDate xsi:type="xsd:dateTime">2009-06-30T16:00:00</operDate> <beginHourEnding xsi:type="xsd:int">18</beginHourEnding> </ns:getHourAheadAvailability> </soapenv:Body> </soapenv:Envelope> 9.5.9 Example SOAP getDayAheadAvailabilityRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/SolarOperationsService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:getDayAheadAvailability soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">ETIWND_2_SOLAR</resId> Page 70 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 <operDate xsi:type="xsd:dateTime">2009-06-30T16:00:00</operDate> </ns:getDayAheadAvailability> </soapenv:Body> </soapenv:Envelope> Page 71 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 10 Resource Service 10.1 Business Scenario Retrieve resources 10.2 Service Level Agreement The following service level agreement defines the business and technical requirements for service availability and performance. Service availability 7/24 Expected size of payload (average and maximum) Less than 1MB Expected frequency (average and maximum) Longest time the service can be unavailable before business is impacted Business impact if is unavailable Resources can not be added to the system Expected response time for the service 5 min 10.3 Use Model There is a web service involved:  getResources 10.4 Operation Details The service has one operation with three message types. All messages are in XML format. Operation Message Types Message WSDL XSD Page 72 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 getResources Input getResourcesRequest Output getResourcesResponse Fault WebserviceException ResourceServicePort.wsdl ResourceServicePort.wsdl 10.4.1 Operation Details – WSDL URLs 10.5 WSDL 10.5.1 OperationsServicePort.wsdl 10.5.2 Get Resources table Element Data Description Message: Get Resources Request Req’ d XPath Type // ResourceService/ getResourcesRequest getResourcesRequest Message: Get Resources Response // ResourceService/ getResourcesResponse getResourcesResponse ArrayOfResource[ ] Array resId String resName String pirpMode String maxGenCap Double zoneId String Page 73 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath startDate Type dateTime Message: Webservice Exception // ResourceService/ WebserviceException errorCode Int messageText String pirpTimestamp dateTime 10.5.3 Schema 10.5.4 Example SOAP resourceServiceRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/ResourceService/1.0"> <soapenv:Header /> - <soapenv:Body> <ns:getResources soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" /> </soapenv:Body> </soapenv:Envelope> Page 74 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 11 Uncorrected Hour Ahead Forecast Service 11.1 Business Scenario 11.2 Service Level Agreement The following service level agreement defines the business and technical requirements for service availability and performance. Service availability 7/24 7/24 Expected size of payload (average and maximum) Less than 1MB Less than 1MB Expected frequency (average and maximum) Once / hour / participant Longest time the service can be unavailable before business is impacted 30 min Business impact if is unavailable SC cannot submit schedules as PIR forecast; possible settlement disputes; workaround is to go to the PIRP browser to find a forecast Expected response time for the service 5 min 5 min 11.3 Use Model There is one web service involved:  submitUncorrectedHourAheadForecast 11.4 Operation Details The service has one operation with three message types. All messages are in XML format. Operation Message Message WSDL XSD Page 75 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Types submitUncorrectedHourAheadForecast Input submitUncorrectedHourAheadForecastRequ est Output submitUncorrectedHourAheadForecastResp onse Fault WebserviceException UncorrectedHourAheadFo recastServicePort.wsdl UncorrectedHourAheadFore castServicePort.wsdl 11.4.1 Operation Details – WSDL URLs 11.5 WSDL 11.5.1 UncorrectedHourAheadForecastServicePort.wsdl 11.5.2 Get Resources table Element Data Description Message: Submit Uncorrected Hour Ahead Forecast Request Req’ d XPath Type // UncorrectedHourAheadForecast/ submitUncorrectedHourAheadForecastRequest resId String operDate month Int dayOfMonth Int year Int hourEnding Int Page 76 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 Element Data Description Req’ d XPath mwForecast Type Double Message: Submit Uncorrected Hour Ahead Forecast Response // UncorrectedHourAheadForecast/ submitUncorrectedHourAheadForecastResponse uncorrectedHourAheadForecastConfirmatio n UncorrectedHourAheadForecastConfirmation forecastId String timeliness String pirpTimestamp dateTime Message: Webservice Exception // UncorrectedHourAheadForecast/ WebserviceException errorCode Int messageText String pirpTimestamp dateTime 11.5.3 Schema 11.5.4 Example SOAP submitUncorrectedHourAheadForecastRequest - <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="https://www.caiso.com/webservices/pirp/UncorrectedHourAheadForecastService/1.0"> <soapenv:Header /> - <soapenv:Body> - <ns:submitUncorrectedHourAheadForecast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <resId xsi:type="xsd:string">BRDSLD_2_HIWIND</resId> Page 77 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009 533574506 - <operDate xsi:type="bas:OperDate" xmlns:bas="https://pirp.caiso.com/schemas/pirp/basev1"> <month xsi:type="xsd:int">6</month> <dayOfMonth xsi:type="xsd:int">30</dayOfMonth> <year xsi:type="xsd:int">2009</year> </operDate> <hourEnding xsi:type="xsd:int">14</hourEnding> <mwForecast xsi:type="xsd:double">25.0</mwForecast> </ns:submitUncorrectedHourAheadForecast> </soapenv:Body> </soapenv:Envelope> Page 78 of 78 Version 1.2 Copyright © 2009 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved. Information in this document is subject to change. 07/08/2009

API Documentation for the PIRP Application - Rev. 1.2

Related documents

Products

Support

API Documentation for the PIRP Application - Rev. 1.2

Related documents

Add this document to collection(s)

Add this document to saved

Suggest us how to improve StudyLib