Skip to content

Outage Update

Outage Update

The request message for outage update would use the following message fields:

Message Element Value
Header/Verb Change
Header/Noun OutageSet
Header/Source Market participant ID
Header/UserID ID of user
Payload OutageUpdate

The corresponding response messages would use the following message fields:

Message Element Value
Header/Verb Reply
Header/Noun OutageSet
Header/Source ERCOT
Reply/ReplyCode Reply code, success=OK, error=ERROR or FATAL
Reply/Error Error message, if error encountered

OutageUpdate Structure

On Outage change requests, the following items are used:

Element Req? Data type Description Values
Command N string Requestor Update UNGROUP, ACKNOWLEDGE,
OutageUpdate/
   mRID		 Y string Outage Identity mRID is in the  format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent>
OutageUpdate/
   groupId		 N String This is the id for a Group Outage
OutageUpdate/
   userFullName		 Y String UserFullName is required on a Submit, Update and Cancel. Note: the element is defined as optional in the XSD.
OutageUpdate/
   tertiaryContact		 N string Tertiary Contact Phone No.
OutageUpdate/
   takeOpportunity		 N boolean For taking opportunity outage. i.e. To accept the opportunity when a opportunity match exists. true/false
Schedule/
   plannedSart		 N dateTime This is the date/time at which the Outage is planned to start.
Schedule/
   plannedEnd		 N dateTime This is the date/time at which the Outage is planned to end.
Schedule/
   earliestStart		 N dateTime This is the earliest date/time at which the Outage may start.
Schedule/
   latestEnd		 N dateTime This is the latest date/time at which the Outage may end.
Schedule/
   actualStart		 N dateTime This is the actual date/time at which the Outage started.
Schedule/
   actualEnd		 N dateTime This is the actual date/time at which the Outage ended.
Schedule/
   new_plannedStart		 N dateTime This is the proposed date/time at which an Unavoidable Extension may start.
Schedule/
   new_plannedEnd		 N dateTime This is the proposed date/time at which an Unavoidable Extension may end.
Schedule/
   new_earliestStart		 N dateTime This is the proposed earliest date/time at which a Resource Opportunity Outage may start.
Schedule/
   new_latestEnd		 N dateTime This is the proposed latest date/time at which a Resource Opportunity Outage may end.
transmissionData/
   emergencyRestorationTime		 N positiveInteger
transmissionData/
   transNatureOfWork		 N string
resourceData/
   highSustainableLimit		 N integer
resourceData/
   lowSustainableLimit		 N Integer
resourceData/
   resNatureOfWork		 N string
addToGroup/
   groupId		 N string
addToGroup/
   name		 Y string
ResourceOutage/
   operatingCompany		 Y string
ResourceOutage/
   station		 Y string This is the station name of a Resource that is a Designated Resource for this Outage.
ResourceOutage/
   equipmentName		 Y string This is the name of a Resource that is a Designated Resource for this Outage.
ResourceOutage/
   equipmentIdentifier		 Y string
ResourceOutage/
   resourceType		 N string This is the type of a Resource that is a Designated Resource for this Outage. UN (Unit), LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR)
ResourceOutage/
   HSL		 Y Decimal Resource Outage HSL
ResourceOutage/
   LSL		 Y Decimal Resource Outage LSL
ResourceOutage/
   mRID		 N string Outage Identity mRID is in the  format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent>
ResourceOutage/
   natureOfWork		 Y string Resource Outage Nature of Work. . The allowable values for this field are stated above.
GroupTransmissionOutage/
   operatingCompany		 Y string
GroupTransmissionOutage/
   equipmentName		 Y string The name of the Equipment that can be the subject of an Outage.
GroupTransmissionOutage/
   equipmentIdentifier		 Y string
GroupTransmissionOutage/
   transmissionType		 Y string The Type of the Transmission Equipment that can be the subject of an Outage.
GroupTransmissionOutage/
   fromStation		 Y string This is the name of the Station in which an Equipment resides for all equipment types other than lines. For lines this refers to the “From” station
GroupTransmissionOutage/
   toStation		 N string This is the name of the “To” Station in which an Equipment resides for all lines.
GroupTransmissionOutage/
   normalState		 N string This field, which is pertinent only for switching devices, contains the normal state of the device: OPEN or CLOSED. This field is the same as the Normal State of the Equipment entity. Output only
