ISO Interface Specification

Transcription

1 ISO Interface Specification Outage Management System Date Created: 12/27/2013 Doc ID: GNFDMDEHU6BB Page 1 of 112

2 Template 1.4 Location of <Add um path or URL here> Revision History Date Version Description Author 12/27/ creation Sean Crimmins 01/08/ Initial document with Generation Sean Crimmins submit/retrieve 1/27/ Updated with Transmission Sean Crimmins submit/retrieve 2/7/ Added common services and facility Sean Crimmins outage definition 2/7/ Added outage status update Sean Crimmins 4/7/ Updated WSDLs and sample XSDs to Sunil Nallagangu reflect latest XSD modifications 4/15/ Updated spec to accommodate Sunil Nallagangu changes in ResourceOutageResults_v1.xsd 5/29/ Updated spec to accommodate latest Sunil Nallagangu changes in XSDs 7/21/ Added SOAP Header and MTOM Sunil Nallagangu attachment Info 08/01/ Updated spec to reflect latest XSDs Sunil Nallagangu 08/28/ Updated spec to reflect latest XSDs Sunil Nallagangu TransmissionOutage: Relaxed length restriction Equipment MRID from 32 to 40 chars Relaxed length restriction Equipment Name from 32 to 80 chars Added Enumeration for Equipment NameType ResourceOutage: Relaxed Resource(Generator/Intertie/Load) name from 32 to 40 chars. 10/10/ Updated retrieve resource outage, retrieve transmission outage, retrieve availability and retrieve facility outage definition sections to include tables that describe how the different request Yinka Ajede Doc ID: GNFDMDEHU6BB Page 2 of 112

3 Template 1.4 Date Version Description Author criteria can be used. 11/10/ TransmissionOutageResults (B2B) - Adding enumerations (CONFORMLOAD, NONCONFORMLOAD and STATICVARCOMPENSATOR) to equipment type. FacilityOutageDefinitionResults (B2B) - Adding only STATICVARCOMPENSATOR enumeration to equipment type (already has ConformLoad and nconformload in the enumerations) Sunil Nallagangu 11/11/ Added list of primary and secondary cause codes that are required for forced transmission outages 11/11/ RequestFacilityOutageDefinition updated to enable search by Participant market organisation 11/17/2014 Added enumerations to be used for primary and secondary codes that are required for forced transmission outages Yinka Ajede Sunil Nallagangu Yinka Ajede Versioning should be as follows: 1. Draft When a document is still in its developing stages and is not ready for review and sign off. 2. V 0.n When changes are made before the document is ready for initial review. 3. V 1.0 When a document is ready for review and sign off. It remains as v 1.0 after sign off if no changes are made. 4. V 1.n When changes are made after the initial review. n represents the number of iterations of changes until the official signoff. 5. V 2.0 When additional changes are requested after initial sign off and Change Request is approved. The Change Request that initiated the revision must be referenced in the Revision History Description. 6. V2.n When changes are made after the second sign off where the changes do not affect downstream/related documents or system code (i.e.: grammar changes, etc.) Doc ID: GNFDMDEHU6BB Page 3 of 112

4 Template 1.4 Table of Contents 1. INTRODUCTION PURPOSE CONTACT INFORMATION RELATED DOCUMENTS RELEASE NOTES API TRANSITION SUPPORT MTOM ATTACHMENTS...10 DATE TIME DATA TYPE ELEMENTS SOAP HEADER ELEMENTS & MTOM ATTACHMENTS IDENTITY OF MESSAGE PRODUCER Identity Timestamp Message Freshness MTOM ATTACHMENTS STANDARD XSDS STANDARD ATTACHMENT INFORMATION Element table Schema (StandardAttachmentInfor.xsd) Example XML File (StandardAttachmentInfor.xml) FAULT RETURN Element Table Schema (StandardOutput.xsd) Example XML File (StandardOutput.xml) SUBMIT RESOURCE OUTAGE {CHANGE REQUESTS} BUSINESS SCENARIO OVERVIEW SERVICE LEVEL AGREEMENT USE MODEL Submit New Outage Submit Change to Existing Outage OPERATIONAL DETAILS Submit Resource Outage Submit Resource Outage Change Request WSDL submitresourceoutage_v1.wsdl / submitresourceoutage_v1_docattach.wsdl submitresourceoutagechangerequest_v1.wsdl / submitresourceoutagechangerequest_v1_docattach.wsdl SUBMIT RESOURCE OUTAGE {CHANGE REQUEST} Element Table Schema (ResourceOutageData_v1.xsd) Example XML File (SubmitResourceOutageData_v1.xml) Example XML File (SubmitResourceOutageChangeRequest_v1.xml) SUBMIT RESOURCE OUTAGE {CHANGE REQUEST} RESPONSE Element Table Schema (OutageStandardOutput_v1.xsd)...33 Doc ID: GNFDMDEHU6BB Page 4 of 112

5 Template Example XML File (ResourceOutageStandardOutput.xml) RETRIEVE OUTAGE/CHANGE REQUESTS BUSINESS SCENARIO OVERVIEW SERVICE LEVEL AGREEMENT USE MODEL Retrieve Generation Outages Retrieve Resource Outage Change Requests OPERATIONAL DETAILS Retrieve Resource Outage Retrieve Resource Outage Change Request WSDL retrieveresourceoutage_v1.wsdl / retrieveresourceoutage_v1_docattach.wsdl retrieveresourceoutagechangerequest_v1.wsdl / retrieveresourceoutagechangerequest_v1_docattach.wsdl RETRIEVE RESOURCE OUTAGE {CHANGE REQUEST} Element Table Schema (RequestResourceOutage_v1.xsd) Example XML File (RequestResourceOutage_v1.xml) Example XML file (RequestResourceOutageChangeRequest.xml) RETRIEVE RESOURCE OUTAGE {CHANGE REQUEST} RESPONSE Element Table Schema (ResourceOutageResults_v1.xsd) Example XML File (ResourceOutageResults_v1.xml) Example XML file (ResourceOutageChangeRequestResults_v1.xml) FAULT RETURN SUBMIT TRANSMISSION OUTAGE {CHANGE REQUESTS} BUSINESS SCENARIO OVERVIEW SERVICE LEVEL AGREEMENT USE MODEL Submit New Transmission Outage Submit Change to Existing Transmission Outage OPERATIONAL DETAILS Submit Transmission Outage Submit Transmission Outage Change Request WSDL SubmitTransmissionOutage_v1.wsdl / SubmitTransmissionOutage_v1_DocAttach.wsdl SubmitTransmissionOutageChangeRequest_v1.wsdl/ SubmitTransmissionOutageChangeRequest_v1_DocAttach.wsdl SUBMIT TRANSMISSION OUTAGE {CHANGE REQUEST} Element Table Schema (TransmissionOutageData_v1.xsd) Example XML File (SubmitTransmissionOutageData_v1.xml) Example XML File (SubmitTransmissionOutageChangeRequest_v1.xml) SUBMIT TRANSMISSIONOUTAGE {CHANGE REQUEST} RESPONSE Element Table Schema (OutageStandardOutput_v1.xsd) Example XML File (TransmissionOutageStandardOutput_v1.xml) RETRIEVE TRANSMISSION OUTAGE/CHANGE REQUESTS...72 Doc ID: GNFDMDEHU6BB Page 5 of 112

