Data API Data Exchange Guide - Southwest Power Pool api data exchange guide v1.1.pdf3 Data API Data Exchange Guide Data Type Description dateTime1 Date time. The general format is

Data API Data Exchange Guide

ii

Contents Scope and Prerequisite Knowledge .............................................................................. iv Change Summary ......................................................................................................... iv

1. Web Service Overview ........................................................................... 1

1.1 Deployment Environment ........................................................................................ 1 1.1.1 Client Side .......................................................................................................... 1

2. Description of SOAP Messages ............................................................ 2

2.1 Format and Construction ......................................................................................... 2 2.2 Data Types .............................................................................................................. 2

2.2.1 Handling Times .................................................................................................. 3 2.3 Responses .............................................................................................................. 4

3. Registration Process ............................................................................. 6

4. Data Packages Overview ....................................................................... 7

5. Data Packages Details ........................................................................... 8

5.1 Calibration Data ...................................................................................................... 8 5.1.1 Query Request Message ................................................................................... 8

5.2 Commercial Model (NERC Translation) ................................................................ 10 5.2.1 Query Request Message ................................................................................. 10

5.3 Energy Schedules ................................................................................................. 11 5.3.1 Query Request Message ................................................................................. 11

5.4 Integrated Schedules and Non-Integrated Schedules ........................................... 13 5.4.1 Query Request Message ................................................................................. 13

5.5 LIP_Data ............................................................................................................... 18 5.5.1 Query Request Message ................................................................................. 18

5.6 Loss Location Data ............................................................................................... 20 5.6.1 Query Request Message ................................................................................. 20

5.7 Meter Data ............................................................................................................ 22 5.7.1 Query Request Message ................................................................................. 22

5.8 RSS Data .............................................................................................................. 24 5.8.1 Query Request Message ................................................................................. 24

5.9 SLIP Data .............................................................................................................. 26 5.9.1 Query Request Message ................................................................................. 26

Appendix A. Appendices ......................................................................... 28

A.1 Appendix A – Data Dictionary ............................................................................... 28

iii

A.1.1 Single Schedules (Integrated and Non-Integrated) .......................................... 28 A.1.2 Calibrations ...................................................................................................... 30 A.1.3 Meters .............................................................................................................. 30 A.1.4 Energy_Schedules .......................................................................................... 31 A.1.5 Loss by Location .............................................................................................. 32 A.1.6 RSS ................................................................................................................. 32 A.1.7 Commercial Model (NERC Translation) ........................................................... 33 A.1.8 LIP Data ........................................................................................................... 34 A.1.9 SLIP Data ........................................................................................................ 34

iv

About This Document This document describes the SOAP messages used to retrieve data from the SPP Data API System. This document describes the background for each message and lays out the format and construction of SOAP messages.

Scope and Prerequisite Knowledge This document is intended to be used by SPP Members and participating vendors as an aid in developing interfaces to access the Data API data packages. Users of this Guide should be familiar with SOAP, Extensible Markup Language (XML), Web Services and HTTP/HTTPS protocols.

Change Summary

Rev Author Date Comments

1.0 S. Morris 06/01/11 Initial draft.

1.1 D. Giessmann 07/29/11 Updated Registration Process

1 Data API Data Exchange Guide

1. Web Service Overview The Data API web services will use SOAP over HTTPS and have operations and message content defined using Web Services Definition Language (WSDL). Within this document, all web service operations have been described using a request/reply pattern that is typical of HTTPS communication. A request must contain a message that queries for data (i.e., wants to consume data). A reply contains a message that is either: 1) an error, or 2) the response to a query. It is required that all data be transported using digital certificates

1.1 Deployment Environment From an HTTPS point of view, client software initiates a request, while server software responds to a client request. Client-side software is used under the following scenarios:

• A data-consuming application requests data from a data owning application (sends an HTTPS GET)

Server-side software is used under the following scenarios:

• A data-owning application receives a request for data from a data consuming application (responds to an HTTPS GET)

1.1.1 Client Side The client software needs to:

• Have the ability to use X.509 digital certificates (Required)

• Rely on configuration to obtain endpoints and certificate locations (Suggested)

• Rely on configuration to specify the maximum number of retries for sending requests to endpoints (Suggested)


2. Description of SOAP Messages This section describes the documentation conventions used and provides details about the constructs of SOAP messages.

2.1 Format and Construction SOAP messages are an XML-formatted structure wrapped in a SOAP envelope. A sample instance of an XML document with a SOAP envelope is shown below: <soapenv:Envelope> xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mes="http://someurl/Messages"> <soapenv:Header/> <soapenv:Body> <mes:SubmitSomeMessage>  <mes:Message day="2010-06-01" ID="1234"> <mes:HourlyData>  <mes:Values hour="2010-06-01T00:00:00-06:00"> <mes:Value1>SomeValue</mes:Value1> <mes:Value2>AnotherValue</mes:Value2> </mes:Values> </mes:HourlyData > </mes:Message> </mes:SubmitSomeMessage> </soapenv:Body> </soapenv:Envelope>

The sample message above shows the format of messages used in the descriptions for each interface (described more in section 4 - Data Packages Details).

2.2 Data Types Within the XSD, both native XML data types and custom-defined data types are used. Below is a list of the common data types used with a description of their format.

Data Type Description

boolean1 Boolean. Values are; true, 1, false, 0

date1 General format is yyyy-mm-dd (additional information in next section)


Data Type Description

dateTime1 Date time. The general format is yyyy-mm-ddThh:mm:ss.ff3-hh:mm. Milliseconds are indicated by the ff3 format. Milliseconds are optional but are allowed to be sent in messages. Milliseconds will be returned on some data packages. Time component must specify the timezone offset (additional information in next section).

ElapsedTimeType Time in hours expressed as decimal using 5.2 format and range is 0 <= X <= 999.99

FactorType Decimal using 6.5 format and range is 0 < X <= 1.00000

long1 Integer value used primarily for IDs

MWFlowType Decimal using 6.1 format and range is -99999.9 < X <= 99999.9, Units in Megawatts (MW)

MWType Decimal using 6.1 format and range is 0 <= X <= 99999.9, Units in Megawatts (MW)

PriceType Decimal using 6.2 format and range is 0 <= X <= 9999.99, Units in dollars

string1 General purpose string with and specifier for the maximum string length (e.g. String;40)

