GetStatus Method

A client who has submitted a transaction file to MarketSuiteTM via the inbound aspects of ISO Scheduling API may obtain the status of all transactions submitted within that file via the GetStatus method. When a client submits a file to MarketSuiteTM a string representing the file unique identifier (GUID) is returned. This unique identifier is then provided in the GetStatus webservice message and MarketSuiteTM will respond by echoing back the data submitted along with the addition of a ‘Status’ and ‘Message’ if applicable.

The GetStatus method only reports the status of data that was submitted by the file. If some rows are replaced via subsequent API files, via the APX Scheduling User Interface, or via the ISO portal, the status of the row will show as “APXObsolete”, “Obsolete”, or “Canceled” depending on the Region, what was changed or deleted, and whether the transaction was previously sent to the ISO or not.

The <FileStatus> attribute is used to convey the file level status in response to a GetStatus request.

Status	Description
File does not exist	Request does not contains file_handle that does not exist in the APX MarketSuiteTM
File load in progress	File still being processed by the APX MarketSuiteTM
File loaded into system, records successfully retrieved	File is done being processed by the APX MarketSuiteTM
File loaded into system, no records found	File is done being processed by the APX MarketSuiteTM but there is no data in our system that match that file_handle*
Error in processing file	There was some problem processing this file to the APX MarketSuiteTM. If you receive this FileStatus please call APX Market Operations

GetStatus responses return data for each interval between FirstIntervalBegin and LastIntervalEnd for each business key submitted in the APX Scheduling API file. Notice in the below example that the file only has FromInterval=”1” even though the bid is good for all 24 hourly intervals between FirstIntervalBegin and LastIntervalEnd, but in the GetStatus response all intervals are provided explicitly.

For the MRTU Region, when the ISO status of a transaction is Modified or CondModified, it’s important to note that the data returned via GetStatus is the data that was originally submitted, not the data that was modified by the ISO. To get the modified data, use GetScheduleData.

See the REST API section of the portal for details on the structure of the GetStatus method within the FRUploadService section.

GetScheduleData Method

The GetScheduleData method allows a client to request a complete image of their scheduling data including status (APX image or ISO image at market close) or their market results including MW and the applicable market clearing price. These requests are made using the input parameters described in the table below.

See the REST API section of the portal for details on the structure of the GetScheduleData method within the FRUploadService section. Note that the paramsXML parameter is validated against the APXParameterSet.xsd.

Fields	Options	Optional(O) or Mandatory(M)	Notes
Region	Any single valid Region (i.e. ‘TX’)	M	Options defined in XSD
MarketParticipant	Any single valid market participant code (i.e. QAPX)	M
MarketStage	Any single valid market stage (i.e. ‘DA’)	M	Options defined in XSD Note that resource parameter data is not associated with a specific market stage will be returned regardless of market stage
MarketStatus	‘Pre’ or ‘Post’ or ‘Awards’	M	‘Pre’ returns the APX image ‘Post’ returns the ISO image at market close ‘Awards’ returns the ISO market results ‘Post’ is not applicable for resource parameter data ‘Awards’ is not applicable for resource parameter or bilateral schedule data
FirstIntervalBegin	First interval begin in GMT	M
LastIntervalEnd	Last interval end in GMT	M
Application	One or more. Options are ‘BidsOffers’, ‘BilateralSchedule’, ‘ResourceParameters	M	‘ResourceParameters’ is non-applicable if MarketStatus = ‘Post’ or ‘Awards’
ExternalId	One or more ExternalIds	O	This field acts as a filter on the results that will be returned. If no ExternalId(s) are supplied then all results that match the other parameters will be returned. ExternalIDs are assigned by the client when submitting to the API. Not applicable when Market Status = ‘Post’ or ‘Awards’ Not applicable for resource parameter data
DataSource	One or more. Options are ‘API’, ‘DA’, ‘DART’,‘ISO’, and ‘UI' "SASM'*"	O	This field acts as a filter on the results that will be returned. If no DataSource(s) are supplied all results that match the other parameters will be returned. ‘API’ returns data submitted to the APX MarketSuiteTM via the Scheduling API ‘DA’ returns data that is auto-copied from DA to another market stage by the APX MarketSuiteTM ‘ISO’ returns data that was pulled into the APX MarketSuiteTM from an ISO system ‘UI’ returns data entered into the APX MarketSuiteTM web-based user interface Not applicable when MarketStatus = ‘Post’ or ‘Awards’

*RTC+B - With the implementation of the RTC+B market change, ERCOT grandfathered the Supplementary Ancillary Service Markets (SASMs: SASM, SASM1…SASM9). Thus, in support of the RTC+B market change, the APX MarketSuite will not allow upload of the SASM bidOffers past December 2025

GetScheduleData paramsXML example (See REST APIs section of the portal for details):

Copy

Copied

<?xml version="1.0" encoding="utf-16"?>
<ParameterSet xmlns="http://service.apx.com/ParameterSet">
    <Region>TX</Region>
    <MarketParticipant>QSE1</MarketParticipant>
    <MarketStage>DART</MarketStage>
    <MarketStatus>PRE</MarketStatus>
    <FirstIntervalBegin>2010-06-05T00:00:00-05:00</FirstIntervalBegin>
    <LastIntervalEnd>2010-06-06T00:00:00-05:00</LastIntervalEnd>
    <Applications>
        <Application>BidsOffers</Application>
        <Application>BilateralSchedule</Application>
        <Application>ResourceParameters</Application>
    </Applications>
    <ExternalIds>
        <ExternalId>xyz</ExternalId>
        <ExternalId>123</ExternalId>
    </ExternalIds>
    <DataSources>
        <DataSource>API</DataSource>
    </DataSources>
</ParameterSet>

GetScheduleData Notes:

GetScheduleData responses will be formatted identically to GetStatus responses with the following exceptions:
- The FileStatus attribute will not be present in the file
- For responses where MarkestStatus=”Awards” then Market Clearing prices (MCPs) will be poplutated in the Price attribute of the <CurvePoint > element for <MarketSchedule > data and the <Schedule > element for <SelfSchedule > data
- <Status > and <Message > attributes are not used in GetSchedulteData responses when MarketStatus is ‘Post’ or ‘Awards’
The input parameters of MarketStatus, Application, and DataSource are NOT part of the APXScheduleAPI.xsd and are NOT provided in GetScheduleData responses