The identity and technical contract details declared by the specification.
empty
string
Intended to proactively avoid information disclosure
problem
object
See [RFC9457](https://www.rfc-editor.org/rfc/rfc9457appendix-A).
5 properties
1 required
period-start
string
RFC 3339 date-time string with no fractional seconds component that designates a start or end to an operating period (such as an hour) that starts at a specifi…
local
string
Contains a identifier that is unique for an object in the context of an exchange between two grid operators.
resource-id
string
Contains a unique identifier for a power system resource, such as a transmission facility, segment, interface, etc. This identifier is typically used between r…
entity
string
Contains a unique identifier for an entity, such as a grid operator or organization. This identifier is typically used in the context of data exchange between…
timestamp
string
RFC 3339 date-time string with a maximum of 10 digits in the fractional seconds component, i.e., nanosecond precision.
data-provenance
object
Provides information about where the associated representation came from. No functional aspects of the exchange are contingent upon this data. However, this in…
3 properties
2 required
emergency-durations
array
Defines the durations in minutes used for emergency limits.
limiting-analysis
string
Indicates how a operating limit was determined. This is used to provide context for the ratings proposals and limits snapshots. When defined in the header, thi…
name-type
string
Type of the name being referenced. Corresponds to the IEC CIM NameType concept.
names
object
2 properties
1 required
named-power-system-resources
array
Collection of power system resource names
forecast-snapshot-header
object
Details about the snapshot provided by the Clearinghouse provider.
5 properties
4 required
active-power
object
2 properties
1 required
active-power-with-power-factor
object
3 properties
2 required
apparent-power
object
2 properties
1 required
current
object
Representation of a thermal limit in amperes.
1 property
1 required
reactive-power
object
Representation of a limit in megavolt-amperes reactive (MVAR).
1 property
1 required
overvoltage-threshold-pu
object
An upper limit to voltage for a transmission facility in per unit with the base voltage assumed to be the nominal voltage.
1 property
1 required
overvoltage-threshold
object
An upper limit to voltage for a transmission facility in kilovolts.
1 property
1 required
undervoltage-threshold-pu
object
An lower limit to voltage for a transmission facility in per unit with the nominal voltage assumed to be the base voltage.
1 property
1 required
undervoltage-threshold
object
A lower limit to voltage for a transmission facility in kilovolts.
1 property
1 required
limit
object
Defines the limit. In practice most exchanges will only support one kind of limit for proposals and snapshots. However, the specification supports defining lim…
limit-value-set
array
A set of general limit or rating values, each mapped to the various limit bands defined by the Transmission Provider's operating manual. This typically consist…
forecast-snapshot
object
5 properties
4 required
forecast-limit-item
object
2 properties
2 required
forecast-limits-snapshot
object
A snapshot of the forecast for a monitoring set.
2 properties
2 required
forecast-snapshot-header-elide-psr
object
Details about the snapshot provided by the Clearinghouse provider. The power-system-resources property is omitted from this header.
4 properties
3 required
forecast-limits-snapshot-elide-psr
object
A snapshot of the forecast for a monitoring set.
2 properties
2 required
forecast-snapshot-slim-header
object
Details about the snapshot provided by the Clearinghouse provider.
6 properties
5 required
resource-forecast-proposal-slim
array
forecast-limits-snapshot-slim
object
A slim snapshot of the forecast for a monitoring set.
2 properties
2 required
resource-forecast-inputs
array
unit
string
If the value is dimensionless, this property should not be provided. Since we are not specifying which inputs shall be provided, we cannot specify a definitive…
forecast-limits-snapshot-slim-inputs-used
object
A slim snapshot of the forecast for a monitoring set, including the inputs that were used to determine the continuous limits.
3 properties
2 required
forecast-snapshot-detailed
object
6 properties
4 required
forecast-limit-item-detailed
object
2 properties
2 required
quality-class-current-source
string
This property is modeled after the Quality Class called "Current Source" in ICCP. It is used to indicate the source of the current value of the proposed rating…
input
object
3 properties
2 required
forecast-provenance
object
Details a proposal that was considered by the Clearinghouse run. If resource-id is not provided, the ratings data is assumed to be for the overall facility.
9 properties
5 required
proposals-considered
array
temporary-aar-exception-provenance
object
Data structure for a temporary AAR Exception against a resource. Includes a unique ID, start and (optional) end time, and a reason. May or may not include a se…
8 properties
4 required
temporary-aar-exceptions
array
operator-override-limit-provenance
object
Data structure for a temporary AAR Exception against a resource. Includes a unique ID, start and (optional) end time, and a reason. May or may not include a se…
8 properties
4 required
forecast-limits-detailed-snapshot
object
A detailed snapshot of the forecast for a monitoring set. These details are meant to support analysis, archival, and troubleshooting.
3 properties
3 required
forecast-limits-detailed-snapshot-elide-psr
object
A detailed snapshot of the forecast for a monitoring set. These details are meant to support analysis, archival, and troubleshooting.
3 properties
3 required
forecast-proposal-header
object
Populated by the Ratings Provider in a request to submit forecast ratings. The Clearinghouse implementation should record this information, and the detail limi…
5 properties
4 required
forecast-proposal
object
A Forecasted Period contains proposed limits for a power system object, e.g., a segment, that were forecasted for a particular Period in a Forecast Window. The…
7 properties
4 required
resource-forecast-proposal
object
2 properties
2 required
array-max-monitored-elements_forecast-proposal
object
2 properties
2 required
forecast-proposal-slim-header
object
Populated by the Ratings Provider in a request to submit forecast ratings. The Clearinghouse implementation should record this information, and the detail limi…
7 properties
5 required
forecast-proposal-slim
object
3 properties
2 required
forecast-proposal-status
object
Status of the rating provider's forecast proposal relative to the current forecast window. Includes any validation errors encountered while processing proposal…
6 properties
6 required
real-time-proposal-status
object
Status of the rating provider's real-time obligations. Includes any validation errors encountered while processing proposals.
5 properties
5 required
real-time-proposal-header
object
Populated by the Ratings Provider in a request to submit real-time ratings. The Clearinghouse implementation should record this information, and the detail lim…
4 properties
3 required
real-time-proposal
object
6 properties
3 required
realtime-proposal
object
3 properties
2 required
real-time-proposal-slim-header
object
Populated by the Ratings Provider in a request to submit real-time ratings. The Clearinghouse implementation should record this information, and the detail lim…
5 properties
3 required
realtime-proposal-slim
object
Used to propose real-time ratings for a set of resources.
3 properties
2 required
real-time-snapshot-header
object
Details about the snapshot provided by the Clearinghouse provider.
4 properties
3 required
realtime-snapshot
object
4 properties
3 required
realtime-limits-snapshot
object
A snapshot of the realtime limits for a monitoring set.
2 properties
2 required
real-time-snapshot-header-elide-psr
object
Details about the snapshot provided by the Clearinghouse provider.
3 properties
2 required
realtime-limits-snapshot-elide-psr
object
A snapshot of the realtime limits for a monitoring set.
2 properties
2 required
realtime-snapshot-detailed
object
5 properties
3 required
real-time-provenance
object
7 properties
4 required
realtime-limits-detailed-snapshot
object
A snapshot of the realtime limits for a monitoring set.
3 properties
3 required
realtime-limits-detailed-snapshot-elide-psr
object
A snapshot of the realtime limits for a monitoring set.
3 properties
3 required
realtime-limits-snapshot-slim
object
A slim snapshot of the realtime limits for a monitoring set.
2 properties
2 required
realtime-limits-snapshot-slim-inputs-used
object
A slim snapshot of the realtime limits for a monitoring set, including the inputs used to determine the continuous limits.
3 properties
3 required
common-header
object
4 properties
3 required
season-name
string
A name for the season
day-night
string
Optional label to specify if the proposed seasonal ratings schedule is meant to be used only during the day or only a night. If this field is not provided, the…
seasonal-snapshot
object
Proposes the continuous and emergency ratings for the specified Season.
7 properties
4 required
seasonal-rating-snapshot-item
object
2 properties
seasonal-ratings-snapshot
object
A snapshot of the seasonal ratings for a monitoring set.
2 properties
2 required
seasonal-proposal-considered
object
Proposes the continuous and emergency ratings for the specified Season.
11 properties
2 required
seasonal-snapshot-detailed
object
Proposes the continuous and emergency ratings for the specified Season.
8 properties
5 required
seasonal-rating-snapshot-item-detailed
object
2 properties
seasonal-ratings-snapshot-detailed
object
A snapshot of the seasonal ratings for a monitoring set.
2 properties
2 required
base-header
object
3 properties
2 required
ratings
array
Set of forecast limits
seasonal-ratings-snapshot-detailed-elide-psr
object
A snapshot of the seasonal ratings for a monitoring set.
2 properties
2 required
season
object
2 properties
2 required
missing-seasonal-obligation
object
4 properties
seasonal-ratings-proposal-status
object
Seasonal rating proposal status
5 properties
3 required
seasonal-proposal-header
object
Describes the contents of this seasonal ratings proposal.
4 properties
3 required
seasonal-proposal
object
Proposes the continuous and emergency ratings for the specified Season.
9 properties
4 required
seasonal-proposals
object
2 properties
seasonal-ratings-proposal
object
2 properties
2 required
ordered-named-power-system-resources
array
Ordered array of power system resource names. The order of these items determines the order of the ratings proposals in the ratings array.
seasonal-schedule
array
Defines the seasonal ratings schedule adopted in this proposal. Each season is given a season-name with the beginning of the season starting on begins and endi…
seasonal-proposal-header-slim
object
Describes the contents of the seasonal proposal. In particular, the structure of the ratings is determined by the details provided in this header.
5 properties
4 required
seasonal-proposal-slim
array
seasonal-proposals-slim
array
A proposal for the seasonal ratings for a power system object, e.g., a segment. The proposal's structure is determined by the contents of the proposal-header.…
seasonal-ratings-proposal-slim
object
2 properties
2 required
seasonal-override
object
Data structure for a seasonal override against a resource. Includes a unique ID, start and (optional) end time, and a reason. Must also include a set of values.
9 properties
5 required
seasonal-override-set
array
seasonal-override-request
object
Data structure for a seasonal override against a resource. Must also include a set of values.
8 properties
4 required
temporary-aar-exception
object
Data structure for a temporary AAR Exception against a resource. Includes a unique ID, start and (optional) end time, and a reason. May or may not include a se…
8 properties
5 required
temporary-aar-exception-set
array
temporary-aar-exception-request
object
Represents a temporary AAR Exception against a resource. Includes a start and (optional) end time, and a reason. May or may not include a set of values, depend…
7 properties
4 required
request
object
Request body for creating a monitoring set. The server will assign an id and source upon successful creation. Note that any alternate-identifiers supplied in t…
3 properties
2 required
response
object
See https://trolie.energy/concepts.htmlmonitoring-sets for info on the monitoring set concept in TROLIE. This representation is intended to be enough for consu…
5 properties
3 required
response_v2
object
See https://trolie.energy/concepts.htmlmonitoring-sets for info on the monitoring set concept in TROLIE. This representation is intended to be enough for consu…
5 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Southwest Power Pool publishes across the network.