Enumerated String Enumerated String. Values vary, and are listed in the table describing the Elements and Attributes.

NOTE 1: These types are native XML types. All other types are types

specifically defined for the interface.

2.2.1 Handling Times The XML data types shown in the following table are used to represent date and time values. The lexical representation for these data types is specified by the ISO 8601 standard. The table shows the common notation for each, though the standard allows for great flexibility in formats.


Data Type Lexical Representation Example

date yyyy-mm-dd 2011-02-01

dateTime yyyy-mm-ddThh:mm:sss-hh:mm 2011-02-01T00:00:00.000-06:00 2011-02-01T06:00:00.000Z 2011-02-01T06:00:00.000-00:00

Note that the dateTime format includes the time zone indicator and the example shows time in Central Standard Time. XML messages that have dateTime elements or attributes are required to specify a time zone indicator to avoid confusion during the daylight savings transition periods. Having "-05:00" and "-06:00" at the end of dateTime representations specifies Central Daylight and Central Standard respectively. All samples in this document show timestamps referencing GMT zone. The samples below show different examples of dates within different time zones.

Date Time Example

Jan 1, 2011 Midnight Central Standard Time

2011-01-01T00:00:00.000-06:00

2011-01-01T06:00:00.000-00:00

2011-01-01T06:00:00.000Z

May 25, 2011 7:30 pm Central Standard Time

2011-05-25T19:30:00.000-06:00

2011-05-26T01:30:00.000-00:00

2011-05-26T01:30:00.000Z

2.3 Responses A query will return either the Standard Error Response as shown below or a response message that is specific to the query. If an empty body is returned there either is no data to return based on your query parameters or there is a server side error that hasn’t been captured for formatting as of this document’s writing.


Standard Query Response: <soapenv:Envelope> xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" <soapenv:Header/> <soapenv:Body>  <mes:Data xmlns:mes="http://api.spp.com/general_service"> <mes:Row>?</mes:Row> </mes:Data> </soapenv:Body> </soapenv:Envelope>

Standard Error Response: <soapenv:Envelope> xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" <soapenv:Header/> <soapenv:Body> <soapenv:Fault>  <faultcode>?</faultcode> <faultstring>?</faultstring> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>


3. Registration Process Use this process if LSA is setting up the user for the first time:

1. LSA logs into Market Portal (https://portal.itespp.org/SPP) using LSA certificate. 2. Continue to the “Customer Relations” tab, mouse over the “Portal Users” option and

select “Create” for a new user. 3. Enter new user contact information for new users. 4. Using information obtained from the “Detailed Certification Information” link from the

SPP Oasis site (https://sppoasis.spp.org/ap/certificatetools/certificateinfo.asp) enter the Certificate Serial Number and Certificate Issuer information EXACTLY AS IT APPEARS from that page. Copy and pasting this information is beneficial, however be sure to not include leading or trailing blank spaces in either field.

5. Select appropriate roles for the user that is being entered. Questions about roles can be directed to the appropriate Customer Relations Representative.

6. Click “Submit” to complete the user setup within the portal. 7. Send an email to your Customer Relations Representative including the Certificate

Information from Step 4, and indicate that you wish to register the user for Data API access.

8. SPP will send an email confirmation when the subscription has been accepted. 9. IT will schedule the move into the different testing environments before moving to

Production. NOTE: The certificates will be different for the testing environment versus the Production environment, so this process will need to be repeated for each environment that needs to connect to the Data API.

Use this process if your certificate is already on file with SPP

1. LSA logs into Market Portal (https://portal.itespp.org/SPP) using LSA certificate. 2. If the user already exists and has the appropriate certificate assigned to it, proceed to step

3. If not, refer to process for adding a new user. 3. Using information obtained from the “Detailed Certification Information” link from the

SPP Oasis site (https://sppoasis.spp.org/ap/certificatetools/certificateinfo.asp), send an email to your Customer Relations Representative including the “Detailed Certificate Information,” and indicate that you wish to register the user for Data API access.

4. SPP will send an email confirmation when the subscription has been accepted. 5. IT will schedule the move into the different testing environments before moving to

Production. NOTE: The certificates will be different for the testing environment versus the Production environment, so this process will need to be repeated for each environment that needs to connect to the Data API.

https://portal.itespp.org/SPP�

https://sppoasis.spp.org/ap/certificatetools/certificateinfo.asp�

https://portal.itespp.org/SPP�

https://sppoasis.spp.org/ap/certificatetools/certificateinfo.asp�


4. Data Packages Overview This chapter provides a high level overview of the Data API provided data packages.

Data Package URL Input Parameters

Maximum Range

Snapshot / Static

Calibration_Data https://api.itespp.org/Calibration_Data?WSDL

StartTime StopTime

< Month Static

ComMod_Data https://api.itespp.org/ComMod_Data?WSDL

None None Snapshot

Energy_Schedules https://api.itespp.org/Energy_Schedules_Data?WSDL

StartTime StopTime

< 1 Day Snapshot

Integrated_Schedules https://api.itespp.org/Integrated_Schedules_Data?WSDL

StartTime StopTime

< 1 Day Snapshot

LIP_Data https://api.itespp.org/LIP_Data?WSDL

Date PNode

1 Day / Pnode

Static

Loss_Location_Data https://api.itespp.org/Loss_Location_Data?WSDL

StartTime StopTime

< 1 Day Snapshot

Meter_Data https://api.itespp.org/Meter_Data?WSDL

StartTime StopTime

< 1 Day Static

NonIntegrated_Schedules https://api.itespp.org/NonIntegrated_Schedules_Data?W

SDL

StartTime StopTime

< 1 Day Snapshot

RSS_Data https://api.itespp.org/RSS_Data?WSDL

StartTime StopTime

< 1 Month Snapshot

SLIP_Data https://api.itespp.org/SLIP_Data?WSDL

StartTime StopTime

< 3 Months Static

The data being returned by the API represents the data at the point in time of the request. Some data is static which will not change between requests. Some data is a snapshot indicating that it could possibly change based on the system’s business rules and will need to be requested again if a known change has happened. In the above table, ‘Static’ indicates that there is no need to request the same date range in future requests. ‘Snapshot’ indicates that it is a point in time request and the data could possibly be different the next time a request is made. NOTE: All secondary input parameters will be derived off of the NercID provided during the subscription process. The maximum date ranges indicated will be enforced in the future to ensure that the throughput of the packages is maintained as well as the safety of SPP’s databases. If a request takes longer than expected, a shorter date range should be requested as the system has found more data than it can package in a reasonable amount of time.

https://api.itespp.org/Calibration_Data?WSDL�

https://api.itespp.org/Calibration_Data?WSDL�

https://api.itespp.org/ComMod_Data?WSDL�

https://api.itespp.org/ComMod_Data?WSDL�

https://api.itespp.org/Energy_Schedules_Data?WSDL�


https://api.itespp.org/Integrated_Schedules_Data?WSDL�

https://api.itespp.org/Integrated_Schedules_Data?WSDL�

https://api.itespp.org/LIP_Data?WSDL�

https://api.itespp.org/LIP_Data?WSDL�

https://api.itespp.org/Loss_Location_Data?WSDL�

https://api.itespp.org/Loss_Location_Data?WSDL�

https://api.itespp.org/Meter_Data?WSDL�

https://api.itespp.org/Meter_Data?WSDL�

https://api.itespp.org/NonIntegrated_Schedules_Data?WSDL�



https://api.itespp.org/RSS_Data?WSDL�

https://api.itespp.org/RSS_Data?WSDL�

https://api.itespp.org/SLIP_Data?WSDL�

https://api.itespp.org/SLIP_Data?WSDL�


5. Data Packages Details 5.1 Calibration Data

The Calibration Data Service defines the operations that are used to exchange calibration data between SPP and outside entities. The web services and message content are described in the files listed in the table below.

Filename Namespace

https://api.itespp.org/Calibration_Data?wsdl https://api.itespp.org/Calibration_Data

The web service operations are captured in the following diagram.

5.1.1 Query Request Message 5.1.1.1 Required Request Parameters

Opt. Nilable Element Data Type; Format Comments

No No StartDate dateTime yyyy-mm-ddThh:mm:ss.ff3-hh:mm. (see section 2.2 for details)

The desired starting date time. Future dates will return nothing as will past dates that have rolled off the archive systems.

No No StopDate dateTime yyyy-mm-ddThh:mm:ss.ff3-hh:mm. (see section 2.2 for details)

The desired ending date time. Future dates will return the most recent data in the polled system.

5.1.1.2 SOAP Format Sample of Query Submittal

<cal:Request xmlns:cal="https://api.spp.org/Calibration_Data"> <cal:StartDate>2007-01-01T00:00:00.000-06:00</cal:StartDate> <cal:StopDate>2011-01-31T00:00:00.000-06:00</cal:StopDate> </cal:Request>

https://api.itespp.org/Calibration_Data?wsdl�


5.1.1.3 Data Returned Response Elements <cal:Calibration_Data xmlns:cal="https://api.spp.org/Calibration_Data"> <cal:Row> <cal:SettlementArea>SettlementArea</cal:SettlementArea> <cal:OperatingDate>2011-01-05T06:00:00.000Z</cal:OperatingDate> <cal:SettlementType>R4</cal:SettlementType> <cal:DeterminantTypeName>Actual Calibration Factor</cal:DeterminantTypeName> <cal:IntervalValue>1</cal:IntervalValue> <cal:Value>0</cal:Value> </cal:Row> </cal:Calibration_Data>

NOTE: See Appendix A - Calibrations for data dictionary information


5.2 Commercial Model (NERC Translation) The Commercial Model Service defines the operations that are used to exchange NERC translated data between SPP and outside entities. The web services and message content are described in the files listed in the table below.

Filename Namespace

https://api.itespp.org/ComMod_Data?wsdl https://api.itespp.org/ComMod_Data



There are no required parameters for this service. 5.2.1.2 SOAP Format

Sample of Query Submittal <com:Request xmlns:com="https://api.spp.org/ComMod_Data"/>

5.2.1.3 Data Returned Response Elements <com:ComMod_Data xmlns:com="https://api.spp.org/ComMod_Data"> <com:Row> <com:NercSrcSink>SourceSink</com:NercSrcSink> <com:EntityType>LE</com:EntityType> <com:StartDate>2005-01-01T00:00:00.000Z</com:StartDate> <com:StopDate>2006-03-09T00:00:00.000Z</com:StopDate> <com:ControlArea>CA</com:ControlArea> <com:SettlementLocation>SettlmntLocation</com:SettlementLocation> <com:PSE>PSE</com:PSE> <com:PNODE>PNODE</com:PNODE> </com:Row> </com:ComMod_Data>

NOTE: See Appendix A - Commercial Model (NERC Translation) for data dictionary information

https://api.itespp.org/ComMod_Data?wsdl�


5.3 Energy Schedules The Energy Schedules Service defines the operations that are used to exchange market schedule and reservation data between SPP and outside entities. The web services and message content are described in the files listed in the table below.

Filename Namespace

https://api.itespp.org/Energy_Schedules_Data?WSDL https://api.itespp.org/Energy_Schedules_Data









<ener:Request xmlns:ener="https://api.spp.org/Energy_Schedules_Data"> <ener:StartDate>2011-05-25T06:00:00.000Z</ener:StartDate> <ener:StopDate>2011-05-26T05:59:00.000Z</ener:StopDate> </ener:Request>

5.3.1.3 Data Returned Response Elements



<ene:EnergySchedules xmlns:ene="https://api.spp.org/Energy_Schedules_Data"> <ene:SingleSchedule> <ene:ETS_EnergySchedules> <ene:ETSSchedule> <ene:Schedule_Name>ScheduleName</ene:Schedule_Name> <ene:Hour_Ending>2011-04- 16T06:00:00.000Z</ene:Hour_Ending> <ene:NERC_Source_Name>Source</ene:NERC_Source_Name> <ene:Source_SL_Name>Source_SL</ene:Source_SL_Name> <ene:Source_Type>OBLIGATION</ene:Source_Type> <ene:Schedule_Source_MW>-100</ene:Schedule_Source_MW> <ene:NERC_Sink_Name>Sink</ene:NERC_Sink_Name> <ene:Sink_SL_Name>Sink_SL</ene:Sink_SL_Name> <ene:Sink_Type>OBLIGATION</ene:Sink_Type> <ene:Schedule_Sink_MW>100</ene:Schedule_Sink_MW> <ene:Loss_Source>NULL</ene:Loss_Source> <ene:Loss_Sink>NULL</ene:Loss_Sink> <ene:Service_Type>NW</ene:Service_Type> <ene:DCA>NULL</ene:DCA> <ene:Loss_MW>0</ene:Loss_MW> <ene:Transaction_Type>IMP</ene:Transaction_Type> <ene:Market_Flag>1</ene:Market_Flag> <ene:Modified_Time>2011-04-17T07:42:29.637Z</ene:Modified_Time> <ene:Schedule_Type>Energy</ene:Schedule_Type> </ene:ETSSchedule> </ene:ETS_EnergySchedules> <ene:ETS_ReservationDetails> <ene:ETSReservation> <ene:Schedule_Name>ScheduleName</ene:Schedule_Name> <ene:Hour_Ending>2011-04-16T06:00:00.000Z</ene:Hour_Ending> <ene:TAIndex>2</ene:TAIndex> <ene:PSE>PSE</ene:PSE> <ene:NERC_Source_Name>Source</ene:NERC_Source_Name> <ene:NERC_Sink_Name>Sink</ene:NERC_Sink_Name> <ene:OASISNumber>12345678</ene:OASISNumber> <ene:POR>POR</ene:POR> <ene:POD>POD</ene:POD> <ene:MW_Used>100</ene:MW_Used> <ene:Provider>SWPP</ene:Provider> <ene:Modified_Time>2011-04-17T07:44:05.333Z</ene:Modified_Time> </ene:ETSReservation> </ene:ETS_ReservationDetails> </ene:SingleSchedule> </ene:EnergySchedules>

NOTE: See Appendix A - Energy_Schedules for data dictionary information


5.4 Integrated Schedules and Non-Integrated Schedules The Integrated Schedules Service defines the operations that are used to exchange schedule and reservation data between SPP and outside entities. The web services and message content are described in the files listed in the table below. NOTE: Curtailment data is included in the returned query result set. There will not be any data returned in that section of the response without SPP staff manipulating the ITE environment. For testing purposes SPP will need to schedule a testing date to test curtailments.

Filename Namespace

https://api.itespp.org/Integrated_Schedules_Data?wsdl https://api.itespp.org/Integrated_Schedules_Data

https://api.itespp.org/NonIntegrated_Schedules_Data?wsdl https://api.itespp.org/NonIntegrated_Schedules_Data


Diagram: Integrated Schedules

Diagram: Non-Integrated Schedules







https://api.itespp.org/Integrated_Schedules_Data?wsdl�

https://api.itespp.org/NonIntegrated_Schedules_Data?wsdl�



<int:Request xmlns:int="https://api.spp.org/Integrated_Schedules_Data"> <int:StartDate>2011-05-01T14:00:00Z</int:StartDate> <int:StopDate>2011-05-28T15:00:00Z</int:StopDate> </int:Request> <non:Request xmlns:non="https://api.spp.org/NonIntegrated_Schedules_Data"> <non:StartDate>2011-05-01T14:00:00.000Z</non:StartDate> <non:StopDate>2011-05-28T15:00:00.000Z</non:StopDate> </non:Request> NOTE: These are separate query requests and cannot be combined into a single request.

5.4.1.3 Data Returned Response Elements Integrated Schedules <int:Integrated_Schedules xmlns:int="https://api.spp.org/Integrated_Schedules_Data"> <int:SingleSchedule> <int:Schedules> <int:Schedule> <int:Schedule_Id>123456</int:Schedule_Id> <int:Schedule_Name>ScheduleName</int:Schedule_Name> <int:ScheduleOwner>Owner</int:ScheduleOwner> <int:Source_CA>Source_CA</int:Source_CA> <int:Sink_CA>Sink_CA</int:Sink_CA> <int:PSE>PSE</int:PSE> <int:Source>Source</int:Source> <int:Sink>Sink</int:Sink> <int:Schedule_Type>Energy</int:Schedule_Type> <int:Schedule_SubType>0</int:Schedule_SubType> <int:Time_Zone_Name>CS</int:Time_Zone_Name> <int:Schedule_Status>INACTIVE</int:Schedule_Status> <int:Schedule_Start>2011-05-01T05:00:00.000Z</int:Schedule_Start> <int:Schedule_End>2011-05-02T05:00:00.000Z</int:Schedule_End> <int:Time_Of_Last_Update>2011-04-19T16:10:00.137Z</int:Time_Of_Last_Update> </int:Schedule> </int:Schedules> <int:ScheduleProfiles> <int:ScheduleProfile> <int:Schedule_Id>123456</int:Schedule_Id> <int:Profile_Id>1</int:Profile_Id> <int:Date_Time>2011-05-01T05:00:00.000Z</int:Date_Time> <int:MW>0</int:MW> <int:RampStart>1900-01-01T06:00:00.000Z</int:RampStart> <int:RampDuration>NULL</int:RampDuration>


<int:Time_Of_Last_Update>2011-04-19T16:10:00.137Z</int:Time_Of_Last_Update> <int:MWImport>0</int:MWImport> <int:MWExport>NULL</int:MWExport> </int:ScheduleProfile> </int:ScheduleProfiles> <int:ScheduleReservations> <int:ScheduleReservation> <int:Schedule_Id>123456</int:Schedule_Id> <int:Reservation_Id>1</int:Reservation_Id> <int:Provider>SWPP</int:Provider> <int:Assignment_Ref>87654321</int:Assignment_Ref> <int:POR>POR</int:POR> <int:POD>POD</int:POD> <int:PSE>PSE</int:PSE> <int:ProductCode>7</int:ProductCode> <int:Time_Of_Last_Update>2011-04-19T16:10:00.150Z</int:Time_Of_Last_Update> </int:ScheduleReservation> </int:ScheduleReservations> <int:ScheduleReservationProfiles> <int:ScheduleReservationProfile> <int:Schedule_Id>123456</int:Schedule_Id> <int:Reservation_Id>1</int:Reservation_Id> <int:Start_Time>2011-05-01T09:00:00.000Z</int:Start_Time> <int:Stop_Time>2011-05-01T09:10:00.000Z</int:Stop_Time> <int:MW_Used>20</int:MW_Used> <int:Time_Of_Last_Update>2011-04-19T16:10:00.150Z</int:Time_Of_Last_Update> </int:ScheduleReservationProfile> </int:ScheduleReservationProfiles> <int:SchedulePSEs> <int:SchedulePSE> <int:Schedule_Id>123456</int:Schedule_Id> <int:Schedule_Name>ScheduleName</int:Schedule_Name> <int:GCA>GCA</int:GCA> <int:LCA>LCA</int:LCA> <int:Source_PSE>Source_PSE</int:Source_PSE> <int:Sink_PSE>Sink_PSE</int:Sink_PSE> <int:Schedule_Date>2011-05-01T06:00:00.000Z</int:Schedule_Date> <int:Time_Of_Last_Update>2011-04-19T16:10:00.150Z</int:Time_Of_Last_Update> </int:SchedulePSE> </int:SchedulePSEs> <int:Curtailments> <int:Curtailment> <int:Schedule_Id>123456</int:Schedule_Id> <int:FlowGate>FG1234, FG2345, FG3456, FG4567, FG5678, FG6789</int:FlowGate> <int:Start>2011-03-29T18:15:00.000Z</int:Start> <int:Stop>2011-03-29T18:30:00.000Z</int:Stop> <int:MW>25</int:MW> <int:Source>Source</int:Source> <int:Time_Of_Last_Update>2011-04-


19T16:10:00.723Z</int:Time_Of_Last_Update> </int:Curtailment> </int:Curtailments> </int:SingleSchedule> </int:Integrated_Schedules> Non-Integrated Schedules <int:NonIntegrated_Schedules xmlns:int="https://api.spp.org/NonIntegrated_Schedules_Data"> <int:SingleSchedule> <int:Schedules> <int:Schedule> <int:Schedule_Id>123456</int:Schedule_Id> <int:Schedule_Name>ScheduleName</int:Schedule_Name> <int:ScheduleOwner>Owner</int:ScheduleOwner> <int:Source_CA>Source_CA</int:Source_CA> <int:Sink_CA>Sink_CA</int:Sink_CA> <int:PSE>PSE</int:PSE> <int:Source>Source</int:Source> <int:Sink>Sink</int:Sink> <int:Schedule_Type>Energy</int:Schedule_Type> <int:Schedule_SubType>0</int:Schedule_SubType> <int:Time_Zone_Name>CS</int:Time_Zone_Name> <int:Schedule_Status>INACTIVE</int:Schedule_Status> <int:Schedule_Start>2011-05-01T05:00:00.000Z</int:Schedule_Start> <int:Schedule_End>2011-05-02T05:00:00.000Z</int:Schedule_End> <int:Time_Of_Last_Update>2011-04-19T16:10:00.137Z</int:Time_Of_Last_Update> </int:Schedule> </int:Schedules> <int:ScheduleProfiles> <int:ScheduleProfile> <int:Schedule_Id>123456</int:Schedule_Id> <int:Profile_Id>1</int:Profile_Id> <int:Date_Time>2011-05-01T05:00:00.000Z</int:Date_Time> <int:MW>0</int:MW> <int:RampStart>1900-01-01T06:00:00.000Z</int:RampStart> <int:RampDuration>NULL</int:RampDuration> <int:Time_Of_Last_Update>2011-04-19T16:10:00.137Z</int:Time_Of_Last_Update> <int:MWImport>0</int:MWImport> <int:MWExport>0</int:MWExport> </int:ScheduleProfile> </int:ScheduleProfiles> <int:ScheduleReservations> <int:ScheduleReservation> <int:Schedule_Id>123456</int:Schedule_Id> <int:Reservation_Id>1</int:Reservation_Id> <int:Provider>SWPP</int:Provider> <int:Assignment_Ref>74255827</int:Assignment_Ref> <int:POR>POR</int:POR> <int:POD>POD</int:POD>


<int:PSE>PSE</int:PSE> <int:ProductCode>7</int:ProductCode> <int:Time_Of_Last_Update>2011-04-19T16:10:00.150Z</int:Time_Of_Last_Update> </int:ScheduleReservation> </int:ScheduleReservations> <int:ScheduleReservationProfiles> <int:ScheduleReservationProfile> <int:Schedule_Id>123456</int:Schedule_Id> <int:Reservation_Id>1</int:Reservation_Id> <int:Start_Time>2011-05-01T09:00:00.000Z</int:Start_Time> <int:Stop_Time>2011-05-01T09:10:00.000Z</int:Stop_Time> <int:MW_Used>20</int:MW_Used> <int:Time_Of_Last_Update>2011-04-19T16:10:00.150Z</int:Time_Of_Last_Update> </int:ScheduleReservationProfile> </int:ScheduleReservationProfiles> <int:SchedulePSEs> <int:SchedulePSE> <int:Schedule_Id>123456</int:Schedule_Id> <int:Schedule_Name>ScheduleName</int:Schedule_Name> <int:GCA>GCA</int:GCA> <int:LCA>LCA</int:LCA> <int:Source_PSE>Source_PSE</int:Source_PSE> <int:Sink_PSE>Sink_PSE</int:Sink_PSE> <int:Schedule_Date>2011-05-01T06:00:00.000Z</int:Schedule_Date> <int:Time_Of_Last_Update>2011-04-19T16:10:00.150Z</int:Time_Of_Last_Update> </int:SchedulePSE> </int:SchedulePSEs> <int:Curtailments> <int:Curtailment> <int:Schedule_Id>123456</int:Schedule_Id> <int:FlowGate>FG1234, FG2345, FG3456, FG4567, FG5678, FG6789</int:FlowGate> <int:Start>2011-03-29T18:15:00.000Z</int:Start> <int:Stop>2011-03-29T18:30:00.000Z</int:Stop> <int:MW>25</int:MW> <int:Source>Source</int:Source> <int:Time_Of_Last_Update>2011-04-19T16:10:00.723Z</int:Time_Of_Last_Update> </int:Curtailment> </int:Curtailments> </int:SingleSchedule> </int:NonIntegrated_Schedules>

NOTE: See Appendix A - Single Schedules (Integrated and Non-Integrated) for data dictionary information


5.5 LIP_Data The LIP Data Service defines the operations that are used to exchange Location Imbalance Prices between SPP and outside entities. The web services and message content are described in the files listed in the table below.

Filename Namespace

https://api.itespp.org/LIP_Data?wsdl https://api.itespp.org/LIP_Data




No No RequestDate Date yyyy-mm-dd

The desired date. Future dates will return nothing as will past dates that have rolled off the archive systems.

No No PNodeName varChar(64) The PNodeName for desired LIP prices. Each PNodeName will need to a separate request submitted.


<lip:Request xmlns:lip="https://api.spp.org/LIP_Data"> <lip:RequestDate>2011-05-25</lip:RequestDate> <lip:PNodeName>PNODEASDFPLT1</lip:PNodeName> </lip:Request>


https://api.itespp.org/LIP_Data?wsdl�


<lip:LIP_Data xmlns:lip="https://api.spp.org/LIP_Data"> <lip:Row> <lip:HourEnding>2011-05-25T06:00:00.000Z</lip:HourEnding> <lip:PNODE>PNODEASDFPLT1</lip:PNODE> <lip:LIP>25.67</lip:LIP> <lip:ParentPNODE/> <lip:SettlementLocation/> </lip:Row> </lip:LIP_Data>

NOTE: See Appendix A - LIP Data for data dictionary information


5.6 Loss Location Data The Loss Location Data Service defines the operations that are used to exchange Loss by Location data between SPP and outside entities. The web services and message content are described in the files listed in the table below.

Filename Namespace

https://api.itespp.org/Loss_Location_Data?wsdl https://api.itespp.org/Loss_Location_Data









<loss:Request xmlns:loss="https://api.spp.org/Loss_Location_Data"> <loss:StartDate>2011-05-25T00:00:00.000-06:00</loss:StartDate> <loss:StopDate>2011-05-25T08:00:00.000-06:00</loss:StopDate> </loss:Request>


https://api.itespp.org/Loss_Location_Data?wsdl�


<loss:Loss_Data xmlns:loss="https://api.spp.org/Loss_Location_Data"> <loss:Row> <loss:HourEnding>2011-05-01T11:00:00.000Z</loss:HourEnding> <loss:DCA>DCA</loss:DCA> <loss:MW_SUM>0</loss:MW_SUM> </loss:Row> </loss:Loss_Data>

NOTE: See Appendix A - Loss by Location for data dictionary information


5.7 Meter Data The Meter Data Service defines the operations that are used to exchange Meter data between SPP and outside entities. The web services and message content are described in the files listed in the table below.

Filename Namespace

https://api.itespp.org/Meter_Data?wsdl https://api.itespp.org/Meter_Data









<met:Request xmlns:met="https://api.spp.org/Meter_Data"> <met:StartDate>2011-05-25T06:00:00.000Z</met:StartDate> <met:StopDate>2011-05-25T08:00:00.000Z</met:StopDate> </met:Request>


https://api.itespp.org/Meter_Data?wsdl�


<met:Meter_Data xmlns:met="https://api.spp.org/Meter_Data"> <met:Row> <met:Recorder>Recorder_SettlementLocation</met:Recorder> <met:Channel>1</met:Channel> <met:StartTime>2011-06-01T06:00:00.000Z</met:StartTime> <met:StopTime>201-06-02T05:59:59.000Z</met:StopTime> <met:DSTParticipant>N</met:DSTParticipant> <met:ValidationRequired>N</met:ValidationRequired> <met:PulseMultiplier>1</met:PulseMultiplier> <met:PulseOffset>0</met:PulseOffset> <met:SPI>3600</met:SPI> <met:UOM>44</met:UOM> <met:Timezone>12</met:Timezone> <met:TimezoneStandardName>CST</met:TimezoneStandardName> <met:Timestamp>2011-06-03T16:22:52.000Z</met:Timestamp> <met:Origin>M</met:Origin> <met:Descriptor>1-1224V</met:Descriptor> <met:Value>56.428</met:Value> <met:Status>E</met:Status> <met:OperatingDate>2011-06-01T06:00:00.000Z</met:OperatingDate> </met:Row> </met:Meter_Data>

NOTE: See Appendix A - Meters for data dictionary information


5.8 RSS Data The RSS Data Service defines the operations that are used to exchange Reserve Sharing Data between SPP and outside entities. The web services and message content are described in the files listed in the table below.

Filename Namespace

https://api.itespp.org/RSS_Data?wsdl https://api.itespp.org/RSS_Data









<rss:Request xmlns:rss="https://api.spp.org/RSS_Data"> <rss:StartDate>2011-05-15T00:00:00.000Z</rss:StartDate> <rss:StopDate>2011-06-01T00:00:00.000Z</rss:StopDate> </rss:Request>


https://api.itespp.org/RSS_Data?wsdl�


<rss:RSS_Event xmlns:rss="https://api.spp.org/RSS_Data"> <rss:Event> <rss:EventId>1234</rss:EventId> <rss:CallingCompanyName>ABCD</rss:CallingCompanyName> <rss:FacilityName>ABCDGen1</rss:FacilityName> <rss:EventStartTime>2011-03-17T15:55:36.000Z</rss:EventStartTime> <rss:EventStopTime>2011-03-17T16:30:00.000Z</rss:EventStopTime> <rss:EventMW>525</rss:EventMW> <rss:EventReserveLost>0</rss:EventReserveLost> <rss:TimeOfLastUpdate>2011-03-18T07:33:01.000Z</rss:TimeOfLastUpdate> </rss:Event> <rss:EventAssistance> <rss:EventId>1234</rss:EventId> <rss:AssistanceSource>ABCD</rss:AssistanceSource> <rss:AssistanceSink>CDBA</rss:AssistanceSink> <rss:AssistanceMW>15</rss:AssistanceMW> <rss:AssistanceFirstHourMW>13</rss:AssistanceFirstHourMW> <rss:AssistanceSecondHourMW>0</rss:AssistanceSecondHourMW> </rss:EventAssistance> <rss:EventReservation> <rss:EventId>1234</rss:EventId> <rss:ReservationAssignmentRef>NULL</rss:ReservationAssignmentRef> <rss:ReservationPOR>SWPP</rss:ReservationPOR> <rss:ReservationPOD>EFGH</rss:ReservationPOD> <rss:ReservationSource>ABCD</rss:ReservationSource> <rss:ReservationSink>EFGH</rss:ReservationSink> <rss:ReservationMW>4</rss:ReservationMW> <rss:ReservationStartTime>2011-03-22T00:00:00.000Z</rss:ReservationStartTime> <rss:ReservationStopTime>2011-03-22T02:00:00.000Z</rss:ReservationStopTime> </rss:EventReservation> </rss:RSS_Event>

NOTE: See Appendix A - RSS for data dictionary information


5.9 SLIP Data The SLIP Data Service defines the operations that are used to exchange Substitute Location Imbalance Prices between SPP and outside entities. The web services and message content are described in the files listed in the table below.

Filename Namespace

https://api.itespp.org/SLIP_Data?wsdl https://api.itespp.org/SLIP_Data









<slip:Request xmlns:slip="https://api.spp.org/SLIP_Data"> <slip:StartDate>2010-01-01T06:00:00.000Z</slip:StartDate> <slip:StopDate>2011-06-30T00:00:00.000-06:00</slip:StopDate> </slip:Request>


https://api.itespp.org/SLIP_Data?wsdl�


<slip:SLIP_Data xmlns:slip="https://api.spp.org/SLIP_Data"> <slip:Row> <slip:HourEnding>2010-01-02T11:00:00.000Z</slip:HourEnding> <slip:SettlementLocation>SettlementLocation</slip:SettlementLocation> <slip:LMP>25.67</slip:LMP> </slip:Row> </slip:SLIP_Data>

NOTE: See SLIP Data for data dictionary information


Appendix A. Appendices A.1 Appendix A – Data Dictionary

A.1.1 Single Schedules (Integrated and Non-Integrated) Schedules Field Name Data Type Description Schedule_Id Integer Schedule index Schedule_Name Character (30) Schedule name Schedule Owner Character (4) Entity from which this schedule is

perceived Source_CA Character (4) GCA Sink_CA Character (4) LCA PSE Character (6) PSE Source Character (30) GP, if GP null then GCA Sink Character(30) LSE, if LSE null then LCA Schedule_Type Character (16) “Energy”, “Dynamic”, “Loss”,

“Capacity”, “Res Share”, “Payback”, “MRD”, “SRD”, “Energy/Cap”, “NLPS”, “NITS”, “NLPRA”, NLPRM”, “Resource”, “Outage”, “Energy Imbalance”

Schedule Subtype Integer A custom Schedule Type sub classification created by the custom on RTO_SS

Time_Zone_Name Character (2) Always CS Schedule_Status Character (12) “Approved”, “Active”, “Rejected”,

“Proposed”.”Excluded” Schedule_Start Datetime Starting time of the schedule in CST Schedule_End Datetime Ending time of the schedule in CST Time_Of_Last_Update Datetime Date/Time of the receiving WebData

server when the record was updated

ScheduleProfiles Field Name Data Type Description Schedule_Id Integer Schedule index Profile_Id Integer Profile index Date_Time Datetime Starting time for the profile for each

hourMWHR Integer Actual Megawatt RampStart Datetime Date/Time at the start of the rampRampDuration Tinyint Number of minutes of the rampTime_Of_Last_Update Datetime Date/Time of the receiving WebData

server when the record was updatedMWImport Integer MW import for the hour shownMWExport Integer MW export for the hour shown


ScheduleReservations Field Name Data Type Description Schedule_Id Integer Schedule index Reservation_Id Integer Reservation index Provider Character (4) Transmission provider Assignment_Ref Character (20) Assignment Reference No. (OASIS

Reservation No.) POR Character (12) PORPOD Character (12) PODPSE Character (6) PSEProductCode Tinyint Nerc Priority Time_Of_Last_Update Datetime Date/Time of the receiving WebData


ScheduleReservationProfiles Field Name Data Type Description Schedule_Id Integer Schedule index Reservation_Id Integer Reservation index Start_Time Datetime Starting time of the

ReservationProfile in CST, for each hour

Stop_Time Datetime Ending time of the ReservationProfile in CST, for each hour

MW_Used Integer MW used in the ScheduleProfileTime_Of_Last_Update Datetime Date/Time of the receiving WebData


SchedulePSEs Field Name Data Type Description Schedule_Id Integer Schedule index Schedule_Name Character (30) Schedule name GCA Character (4) Generating Control Area LCA Character (4) Load Control Area Source_PSE Character (6) Source PSE Sink_PSE Character (6) Sink PSE Schedule_Date Datetime Date of the Schedule Time_Of_Last_Update Datetime Date/Time of the receiving WebData


Curtailments Field Name Data Type Description Schedule_Id Integer Schedule index Start Datetime Starting time for the profile in CSTStop Datetime Stop time for the profile in CSTMW Integer Instantaneous MW amountSource Character(3) System curtailment sourced from

(IDC, CAT, CME) Time_Of_last_Update Datetime Date/Time of the receiving WebData



A.1.2 Calibrations Field Name Data Type Description Settlement_Area Varchar2(100) Settlement Area or Control AreaOperating_Date Date This is the Operating Date that

happen in the past Settlement_Type Varchar2(100) Initial, Final, or ResettlementDet_Typ_Nm Varchar2(100) This is where all of the different

types of determinants are Valid Values: Total Resource Meter Data Profile Calibration Factor Interchange Meter Data Total Substituted Resource Meter Data Loss Schedule Total Actual Load Meter Data Total Load Meter Data Net Area Input Load Calibration Amount Actual Calibration Factor Total Actual Resource Meter Data Total Profiled Load Meter Data

Int_Val Integer IntervalVal Number Meter Actual MWH volume for the

interval hour

A.1.3 Meters Field Name Data Type Description Recorder Varchar2(100) Settlement Location Channel Integer Actual Meter Data. It is always set

to channel 1 StartTime Varchar2(50) Day and start time of meter data.

Format as YYYY-MM-DDT00:00:00, start of the operating day being metered.

StopTime Varchar2(50) Day and stop time of meter data. Format as YYYY-MM-DDT23:59:59, end of the operating day being metered.

Dst_Participant Varchar2(1) Daylight savings participant flag, default is N, if participating the Flag is set to Y.

Validation_Required Varchar2(1) Validation required flag, always set to N.

Pulse_Multiplier Integer Always set to 1. Pulse_Offset Integer Always set to 0. Spi Integer Seconds per interval defined by the

Market Protocols. At market start this value will be 3600.

UOM Integer Unit of measure always set to 44 for mega watt.

Timezone Integer Default setting is CST Time_Zone_Standard_Name Varchar2(50) Abbreviation for the time zone that


Field Name Data Type Description is used for the input data.

Timestmp Varchar2(50) The portal will append a timestamp to the meter file name to make sure each file name is unique. Format as YYYY-MM-DDTHH:MM:SS

Origin Varchar2(1) "M" for Metered. "P" for Profiled. "C" for computed.

Descriptr Varchar2(50) Siebel tag that Portal adds to all XML files

Value Number Meter Actual MWH volume for the interval hour

Status Varchar2(50) Status of the interval. An empty field or a status of ‘A’ indicates actual meter data for that interval. “E” in the field indicates that the interval was estimated. “9” in the field indicates a missing interval, value will be set to zero regardless of value for the interval.

Pstart Varchar2(50) Date and time of the interval start

A.1.4 Energy_Schedules Schedules Field Name Data Type Description Schedule_Name Character (30) Schedule name Hour_Ending Datetime Hour ending for this record in CSTNERC_Source_Name Varchar (30) NERC Source Name Source_SL_Name Varchar (32) Source settlement locationSource_Type Varchar (10) ‘OBLIGATION’ or ‘RESOURCE’Schedule_Source_MW Integer Power in MW, negative if the

Source_Type is ‘OBLIGATION’NERC_Sink_Name Varchar (30) NERC Sink Name Sink_SL_Name Character Sink settlement location Sink_Type Varchar (10) ‘OBLIGATION’ or ‘RESOURCE’Schedule_Sink_MW Integer Power in MW, negative if the

Sink_Type is ‘RESOURCE’Loss_Source Varchar(30) The Oasis source (or POR) that

RTO_SS used during Loss Validation to look up the loss percentage in the SPP loss matrix.

Loss_Sink Varchar(30) The Oasis sink (or POD) that RTO_SS used during Loss Validation to look up the loss percentage in the SPP loss matrix.

Service_Type Varchar(4) Indicates if the transmission type is Point-to-Point service or Network service. Values: ‘P2P’ and ‘NW’.

DCA Varchar (32) Designated Control Area; the Control Area holding losses

Loss_MW Integer Number of losses indicated in the transaction.

Transaction_Type Character (3) Transaction type in relation to the


Field Name Data Type Description SPP market footprint (Import, Export, Wheel or Internal). Values: 'IMP', 'EXP', 'WHL', 'INT'

Market_Flag Bit Indicates the Schedule touches the SPP Market footprint; can be either a Source, sink, or wheel through the market

Modified_Time_CS Datetime Last modified time of the scheduleSchedule_Type Varchar (16) “Energy”, “Dynamic”, “Loss”,

“Capacity”, “Res Share”, “Payback”, “MRD”, “SRD”, “Energy/Cap”, “NLPS”, "NITS", "NLPRA", "NLPRM" “Resource”, “Outage”, “Energy Imbalance”

Reservations Field Name Data Type Description Schedule_Name Character (30) Schedule name Hour_Ending Datetime Hour ending for this record in CSTTAIndex Integer Counter for multiple reservations on

a single schedule. In combination with Schedule_Name and Hour_Ending is used as primary key.

PSE varchar (6) Transmission Customer NERC_Source_Name varchar (32) NERC Source Name NERC_Sink_Name varchar (32) NERC Sink Name OASISNumber varchar (30) Reservation Number POR varchar (30) Point of Receipt POD varchar (30) Point of Delivery MW_Used Integer MWs allocated to that Oasis requestProvider char (4) Transmission Provider Modified_Time_CS Datetime Last modified time of the schedule

A.1.5 Loss by Location Field Name Data Type Description Hour_Ending datetime Hour_Ending in CST DCA varchar (32) Settlement Loss Location holding

lossessum(Loss_MW) Integer sum of Loss_MW grouped by

Hour_Ending and DCA

A.1.6 RSS Event Field Name Data Type Description EventId Integer Event ID from RSS CallingCompanyname Character (4) BA Name that called the EventFacilityName Character (30) Tripped Facility Name, Other

Extreme Condition, or Loss of


ScheduleStartTime DateTime Event Start Time StopTime DateTime Event Stop Time MW Integer MW amount of Event ReserveLost Integer Reserve MW amount lost of eventTimeOfLastUpdate DateTime Last Update Time of the Event

EventAssistance Field Name Data Type Description EventId Integer Event ID from RSS Source Character (4) Source BA (Assisting BA) Sink Character (4) Sink BA (Contingent BA) MW Integer MW amount of assistance FirstHourMWHR Integer integrated MW amount for the first

hour of the event SecondHourMWHR Integer integrated MW amount for the

second hour of the event

EventReservation Field Name Data Type Description EventId Integer Event ID from RSS AssignmentRef Character (20) Oasis Request Number for the

assistance POR Character (12) Point of Receipt POD Character (12) Point of Delivery Source Character (14) Source on Reservation Sink Character (14) Sink on Reservation MW Integer MW Amount of Reservation StartTime DateTime Start Time of Reservation StopTime DateTime Stop Time of Reservation

A.1.7 Commercial Model (NERC Translation) Field Name Data Type Description Nerc_Src_Sink Character (32) TSIN Source Sink Name Entity_Type Character (2) (SE or LE) Determines whether or

not the Source/Sink is listed as Resource or Obligation on the ETS Energy Schedule Combined table. If SE, RESOURCE. If LE, OBLIGATION.

Start_Time Datetime The start time of the relationship mapping of the TSIN Source/Sink to a settlementloc and mosid.

Stop_Time Datetime The stop time of the relationship mapping of the TSIN Source/Sink to a settlementloc and mosid.

ControlArea Character(4) The BA name the TSIN Source Sink is registered to.

settlementloc Character(64) Mapped settlement location for the


Field Name Data Type Description TSIN Source Sink.

pse Character(6) PSE assigned to the Source Sink in the TSIN registry.

mosid Character(30) Mapped pnode or mosid for the TSIN Source Sink.

A.1.8 LIP Data Field Name Data Type Description HourEnding DateTime Hour Ending

PNode Character (64) Pricing Node LIP Decimal Location Imbalance Price

A.1.9 SLIP Data Field Name Data Type Description HourEnding DateTime Hour Ending SettlementLocation Character (64) Settlement Location LMP Decimal Substituted LIP

Documents

Data API Data Exchange Guide - Southwest Power Pool api data exchange guide v1.1.pdf3 Data API Data Exchange Guide Data Type Description dateTime1 Date time. The general format is