6 Template OVERVIEW SERVICE LEVEL AGREEMENT USE MODEL Retrieve Transmission Outages Retrieve Transmission Outage Change Requests OPERATIONAL DETAILS Retrieve Transmission Outage Retrieve Transmission Outage Change Request WSDL retrievetransmissionoutage_v1.wsdl / retrievetransmissionoutage_v1_docattach.wsdl retrievetransmissionoutagechangerequest_v1.wsdl / retrievetransmissionoutagechangerequest_v1_docattach.wsdl RETRIEVE TRANSMISSION OUTAGE {CHANGE REQUEST} Element Table Schema (RequestTransmissionOutage_v1.xsd) Example XML File (RequestTransmissionOutage_v1.xml) Example XML file (RequestTransmissionOutageChangeRequest_v1.xml) RETRIEVE TRANSMISSION OUTAGE {CHANGE REQUEST} RESPONSE Element Table Schema (TransmissionOutageResults_v1.xsd) Example XML File (TransmissionOutageResults_v1.xml) Example XML file (TransmissionOutageResultsChangeRequests_v1.xml) FAULT RETURN RETRIEVE AVAILABILITY OVERVIEW SERVICE LEVEL AGREEMENT USE MODEL Retrieve Availability OPERATIONAL DETAILS Retrieve Availability WSDL retrieveavailability_v1.wsdl / retrieveavailability_v1_docattach.wsdl RETRIEVE AVAILABILITY Element Table Schema (RequestAvailability_v1.xsd) Example XML File (RequestAvailability_v1.xml) REQUEST AVAILABILITY RESPONSE Element Table Schema (AvailabilityResults_v1.xsd) Example XML File (AvailabilityResults_v1.xml) FAULT RETURN RETRIEVE FACILITY OUTAGE DEFINITION OVERVIEW SERVICE LEVEL AGREEMENT USE MODEL Retrieve Facility Outage Definition OPERATIONAL DETAILS Retrieve Facility Outage Definition WSDL...96 Doc ID: GNFDMDEHU6BB Page 6 of 112

7 Template retrievefacilityoutagedefinition_v1.wsdl / retrievefacilityoutagedefinition_v1_docattach.wsdl RETRIEVE FACILITY OUTAGE DEFINITION Element Table Schema (requestfacilityoutagedefinition_v1.xsd) Example XML File (requestfacilityoutagedefinition_v1.xml) REQUEST FACILITY OUTAGE RESPONSE Element Table Schema (FacilityOutageDefinitionResults_v1.xsd) Example XML File (FacilityOutageDefinitionResults_v1.xml) FAULT RETURN WITHDRAW OUTAGE CHANGE REQUEST OVERVIEW SERVICE LEVEL AGREEMENT USE MODEL Retrieve Facility Outage Definition OPERATIONAL DETAILS Retrieve Facility Outage Definition WSDL withdrawoutagechangerequest_v1.wsdl / withdrawoutagechangerequest_v1_docattach.wsdl WITHDRAW OUTAGE CHANGEREQUEST Element Table Schema (WithdrawOutageChangeRequest_v1.xsd) Example XML File (WithdrawOutageChangeRequest_v1.xml) WITHDRAW OUTAGE CHANGE REQUEST STANDARD OUTPUT Element Table Schema (StandardOutput_v1.xsd) Example XML File (WithdrawOutageChangeRequestStandardOutput_v1.xml) FAULT RETURN ACKNOWLEDGE OUTAGE WARNING OVERVIEW SERVICE LEVEL AGREEMENT USE MODEL Acknowledge Outage Warning OPERATIONAL DETAILS Retrieve Facility Outage Definition WSDL AcknowledgeOutageWarning_v1.wsdl / AcknowledgeOutageWarning_v1_DocAttach.wsdl ACKNOWLEDGE OUTAGE WARNING Element Table Schema (AcknowledgeOutageWarning_v1.xsd) Example XML File (AcknowledgeOutageWarning_v1.xml) ACKNOWLEDGE OUTAGE WARNING STANDARD OUTPUT Element Table Schema (StandardOutput_v1.xsd) Example XML File (AcknowledgeOutageWarningStandardOutput_v1.xml) OUTAGE STATUS UPDATE OVERVIEW SERVICE LEVEL AGREEMENT Doc ID: GNFDMDEHU6BB Page 7 of 112

8 Template USE MODEL Acknowledge Outage Warning OPERATIONAL DETAILS Outage Status Update WSDL OutageStatusUpdate_v1.wsdl / OutageStatusUpdate_v1_DocAttach.wsdl OUTAGE STATUS UPDATE Element Table Schema (OutageStatusUpdate_v1.xsd) Example XML File (OutageStatusUpdate_v1.xml) OUTAGE STATUS UPDATE Element Table Schema (StandardOutput_v1.xsd) Example XML File FAULT RETURN Doc ID: GNFDMDEHU6BB Page 8 of 112