GroupTransmissionOutage/
   outageState		 N string This field, which is pertinent (and required) only for switching devices, contains the state of the device when taken out of service: OPEN or CLOSED. This field is the opposite of the Normal State of the Equipment entity. “C’,”O” or “”
GroupTransmissionOutage/
   voltage		 N Decimal The voltage level at which the Equipment resides. For transformers it is the high side voltage level.
GroupTransmissionOutage/
   projectName		 N String
GroupTransmissionOutage/
   emergencyRestorationTime		 Y positiveInteger This is the time in hours necessary to terminate the Outage and return the Equipment to service.
GroupTransmissionOutage/
   mRID		 N string Outage Identity mRID is in the  format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent>
GroupTransmissionOutage/
   natureOfWork		 Y string
Opportunity/
   opportunityDuration/
      days		 N unsigned Byte For Opportunity Outages, the outage no. of days. Positive no.
Opportunity/
   opportunityDuration/
      hours		 N unsigned Byte For Opportunity Outages, the outage no. of hours Positive no.
Opportunity/
   opportunityEnd		 Y DateTime For Opportunity Outages, the outage end time Date Time
Opportunity/
   designatedResource/
      equipmentName		 Y string This is the Resource name of a Resource that has been designated to an Opportunity
Opportunity/
   designatedResource/
      equipmentIdentifier		 Y String
Opportunity/
   designatedResource/
      resourceType		 Y String This is the Resource type of a Resource that has been designated to an Opportunity UN (Unit),LR (Load Resource), Distribution Generation Resource (DGR) and Distribution Energy Storage Resource (DESR)
Opportunity/
   designatedResource/
      station		 Y String
Opportunity/
   designatedResource/
      HSL		 Y Decimal
Opportunity/
   designatedResource/
      desgOutageIdent		 N String Designated Resource Outage Identifier corresponding to a valid TOO ( Transmission Opportunity Outage). Not required for outage create transaction. Outage Schedule will populate this field in OS query response
Opportunity/
   designatedResource/
      desgOutageStart		 N dateTime Designated Resource outage start dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response
Opportunity/
   designatedResource/
      desgOutageEnd		 N dateTime Designated Resource outage End dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response
OSNotes/
   RequestorNotes/
      Note/
         createdTime		 Y string There are three sections that the requestor can enter notes, Requestor Notes, Supporting Information, and Remedial Action or Special Protection System notes. Notes are required for some outage types but not all. They are not required when the outage is submitted but are required for some outages to be completed.
OSNotes/
   RequestorNotes/
      Note/
         createdBy		 Y string
OSNotes/
   RequestorNotes/
      Note/
         company		 Y string
OSNotes/
   RequestorNotes/
      Note/
         comment		 Y string
OSNotes/
   SupportingNotes/
      Note/
         createdTime		 Y string
OSNotes/
   SupportingNotes/
      Note/
         createdBy		 Y string
OSNotes/
   SupportingNotes/
      Note/
         company		 Y string
OSNotes/
   SupportingNotes/
      Note/
         comment		 Y string
OSNotes/
   RASPSNotes/
      Note/
         createdTime		 Y string
OSNotes/
   RASPSNotes/
      Note/
         createdBy		 Y string
OSNotes/
   RASPSNotes/
      Note/
         company		 Y string
OSNotes/
   RASPSNotes/
      Note/
         comment		 Y string
Error/
   severity		 N string Severity of Error Generated
Error/
   area		 N string Area of generated error
Error/
   interval		 N string
Error/
   text		 Y string Error Text

Element Req? Data type Description Values
Command N string Requestor Update UNGROUP, ACKNOWLEDGE,
OutageUpdate/
   mRID		 Y string Outage Identity mRID is in the  format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent>
OutageUpdate/
   groupId		 N String This is the id for a Group Outage
OutageUpdate/
   userFullName		 Y String UserFullName is required on a Submit, Update and Cancel. Note: the element is defined as optional in the XSD.
OutageUpdate/
   tertiaryContact		 N string Tertiary Contact Phone No.
OutageUpdate/
   takeOpportunity		 N boolean For taking opportunity outage. i.e. To accept the opportunity when a opportunity match exists. true/false
Schedule/
   plannedSart		 N dateTime This is the date/time at which the Outage is planned to start.
Schedule/
   plannedEnd		 N dateTime This is the date/time at which the Outage is planned to end.
Schedule/
   earliestStart		 N dateTime This is the earliest date/time at which the Outage may start.
Schedule/
   latestEnd		 N dateTime This is the latest date/time at which the Outage may end.