9 Template Introduction 1.1 Purpose This document describes the Market Participant interface to CAISO s Outage Management System (OMS) web 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 Outage Management System web services, please send to siug@caiso.com 1.3 Related s CAISO s ISO MARKET program has produced a set of documents describing its web services architecture and associated interfaces to the Bidding, Market Results, Trades, Outage Management and Sandbox services. CASIO s ISO MARKET Web Services Architecture & Integration Specification is the top-level document in this set; Market Participants and their application programmers should read this document to gain an overall understanding of CASIO s web services architecture prior to reading any of the detailed documents shown below. B2B Security Specification (CAISO ISS) CAISO s Web Services Architecture & Integration Specification Client Public/Private Key Instructions (CAISO ISS) Interface Specification for Bidding Services Interface Specification for Inter-SC Trade Services Interface Specification for Market Result Services Interface Specification for Outage Management Services Sandbox Services & Test Client Guide Figure 1 ISO MARKET Web Services Interface Specification Set The ISO MARKET Web Services Interface Specification Set is available online at the locations indicated below. Doc.. Name Location Doc ID: GNFDMDEHU6BB Page 9 of 112

10 Template 1.4 Doc.. Name Location ISO MARKET B2B Security Specification Client Public/Private Key Instructions ISO MARKET Interface Specification for Bidding Services (you must have access to the Market Participant Portal) ClientPublic_PrivateKeyGuidelines.pdf icationaccess/default.aspx ISO MARKET Interface Specification for Inter-SC Trade Services ISO MARKET Interface Specification for Market Results Services ISO Interface Specification for Outage Management Services icationaccess/default.aspx icationaccess/default.aspx seplanning/default.aspx 7 ISO Acceptable Use Guidelines cesacceptableuseguidelinesapr9_2013.pdf 1.4 Release tes This document release 1.0 will be the first release for the new ISO Outage Management System (OMS), to be released in the Fall of 2014 with the Energy Imbalance Market (EIM). All SLIC web services will be replaced by the services in this document. 1.5 API Transition Support Due to the extensive changes in required fields and implementing technology the ISO will not support the existing services after go-live. All clients will need to transition to the new services. 1.6 MTOM & Doc style Attachments All services support both MTOM/XOP style attachments and document literal with an attachment (doc-attach). Doc style attachments are supported by WSDLs that have suffix _DocAttach in their name, this Doc style attachment is mainly intended for.net clients. Example: 1. submitresourceoutage_v1.wsdl supports MTOM style attachments 2. submitresourceoutage_v1_docattach.wsdl supports Doc style attachments. Attachments will still be zipped and Base64 encoded. The previous style of rpc literal will not be supported. Doc ID: GNFDMDEHU6BB Page 10 of 112

11 Template 1.4 Date Time Data Type Elements The datetime data type is used to specify a date and a time. The datetime is specified in the following form: "YYYY-MM-DDThh:mm:ss" where: YYYY indicates the year MM indicates the month DD indicates the day T indicates the start of the required time section hh indicates the hour mm indicates the minute ss indicates the second te: All components are required. To specify a time zone, you must enter a datetime in Universal Time Coordinate (UTC) time by adding a "Z" behind the time, for example: <startdate> t07:00:00z</startdate> 2. SOAP Header Elements & MTOM Attachments This section specifies how the identity of the message producer and the message signature is specified in the SOAP message header section. 2.1 Identity of Message Producer Identify of the message producer is specified in CAISO custom element <CAISOUsernameToken > encapsulated in <CAISOWSHeader>. The following fragment illustrates the use of this element <ns1:caisowsheader xmlns:ns1=" <ns1:caisousernametoken> <ns1:username>lnp Tester40</ns1:Username> <nce>3433lfff23</nce> <Created> T16:30:45.0 PDT</Created> </ns1:caisousernametoken> </ns1:caisowsheader> Identity Doc ID: GNFDMDEHU6BB Page 11 of 112

12 Template 1.4 Identity of the message producer is specified by the <Username> element, which allows any string that does not contain line feeds, carriage returns, tabs, leading or trailing spaces, or multiple spaces Timestamp The Security Timestamp is encapsulated via the <created> element in the <CAISOUsernameToken> and indicates when the token was created Message Freshness This specification uses a nce as a measure to thwart replay attacks. The nce is a unique, randomly generated number. The nonce is encapsulated via the <wsse:nonce> element in the <cwsh:caisousernametoken> 2.2 MTOM Attachments All large messages are sent in MTOM style attachments or as document literal with an attachment (doc-attach). The previous style of rpc literal will not be supported. Attachments will still be zipped and Base64 encoded=. The attachment hash value is is encapsulated in <attchmenthash> element that goes in to SOAP header section as illustrated below: <ns1:attachmenthash xmlns:ns1=" <hashvalue>erptrfx6a288dmby+jg61jpbfay=</hashvalue> </ns1:attachmenthash> The content-id(cid) of the MTOM attachment is referred in attachmentdata1 element encapsulated by AttachmentInfor. This section goes in SOAP Body as shown below: <att:attachmentinfor> <att:attachmentdata1>cid: </att:attachmentdata1> </att:attachmentinfor> Here is a complete example of SOAP message. Doc ID: GNFDMDEHU6BB Page 12 of 112

13 Template 1.4 <soapenv:envelope xmlns:soapenv=" xmlns:stan=" xmlns:att=" <soapenv:header> <ns1:caisowsheader xmlns:ns1=" 30/CAISOWSHeader.xsd"> <ns1:caisousernametoken> <ns1:username>lnp Tester40</ns1:Username> <nce>3433lfff23</nce> <Created> T16:30:45.0 PDT</Created> </ns1:caisousernametoken> </ns1:caisowsheader> <ns1:attachmenthash xmlns:ns1=" <hashvalue>erptrfx6a288dmby+jg61jpbfay=</hashvalue> </ns1:attachmenthash> <!-- this is optional --> <stan:standardattachmentinfor> <stan:attachment> <stan:id>?</stan:id> <stan:name>?</stan:name> <stan:description>?</stan:description> <stan:version>?</stan:version> <stan:sequencenumber>?</stan:sequencenumber> <stan:type>?</stan:type> <stan:size>?</stan:size> <stan:source>?</stan:source> <stan:tool>?</stan:tool> <stan:creationtime>?</stan:creationtime> <stan:compressflag>?</stan:compressflag> <stan:compressmethod>?</stan:compressmethod> <stan:attributelist> <stan:value>?</stan:value> </stan:attributelist> </stan:attachment> </stan:standardattachmentinfor> </soapenv:header> <soapenv:body> <att:attachmentinfor> <att:attachmentdata1><inc:include href="cid: " xmlns:inc=" </att:attachmentdata1> </att:attachmentinfor> </soapenv:body> </soapenv:envelope> Doc ID: GNFDMDEHU6BB Page 13 of 112