Schedule/
   actualStart		 N dateTime This is the actual date/time at which the Outage started.
Schedule/
   actualEnd		 N dateTime This is the actual date/time at which the Outage ended.
Schedule/
   new_plannedStart		 N dateTime This is the proposed date/time at which an Unavoidable Extension may start.
Schedule/
   new_plannedEnd		 N dateTime This is the proposed date/time at which an Unavoidable Extension may end.
Schedule/
   new_earliestStart		 N dateTime This is the proposed earliest date/time at which a Resource Opportunity Outage may start.
Schedule/
   new_latestEnd		 N dateTime This is the proposed latest date/time at which a Resource Opportunity Outage may end.
transmissionData/
   emergencyRestorationTime		 N positiveInteger
transmissionData/
   transNatureOfWork		 N string
resourceData/
   highSustainableLimit		 N integer
resourceData/
   lowSustainableLimit		 N Integer
resourceData/
   resNatureOfWork		 N string
addToGroup/
   groupId		 N string
addToGroup/
   name		 Y string
ResourceOutage/
   operatingCompany		 Y string
ResourceOutage/
   station		 Y string This is the station name of a Resource that is a Designated Resource for this Outage.
ResourceOutage/
   equipmentName		 Y string This is the name of a Resource that is a Designated Resource for this Outage.
ResourceOutage/
   equipmentIdentifier		 Y string
ResourceOutage/
   resourceType		 N string This is the type of a Resource that is a Designated Resource for this Outage. UN (Unit), LR (Load Resource), Distribution Generation Resource (DGR), Distribution Energy Storage Resource (DESR) and Energy Storage Resource (ESR)
ResourceOutage/
   HSL		 Y Decimal Resource Outage HSL
ResourceOutage/
   LSL		 Y Decimal Resource Outage LSL
ResourceOutage/
   mRID		 N string Outage Identity mRID is in the  format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent>
ResourceOutage/
   natureOfWork		 Y string Resource Outage Nature of Work. . The allowable values for this field are stated above.
GroupTransmissionOutage/
   operatingCompany		 Y string
GroupTransmissionOutage/
   equipmentName		 Y string The name of the Equipment that can be the subject of an Outage.
GroupTransmissionOutage/
   equipmentIdentifier		 Y string
GroupTransmissionOutage/
   transmissionType		 Y string The Type of the Transmission Equipment that can be the subject of an Outage.
GroupTransmissionOutage/
   fromStation		 Y string This is the name of the Station in which an Equipment resides for all equipment types other than lines. For lines this refers to the “From” station
GroupTransmissionOutage/
   toStation		 N string This is the name of the “To” Station in which an Equipment resides for all lines.
GroupTransmissionOutage/
   normalState		 N string This field, which is pertinent only for switching devices, contains the normal state of the device: OPEN or CLOSED. This field is the same as the Normal State of the Equipment entity. Output only
GroupTransmissionOutage/
   outageState		 N string This field, which is pertinent (and required) only for switching devices, contains the state of the device when taken out of service: OPEN or CLOSED. This field is the opposite of the Normal State of the Equipment entity. “C’,”O” or “”
GroupTransmissionOutage/
   voltage		 N Decimal The voltage level at which the Equipment resides. For transformers it is the high side voltage level.
GroupTransmissionOutage/
   projectName		 N String
GroupTransmissionOutage/
   emergencyRestorationTime		 Y positiveInteger This is the time in hours necessary to terminate the Outage and return the Equipment to service.
GroupTransmissionOutage/
   mRID		 N string Outage Identity mRID is in the  format of <QSEID>.OTG.<outageType>.<outageCategory>.<outageIdent>
GroupTransmissionOutage/
   natureOfWork		 Y string
Opportunity/
   opportunityDuration/
      days		 N unsigned Byte For Opportunity Outages, the outage no. of days. Positive no.
Opportunity/
   opportunityDuration/
      hours		 N unsigned Byte For Opportunity Outages, the outage no. of hours Positive no.
Opportunity/
   opportunityEnd		 Y DateTime For Opportunity Outages, the outage end time Date Time
Opportunity/
   designatedResource/
      equipmentName		 Y string This is the Resource name of a Resource that has been designated to an Opportunity
Opportunity/
   designatedResource/
      equipmentIdentifier		 Y String
Opportunity/
   designatedResource/
      resourceType		 Y String This is the Resource type of a Resource that has been designated to an Opportunity UN (Unit),LR (Load Resource), Distribution Generation Resource (DGR), Distribution Energy Storage Resource (DESR) and Energy Storage Resource (ESR)
Opportunity/
   designatedResource/
      station		 Y String
Opportunity/
   designatedResource/
      HSL		 Y Decimal
Opportunity/
   designatedResource/
      desgOutageIdent		 N String Designated Resource Outage Identifier corresponding to a valid TOO ( Transmission Opportunity Outage). Not required for outage create transaction. Outage Schedule will populate this field in OS query response
Opportunity/
   designatedResource/
      desgOutageStart		 N dateTime Designated Resource outage start dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response
Opportunity/
   designatedResource/
      desgOutageEnd		 N dateTime Designated Resource outage End dateTime Not required for outage create transaction. Outage Schedule will populate this field in OS query response
OSNotes/
   RequestorNotes/
      Note/
         createdTime		 Y string There are three sections that the requestor can enter notes, Requestor Notes, Supporting Information, and Remedial Action or Special Protection System notes. Notes are required for some outage types but not all. They are not required when the outage is submitted but are required for some outages to be completed.
OSNotes/
   RequestorNotes/
      Note/
         createdBy		 Y string
OSNotes/
   RequestorNotes/
      Note/
         company		 Y string
OSNotes/
   RequestorNotes/
      Note/
         comment		 Y string
OSNotes/
   SupportingNotes/
      Note/
         createdTime		 Y string
OSNotes/
   SupportingNotes/
      Note/
         createdBy		 Y string
OSNotes/
   SupportingNotes/
      Note/
         company		 Y string
OSNotes/
   SupportingNotes/
      Note/
         comment		 Y string
OSNotes/
   RASPSNotes/
      Note/
         createdTime		 Y string
OSNotes/
   RASPSNotes/
      Note/
         createdBy		 Y string
OSNotes/
   RASPSNotes/
      Note/
         company		 Y string
OSNotes/
   RASPSNotes/
      Note/
         comment		 Y string
Error/
   severity		 N string Severity of Error Generated
Error/
   area		 N string Area of generated error
Error/
   interval		 N string
Error/
   text		 Y string Error Text

The following is an example for an Update OutageSet request that updates schedule and emergency restoration time:

<OutageUpdate xmlns="http://www.ercot.com/schema/2007-06/nodal/ews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <mRID>TABC.OTG.PL.Transmission.ABC00118301</mRID>
    <userFullName>Alex Smith</userFullName>
    <Schedule>
        <plannedStart>2016-08-16T11:00:00-05:00</plannedStart>
        <plannedEnd>2016-08-16T13:00:00-05:00</plannedEnd>
        <earliestStart>2016-08-16T11:00:00-05:00</earliestStart>
        <latestEnd>2016-08-16T14:00:00-05:00</latestEnd>
    </Schedule>
    <transmissionData>
        <emergencyRestorationTime>2</emergencyRestorationTime>
    </transmissionData>
</OutageUpdate>

The following is an example for an Update OutageSet request that add equipment to a group outage:

<OutageUpdate xmlns="http://www.ercot.com/schema/2007-06/nodal/ews"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <mRID>TABC.OTG.M1.Transmission.ABC00116294</mRID>
    <userFullName>Alex Smith</userFullName>
    <tertiaryContact>512-555-5555</tertiaryContact>
    <addToGroup>
        <groupId>TABC.OTG.166835</groupId>
        <name>Grp1</name>
        <GroupTransmissionOutage>
            <operatingCompany>TABC</operatingCompany>
            <equipmentName>AB_2315</equipmentName>
            <equipmentIdentifier>_{ABCE0AC3-6111-4DCF-803F-27B372A3A081}</equipmentIdentifier>
            <transmissionType>CB</transmissionType>
            <fromStation>Station1</fromStation>
            <normalState>0</normalState>
            <outageState>O</outageState>
            <voltage>0</voltage>
            <projectName>Project1</projectName>
            <emergencyRestorationTime>1</emergencyRestorationTime>
            <natureOfWork>OT</natureOfWork>
        </GroupTransmissionOutage>
    </addToGroup>
    <OSNotes>
        <RequestorNotes>
            <Note>
                <createdTime>2016-03-10T11:13:51-06:00</createdTime>
                <createdBy>Alex Smith</createdBy>
                <company>TABC</company>
                <comment>Adding equipment</comment>
            </Note>
        </RequestorNotes>
    </OSNotes>
</OutageUpdate>