14 Template 1.4 In above example content-id cid: refers to actual attachment data in binary format that follows above SOAP message. Content-Type: application/octet-stream Content-Transfer-Encoding: binary Content-ID: < > Content-Disposition: attachment; name="2e132f b-55b9f7a08fbf.uue" H4sIAAAAAAAAAL1W30/jOBB+7v4VVe+5dcICCyhkhQq3VwnaqgmLeFqZZNr6SOyc7bTw3+84P9o 3. Standard XSDs 3.1 Standard Attachment Information The attachment information schema, StandardAttachmentInfor.xsd, is used to provide general information for a SOAP attachment. The root element in the schema is standardattachmentinfor, which can contain one or more attachment elements Element table Doc ID: GNFDMDEHU6BB Page 14 of 112

15 Template 1.4 Element Data Description Type Req d id Globally unique identifier. string name Attachment filename. string description Description of attachment. string version Version ID of attachment file string sequencenumber Sequence number if there are multiple attachments. string type Attachments file type, zip string size Size of attachment file. string source Source of attachment file. string tool Tool used to generate attachment. string creationtime Time attachment file was created. datetime compressflag Indicates whether or not attachment has been compressed (YES or NO). string compressmethod Compress method used (if attachment file compressed). string AttributeList.Sequence Attribute list sequence number. string AttributeList.Name Name of an attribute string AttributeList.Value Value of an attribute string Schema (StandardAttachmentInfor.xsd) Each service bundle will contain the same StandardAttachmentInfor.xsd Example XML File (StandardAttachmentInfor.xml) <?xml version="1.0" encoding="utf-8"?> <!-- Sample XML file generated by XMLSpy v2006 U ( --> <standardattachmentinfor xmlns=" 13/StandardAttachmentInfor.xsd" xmlns:xsi=" xsi:schemalocation=" 13/StandardAttachmentInfor.xsd"> <Attachment> <id> </id> <name>out1</name> <description>outage_attachement</description> <version>1.1</version> <sequencenumber>12</sequencenumber> Doc ID: GNFDMDEHU6BB Page 15 of 112

16 Template 1.4 <type>zip</type> <size>180</size> <source>gwed</source> <tool>gzip</tool> <creationtime> t09:30:47.0z</creationtime> <compressflag>yes</compressflag> <compressmethod>zip</compressmethod> <AttributeList> <Sequence>2</Sequence> <Name>GWED</Name> <Value>1</Value> </AttributeList> </Attachment> </standardattachmentinfor> 3.2 Fault Return Any error in consuming the service will result in the fault return of the standardoutput. This section is applicable to all services Element Table Element Data Description Type/ OutputDataType.EventLog Format/ Req d id Event log identifier. string name Event log name. string description Event log description. string type Event log type. string creationtime Event log creation time. date collectiontype Event log collection type. string collectionquantity Event log collection quantity. string Event.result Event result. string Event.id Event identifier. string Event.name Event name. string Event.description Event description. string Event.creationTime Event creation time. datetime Event.severity Event severity. string Event.priority Event priority. string Doc ID: GNFDMDEHU6BB Page 16 of 112

17 Template 1.4 Element Data Description Type/ Event.sequence Number Event sequence number. string Format/ Req d Event.eventType Event type. string Service.id Service identifier. string Service.name Service name. string Service.description Service description. string Service.comments Service comments. string Schema (StandardOutput.xsd) Each service bundle will have the same StandardOutput.xsd file Example XML File (StandardOutput.xml) <?xml version="1.0" encoding="utf-8"?> <!--Sample XML file generated by XMLSpy v2013 rel. 2 sp2 ( <m:outputdatatype xsi:schemalocation=" StandardOutput.xsd" xmlns:m=" xmlns:xsi=" <m:eventlog> <m:id>event-123</m:id> <m:name>event Name</m:name> <m:description>the Event Description</m:description> <m:type>error Event</m:type> <m:creationtime> t11:00:00z</m:creationtime> <m:collectiontype>submit Generator Outage</m:collectionType> <m:collectionquantity>1</m:collectionquantity> <m:event> <m:result>invalid Value Found in Field XX</m:result> <m:id>1234</m:id> <m:name>error Event 1234</m:name> <m:description>an invalid data value was presented</m:description> <m:creationtime> t11:00:00z</m:creationtime> <m:severity>high</m:severity> <m:priority>high</m:priority> <m:sequencenumber>1</m:sequencenumber> <m:eventtype>initiated by OMS API</m:eventType> </m:event> <m:service> <m:id> </m:id> <m:name>submit Intertie Update</m:name> <m:description>having problems - Invalid data has been presented</m:description> <m:comments>some one needs to fix the data and resubmit</m:comments> </m:service> </m:eventlog> </m:outputdatatype> Doc ID: GNFDMDEHU6BB Page 17 of 112

18 Template Submit Resource Outage {Change Requests} Business Scenario 4.1 Overview Outage coordinators can submit outages or changes to previously submitted outages (Outage Change Requests) for affiliated generators. 4.2 Service Level Agreement Service availability Service level goal is 99.9%. Expected size of payload (average and maximum) Expected frequency (average and maximum) Longest time the service can be unavailable before business is impacted Business impact if is unavailable Variable (1KB to 1MB+) On demand (50/day 200/day). 30 minutes Outage Coordinators can call the ISO directly with critical near-term outages. Expected response time for the service Variable (.1 sec 30 sec) Expected time to exchange Variable (.1 sec 30 sec) 4.3 Use Model The sequence diagram below describes the service level interactions between the Outage Coordinator systems and the OMS. Channel level security and authentication are abstracted from this diagram (They will be covered in another document; B2B Security Specifications) Submit New Outage sd Submit Outage OMS Outage Coordinator SubmitGenerationOutage() SubmitGenerationOutageResponse() Doc ID: GNFDMDEHU6BB Page 18 of 112

19 Template Submit Change to Existing Outage sd Submit Outage Change Request OMS Outage Coordinator submitoutagechangerequest() submitgenerationoutagechangerequestresponse() 4.4 Operational Details Submit Resource Outage The service has one operation with three message types. Operation submitresourceou tage Message Types Message WSDL XSD Input submitresourceou submitresourceoutage_v1.ws submitresourceoutage_v1.xsd Output tage submitresourceou dl/ submitresourceoutage_v1_d OutageStandardOutput_v1.xsd tageresponse ocattach.wsdl/ Fault faultreturntype StandardOutput.xsd Submit Resource Outage Change Request Operation submitresourceo utagechangerequ est Message Types Input Output Message WSDL XSD submitresourceo utagechangerequ est submitresourceo utagechangerequ estresponse submitresourceoutagechang erequest_v1.wsdl/ submitresourceoutagechang erequest_v1_docattach.wsd l submitresourceoutagechange Request_v1.xsd OutageStandardOutput_v1.xsd Fault faultreturntype StandardOutput.xsd 4.5 WSDL submitresourceoutage_v1.wsdl / submitresourceoutage_v1_docattach.wsdl submitresourceoutagechangerequest_v1.wsdl / submitresourceoutagechangerequest_v1_docattach.wsdl Doc ID: GNFDMDEHU6BB Page 19 of 112

20 Template 1.4 Location: Submit Resource Outage {Change Request} Element Table Element Data Description Type/ Message Header Format/ Req d TimeDate The datetime, in UTC, when the payload is published datetime Source The source of the data Version Subversion of the XSD: Initial version will be v MessagePayload.RegsiteredResourceOutage mrid ID for the Outage, t required for new outage, required when submitting a change request. Description Participant s description of the Outage/Change Request Comment Participant s comment for the Outage/Change Request affectsrassps Participant indicates if this outage affects a RAS or SPS. / discoverydatetime DateTime when the outage was discovered. datetime emergencyreturntime Time to restore the outage if needed by the ISO. Integer emergencyreturntimet ype Type of emergency return time. DAYS, HOURS, MINUTES mktorgoutageid Reference ID assigned to the outage by the participant. outagecoordinationlong TermPlanning This indicates the outage is part of your quarterly outage plan and allows the outage request to remain scheduled until it is evaluated approximately one month before its start date. See CAISO Operating Procedure T-113 for more information on quarterly outage plans. / RIMSProjectCommision Date Commission date of the the related RIMS project datetime RIMSProjectCompletion Completion date of the related RIMS project datetime Doc ID: GNFDMDEHU6BB Page 20 of 112

21 Template 1.4 Element Data Description Type/ Format/ Req d RIMSProjectID RIMS id of the related RIMS project RIMSProjectPhase RIMS phase that this outage will complete Actual Period Actual start and end times of the outage, in UTC datetime Estimated Period Planned start and end time of the outage, in UTC. datetime OutageCause.code Participant list of cause code for their reference isoffpeakopportunityou tage isshortticeopportunit youtage Participant indicates if the submission if for an off peak opportunity outage. / Participant indicates if the submission if for a short notice opportunity outage. / Work Kind of work codes. MessagePayload.RegsiteredResourceOutage.MktOrganisation mrid Participant short name MessagePayload.RegsiteredResourceOutage.MktOrganisation.MarketPerson firstname First name of the contact at the participant. lastname Last name of the contact at the participant. landlinephone Phone number of the contact at the participant. Complex MessagePayload.RegsiteredResourceOutage.OutageChangeRequest action Type of change request. If present indicates that his is a change request to an existing outage. UPDATE or CANCEL actionreason Reason for change actionsubtype Type of action subtype MessagePayload.RegsiteredResourceOutage.RegisteredGenerator(Choice1) mrid The resource id for the RegisteredGenerator. mrid minlen=1 maxlen=32 name An alternate name from the Participant name minlen=1 maxlen=40 RegisteredGenerator.LogicalConfiguration RegisteredGenerator.LogicalConfiguration.Configuration mrid The resource id for an MSG RegisteredGenerator s Configuration. mrid minlen=1 maxlen=32 Doc ID: GNFDMDEHU6BB Page 21 of 112

22 Template 1.4 Element Data Description Type/ Format/ name An alternate name from the Participant. name minlen=1 maxlen=40 Req d RegisteredGenerator.LogicalConfiguration.Configuration.OutagedRegisteredResource RegisteredGenerator.LogicalConfiguration.Configuration.OutagedRegisteredResource.Availability datetimepoint The time of this availability point in UTC. datetime outofservice Unit has avail 0 starting at this time / returntonetdependable Capacity Indicates no derate at this time Float Pmaxvalue Indicates Pmax value of Unit Float RegisteredGenerator.LogicalConfiguration.Configuration.OutagedRegisteredResource.PMinimum activeperiod.start Start date and time during which this restriction is applied datetime restrictedvalue The new pmin value for this interval. Float RegisteredGenerator.LogicalConfiguration.Configuration.OutagedRegisteredResource.RampRateSegment restrictedvalue The new Ramp Rate for this segment Float segmentnumber The number of this segment Integer segmentvalue The MW value that identifies the right hand side of the segment. Float RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource timetostartup The time the resource needs to start after the outage has completed. Float RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource.ASAvailability availablevalue The new MW value for this interval. Float MarketProduct.marketPr oducttype Type of AS that is restricted. Enumera tion RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource.Availability datetimepoint The time of this availability point in UTC. datetime outofservice Unit has avail 0 starting at this time. / returntonetdependablec apacity Indicates no derate starting at this time. / PmaxValue.vlaue Indicates Pmax value Float Doc ID: GNFDMDEHU6BB Page 22 of 112

23 Template 1.4 Element Data Description Type/ Format/ Req d RegisteredResourceOutage.RegisteredGenerator.OutagedRegisteredResource.Availability.OutagedRegister edresource.registeredresource.registeredresourceoutage RegisteredResource.RegisteredResourceOutage mrid ID for the Outage, t required for new outage, required when submitting a change request. RegisteredGenerator.OutagedRegisteredResource.LoadMaximum(Choice1) activeperiod.start Start date and time of this interval datetime restrictedvalue The new MW value for this point. Float outofservice Unit has avail 0 starting at this time. / returntonetdependablec apacity Indicates no derate starting at this time. / RegisteredGenerator.OutagedRegisteredResource.LoadMinimum(Choice2) activeperiod.start Start date and time of this interval datetime restrictedvalue The new MW value for this interval. Float RegisteredGenerator.OutagedRegisteredResource.MaximumEnergyLimit (Choice3) activeperiod.start Start date and time of this interval datetime restrictedvalue The new maximum energy limit (WH) for this interval. Float RegisteredGenerator.OutagedRegisteredResource.MinimumEnergyLimit (Choice4) activeperiod.start Start date and time of this interval datetime restrictedvalue The new minimum energy limit (WH) for this interval. RegisteredGenerator.OutagedRegisteredResource.PMinimum(Choice5) activeperiod.start The time of this pmin rerate point in UTC datetime restrictedvalue The new minimum output of this resource/configuration for this interval RegisteredGenerator.OutagedRegisteredResource.UseLimit(Choice6) activeperiod.start Start date and time of this interval datetime restrictedvalue The new use Limit for the resource in this interval. Float Float Float RegisteredGenerator.OutagedRegisteredResource.RampRateSegment (Choice7) Doc ID: GNFDMDEHU6BB Page 23 of 112

24 Template 1.4 Element Data Description Type/ restrictedvalue The new ramp rate (MW/min) for this segment in this interval. Float Format/ segmentnumber The identifier for this segment Integer segmentvalue The right hand side (MW) of this segment. Float MessagePayload.RegisteredResourceOutage.RegisteredIntertie(Choice2) Req d mrid The resource id for the RegisteredIntertie. mrid minlen=1 maxlen=32 name An alternate name from the Participant name minlen=1 maxlen=40 RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource timetostartup The time the resource needs to start after the outage has completed. Float RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource.ASAvailability availablevalue The new MW value for this interval. Float MarketProduct.marketPr oducttype Type of AS that is restricted. Enumera tion RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource.Availability datetimepoint The time of this availability point in UTC. datetime outofservice Unit has avail 0 starting at this time. / returntonetdependablec apacity Indicates no derate starting at this time. / PmaxValue.vlaue Indicates Pmax value Float RegisteredResourceOutage.RegisteredIntertie.OutagedRegisteredResource.Availability.OutagedRegistered Resource.RegisteredResource.RegisteredResourceOutage RegisteredResource.RegisteredResourceOutage mrid ID for the Outage, t required for new outage, required when submitting a change request. RegisteredIntertie.OutagedRegisteredResource.LoadMaximum(Choice1) activeperiod.start Start date and time of this interval datetime restrictedvalue The new MW value for this point. Float outofservice Unit has avail 0 starting at this time. / Doc ID: GNFDMDEHU6BB Page 24 of 112

25 Template 1.4 Element Data Description Type/ returntonetdependablec apacity Format/ Indicates no derate starting at this time. / RegisteredIntertie.OutagedRegisteredResource.LoadMinimum(Choice2) activeperiod.start Start date and time of this interval datetime restrictedvalue The new MW value for this interval. Float RegisteredIntertie.OutagedRegisteredResource.MaximumEnergyLimit (Choice3) activeperiod.start Start date and time of this interval datetime restrictedvalue The new maximum energy limit (WH) for this interval. RegisteredIntertie.OutagedRegisteredResource.MinimumEnergyLimit (Choice4) activeperiod.start Start date and time of this interval datetime restrictedvalue The new minimum energy limit (WH) for this interval. RegisteredIntertie.OutagedRegisteredResource.PMinimum(Choice5) activeperiod.start The time of this pmin rerate point in UTC datetime restrictedvalue The new minimum output of this resource/configuration for this interval RegisteredIntertie.OutagedRegisteredResource.UseLimit(Choice6) activeperiod.start Start date and time of this interval datetime restrictedvalue The new use Limit for the resource in this interval. Float RegisteredIntertie.OutagedRegisteredResource.RampRateSegment (Choice7) restrictedvalue The new ramp rate (MW/min) for this segment in this interval. segmentnumber The identifier for this segment Integer segmentvalue The right hand side (MW) of this segment. Float For detailed list of elements under OutageRegisterdResource click on link here. MessagePayload.RegisteredResourceOutage.RegisteredLoad(Choice3) Float Float Float Float Req d mrid The resource id for the RegisteredLoad. mrid minlen=1 maxlen=32 Name An alternate name from the Participant name minlen=1 maxlen=40 Doc ID: GNFDMDEHU6BB Page 25 of 112

26 Template 1.4 Element Data Description Type/ RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource Format/ Req d timetostartup The time the resource needs to start after the outage has completed. Float RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource.ASAvailability availablevalue The new MW value for this interval. Float MarketProduct.marketPr oducttype Type of AS that is restricted. Enumera tion RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource.Availability datetimepoint The time of this availability point in UTC. datetime outofservice Unit has avail 0 starting at this time. / returntonetdependablec apacity Indicates no derate starting at this time. / PmaxValue.vlaue Indicates Pmax value Float RegisteredResourceOutage.RegisteredLoad.OutagedRegisteredResource.Availability.OutagedRegisteredRe source.registeredresource.registeredresourceoutage RegisteredResource.RegisteredResourceOutage mrid ID for the Outage, t required for new outage, required when submitting a change request. RegisteredLoad.OutagedRegisteredResource.LoadMaximum(Choice1) activeperiod.start Start date and time of this interval datetime restrictedvalue The new MW value for this point. Float outofservice Unit has avail 0 starting at this time. / returntonetdependablec apacity Indicates no derate starting at this time. / RegisteredLoad.OutagedRegisteredResource.LoadMinimum(Choice2) activeperiod.start Start date and time of this interval datetime restrictedvalue The new MW value for this interval. Float RegisteredLoad.OutagedRegisteredResource.MaximumEnergyLimit (Choice3) activeperiod.start Start date and time of this interval datetime restrictedvalue The new maximum energy limit (WH) for this interval. Float Doc ID: GNFDMDEHU6BB Page 26 of 112

27 Template 1.4 Element Data Description Type/ RegisteredLoad.OutagedRegisteredResource.MinimumEnergyLimit (Choice4) Format/ Req d activeperiod.start Start date and time of this interval datetime restrictedvalue The new minimum energy limit (WH) for this interval. RegisteredLoad.OutagedRegisteredResource.PMinimum(Choice5) activeperiod.start The time of this pmin rerate point in UTC datetime restrictedvalue The new minimum output of this resource/configuration for this interval RegisteredLoad.OutagedRegisteredResource.UseLimit(Choice6) activeperiod.start Start date and time of this interval datetime restrictedvalue The new use Limit for the resource in this interval. Float RegisteredLoad.OutagedRegisteredResource.RampRateSegment (Choice7) restrictedvalue The new ramp rate (MW/min) for this segment in this interval. segmentnumber The identifier for this segment Integer segmentvalue The right hand side (MW) of this segment. Float Float Float Float Schema (ResourceOutageData_v1.xsd) Location: Example XML File (SubmitResourceOutageData_v1.xml) <?xml version="1.0" encoding="utf-8"?> <m:resourceoutagedata xmlns:m=" xmlns:xsi=" xsi:schemalocation=" ResourceOutageData_v1.xsd "> <m:messageheader> <m:timedate> t12:00:00</m:timedate> <m:source>companya</m:source> <m:version>v </m:version> </m:messageheader> <m:messagepayload> <m:registeredresourceoutage> <m:description>new Generator (MSG) Outage</m:description> <m:comment>example</m:comment> <m:affectsrassps>yes</m:affectsrassps> Doc ID: GNFDMDEHU6BB Page 27 of 112

28 Template 1.4 <m:discoverydatetime> t17:00:00z</m:discoverydatetime> <m:emergencyreturntime>1</m:emergencyreturntime> <m:emergencyreturntimetype>hours</m:emergencyreturntimetype> <m:mktorgoutageid>9690</m:mktorgoutageid> <m:outagecoordinationlongtermplanning>no</m:outagecoordinationlongtermplanning> <m:estimatedperiod> <m:end> t17:00:00z</m:end> <m:start> t13:00:00z</m:start> </m:estimatedperiod> <m:mktorganisation> <m:mrid>scid1</m:mrid> <m:marketperson> <m:firstname>john</m:firstname> <m:lastname>smith</m:lastname> <m:landlinephone> <m:areacode>916</m:areacode> <m:extension>555</m:extension> <m:localnumber>1234</m:localnumber> </m:landlinephone> </m:marketperson> </m:mktorganisation> <m:outagecause> <m:code>9690</m:code> </m:outagecause> <m:work> <m:kind>plant_maintenance</m:kind> </m:work> <m:isoffpeakopportunityoutage>no</m:isoffpeakopportunityoutage> <m:isshortticeopportunityoutage>no</m:isshortticeopportunityoutage> <m:registeredgenerator> <m:mrid>resourcea</m:mrid> <m:name>resource Alpha</m:name> <m:logicalconfiguration> <m:configuration> <m:mrid>resa1x1</m:mrid> <m:name>resource Alpha 1x1</m:name> <m:outagedregisteredresource> <m:availability> <m:datetimepoint> t13:00:00z</m:datetimepoint> <m:pmaxvalue> <m:multiplier>m</m:multiplier> <m:unit>w</m:unit> <m:value>80</m:value> </m:pmaxvalue> </m:availability> <m:availability> <m:datetimepoint> t17:00:00z</m:datetimepoint> Doc ID: GNFDMDEHU6BB Page 28 of 112

29 Template 1.4 <m:returntonetdependablecapacity>yes</m:returntonetdependablecapacity> <m:pmaxvalue> <m:multiplier>m</m:multiplier> <m:unit>w</m:unit> <m:value>100</m:value> </m:pmaxvalue> </m:availability> </m:outagedregisteredresource> </m:configuration> <m:configuration> <m:mrid>resa2x1</m:mrid> <m:name>resource Alpha 2x1</m:name> <m:outagedregisteredresource> <m:availability> <m:datetimepoint> t13:00:00z</m:datetimepoint> <m:pmaxvalue> <m:multiplier>m</m:multiplier> <m:unit>w</m:unit> <m:value>160</m:value> </m:pmaxvalue> </m:availability> <m:availability> <m:datetimepoint> t17:00:00z</m:datetimepoint> <m:returntonetdependablecapacity>yes</m:returntonetdependablecapacity> <m:pmaxvalue> <m:multiplier>m</m:multiplier> <m:unit>w</m:unit> <m:value>200</m:value> </m:pmaxvalue> </m:availability> <m:pminimum> <m:activeperiod> <m:start> t13:00:00z</m:start> </m:activeperiod> <m:restrictedvalue> <m:multiplier>m</m:multiplier> <m:unit>w</m:unit> <m:value>81</m:value> </m:restrictedvalue> </m:pminimum> <m:pminimum> <m:activeperiod> <m:start> t17:00:00z</m:start> </m:activeperiod> <m:restrictedvalue> <m:multiplier>m</m:multiplier> <m:unit>w</m:unit> <m:value>200</m:value> </m:restrictedvalue> </m:pminimum> Doc ID: GNFDMDEHU6BB Page 29 of 112

30 Template 1.4 </m:outagedregisteredresource> </m:configuration> </m:logicalconfiguration> <m:outagedregisteredresource> <m:asavailability> <m:availablevalue> <m:multiplier>m</m:multiplier> <m:unit>w</m:unit> <m:value>0</m:value> </m:availablevalue> <m:marketproduct> <m:marketproducttype>sr</m:marketproducttype> </m:marketproduct> </m:asavailability> </m:outagedregisteredresource> </m:registeredgenerator> </m:registeredresourceoutage> </m:messagepayload> </m:resourceoutagedata> Example XML File (SubmitResourceOutageChangeRequest_v1.xml) <?xml version="1.0" encoding="utf-8"?> <m:resourceoutagedata xmlns:m=" xmlns:xsi=" xsi:schemalocation=" ResourceOutageData_v1.xsd "> <m:messageheader> <m:timedate> t09:00:00z</m:timedate> <m:source>companya</m:source> <m:version>v </m:version> </m:messageheader> <m:messagepayload> <m:registeredresourceoutage> <m:mrid> </m:mrid> <m:description>new generator (MSG) Outage</m:description> <m:comment>example</m:comment> <m:affectsrassps>yes</m:affectsrassps> <m:discoverydatetime> t09:00:00z</m:discoverydatetime> <m:emergencyreturntime>1</m:emergencyreturntime> <m:emergencyreturntimetype>hours</m:emergencyreturntimetype> <m:mktorgoutageid>9690</m:mktorgoutageid> <m:outagecoordinationlongtermplanning>no</m:outagecoordinationlongtermplanning> <m:estimatedperiod> <m:end> t18:00:00z</m:end> <m:start> t13:00:00z</m:start> Doc ID: GNFDMDEHU6BB Page 30 of 112

31 Template 1.4 </m:estimatedperiod> <m:mktorganisation> <m:mrid>scid1</m:mrid> <m:marketperson> <m:firstname>john</m:firstname> <m:lastname>smith</m:lastname> <m:landlinephone> <m:areacode>916</m:areacode> <m:extension>555</m:extension> <m:localnumber>1234</m:localnumber> </m:landlinephone> </m:marketperson> </m:mktorganisation> <m:outagecause> <m:code>9690</m:code> </m:outagecause> <m:outagechangerequest> <m:action>update</m:action> <m:actionreason>work_rescheduled_to_later_date_sc</m:actionreason> </m:outagechangerequest> <m:work> <m:kind>plant_maintenance</m:kind> </m:work> <m:isoffpeakopportunityoutage>no</m:isoffpeakopportunityoutage> <m:isshortticeopportunityoutage>no</m:isshortticeopportunityoutage> <m:registeredgenerator> <m:mrid>resourcea</m:mrid> <m:name>resource Alpha</m:name> <m:logicalconfiguration> <m:configuration> <m:mrid>resa1x1</m:mrid> <m:name>resource Alpha 1x1</m:name> <m:outagedregisteredresource> <m:availability> <m:datetimepoint> t13:00:00z</m:datetimepoint> <m:returntonetdependablecapacity>yes</m:returntonetdependablecapacity> <m:outagedregisteredresource> <m:registeredresource> <m:registeredresourceoutage> <m:mrid>outage1234</m:mrid> </m:registeredresourceoutage> </m:registeredresource> </m:outagedregisteredresource> <m:pmaxvalue> <m:multiplier>m</m:multiplier> <m:unit>w</m:unit> <m:value>100</m:value> </m:pmaxvalue> Doc ID: GNFDMDEHU6BB Page 31 of 112

32 Template 1.4 </m:availability> </m:outagedregisteredresource> </m:configuration> </m:logicalconfiguration> <m:outagedregisteredresource> <m:timetostartup>cold</m:timetostartup> <m:asavailability> <m:availablevalue> <m:multiplier>m</m:multiplier> <m:unit>w</m:unit> <m:value>0</m:value> </m:availablevalue> <m:marketproduct> <m:marketproducttype>sr</m:marketproducttype> </m:marketproduct> </m:asavailability> </m:outagedregisteredresource> </m:registeredgenerator> </m:registeredresourceoutage> </m:messagepayload> </m:resourceoutagedata> 4.7 Submit Resource Outage {Change Request} Response Element Table Element Data Description Type/ Message Header Format/ Req d TimeDate The datetime, in UTC, when the payload is published datetime Source The source of the data Version Subversion of the XSD: Initial version will be v MessagePayload.EventLog MessagePayload.EventLog.Event result Event result. string id Event identifier. string description Event description. string creationdatetime Event creation time. datetime MessagePayload.EventLog.Service Doc ID: GNFDMDEHU6BB Page 32 of 112

33 Template 1.4 Element Data Description Type/ Format/ Req d id Service identifier. string name Name of a service. string MessagePayload.EventLog.Outage mrid ID assigned to the outage by the ISO mktorgoutageid Reference ID assigned to the outage by the external User MessagePayload.EventLog.Outage.OutageChangeRequest mrid ID assigned to the outage change request by the ISO MessagePayload.EventLog.Outage.OutageGroup mrid ID assigned to the outage Group by the ISO MessagePayload.EventLog.Outage.OutageValidation submitstatus Indicates whether the outage was accepted or rejected: ACCEPTED, REJECTED MessagePayload.EventLog.Outage.OutageValidation.OutageResult mrid ID assigned to the result by the ISO type Type of result: ERROR, INFO, WARNING description Description of result returned status Status of the result: ACKNOWLEDGED. UNACKNOWLEDGED. This is applicable only to warnings Schema (OutageStandardOutput_v1.xsd) Location: Example XML File (ResourceOutageStandardOutput.xml) Example XML File for Submit Resource Outage Response <?xml version="1.0" encoding="utf-8"?> <OutageStandardOutput xmlns=" xmlns:xsi=" xsi:schemalocation=" OutageStandardOutput_v1.xsd "> <MessageHeader> Doc ID: GNFDMDEHU6BB Page 33 of 112

34 Template 1.4 <TimeDate> T11:00:00Z</TimeDate> <Source>CompanyA</Source> <Version>v </Version> </MessageHeader> <MessagePayload> <EventLog> <Event> <id>1</id> <result>success</result> </Event> <Outage> <mrid> </mrid> <mktorgoutageid>marketoutageid-1234</mktorgoutageid> <OutageValidation> <submitstatus>accepted</submitstatus> <OutageResult> <mrid>1</mrid> <description>validated</description> <status>acknowledged</status> <type>info</type> </OutageResult> </OutageValidation> </Outage> <Service> <id>12345</id> <name>submitresourceoutage_v1</name> </Service> </EventLog> </MessagePayload> </OutageStandardOutput> Example XML File for Submit Resource Outage Change Request Response <?xml version="1.0" encoding="utf-8"?> <m:resourceoutagedata xmlns:m=" xmlns:xsi=" xsi:schemalocation=" ResourceOutageData_v1.xsd "> <m:messageheader> <m:timedate> t09:00:00z</m:timedate> <m:source>companya</m:source> <m:version>v </m:version> </m:messageheader> <m:messagepayload> <m:registeredresourceoutage> <m:mrid> </m:mrid> <m:description>new generator (MSG) Outage</m:description> Doc ID: GNFDMDEHU6BB Page 34 of 112