Contains information about a Third Party Application requesting access to the DataCustodian services. Information requested may include items such as Organization Name, Website, Contact Info, Application Name, Description, Icon, Type, default Notification and Callback endpoints, and may also include agreement with terms of service.
Atom Links:
self link to this resource
[extension] Contains the identifier for the Data Custodian. (e.g. "Sandbox Data Custodian")
A code indicating the current status of the application. This value is provided by Data Custodian, cannot be modified by Third Party. (e.g. "2" => production)
A description of the application. (e.g. "Third Party Application Description is added as provided by each TP")
A code indicating the current status of the application. (e.g. "1" => Development
A code indicating the type of the application. (e.g. "1" => Web)
A code indicating the expected use of the application. (e.g. "1" => EnergyManagement)
The phone number of the organization to which access will be granted. (For debugging - not to be shared with customers). (e.g. "+1 800 673-6377")
[extension] Contains the base URI link to the authorization server. (e.g. "https://server.example.com/DataCustodian")
[extension] URI used to notify ThirdParty that subscribed information is available. (e.g. "https://server.example.com/ThirdParty/espi/1_1/Notification")
[extension] An OAuth 2.0 URI used by the client to obtain authorization from the resource owner via user-agent redirection - {AuthorizationServer}{AuthorizationPath}. (e.g. "https://server.example.com/DataCustodian/oauth/authorize"
[extension] A URI used by the client to register a Third Party with a Data Custodian via its {AuthorizationServer}{AuthorizationServer}{RegistrationPath}. (e.g. "https://server.example.com/DataCustodian/espi/1_1/register")
[extension] An OAuth 2.0 URL used by the client to exchange an authorization grant for an access token, typically with client authentication. (e.g. "https://server.example.com/DataCustodian/oauth/token")
[extension] {DataCustodianBulkRequestURI} URI of DataCustodian’s Bulk Request endpoint. The value is provided by the Data Custodian and cannot be modified by the ThirdParty. (e.g. "https://server.example.com/DataCustodian/espi/1_1/resource/Batch/Bulk/{BulkID}" => bulkID from BR={bulkId} from Scope)
[extension] {ResourceServer}{ResourcePath}. (e.g. "https://server.example.com/DataCustodian/espi/1_1/resource")
[DEPRECATED][extension] URI of the Scope Selection Screen used by the Retail Customer to select the characteristics of the Green Button data to be shared with the ThirdParty. (e.g. "https://server.example.com/ThirdParty/espi/1_1/RetailCustomer/ScopeSelection")
[extension] URI of a Third Party’s web page for use with Green Button Connect My Data (e.g. "https://server.example.com/ThirdParty/espi/1_1/home")
[extension] A secret to be associated with this application, used to sign OAuth requests. This value is provided by Data Custodian (OAuth client_secret). (e.g. "secret")
[extension] The link to the logo image for the application. Size greater than 180 x 150 may be cropped or reduced (OAuth logo_uri). (e.g. "http://server.example.com/ThirdParty/favicon.png")
[extension] The name of the application to which access will be granted (OAuth client_name). (e.g. "Green Button ThirdParty")
[extension] The link to the main page of the application (OAuth client_uri). (e.g. "https://server.example.com/ThirdParty")
[extension] The default redirect back to the application after authorization grant (OAuth redirect uri). (e.g. "https://server.example.com/ThirdParty/espi/1_1/OAuthCallBack")
Contains the identifier for the Third Party (OAuth client_id). (e.g. "ThirdParty Name")
[extension] A URI that points to a human-readable Terms of Service document for the Third Party Application. The Terms of Service usually describes a contractual relationship between the Retail Customer and the Third Party Application that the Retail Customer accepts when authorizing access to the Third Party Application. (e.g. "http://server.example.com/ThirdParty/TermsOfService")
[extension] A URI that points to a human-readable Policy document for the Third Party Application. The policy usually describes how a Retail Customer's energy usage information will be used by the Third Party Application. (e.g. "http://server.example.com/ThirdParty/UsagePolicy")
[extension] An identifier for the software that comprises the Third Party Application. The software_id is asserted by the Third Party software and is intended to be shared between all copies of the Third Party software. The value of this field MAY be a UUID [RFC4122]. (e.g. "MyCoolGreenButtonAnalyzer")
[extension] A version identifier for the software that comprises a Third Party Application. The value of this field is a string that is intended to be compared using string equality matching. The value of the software_version SHOULD change on any update to the Third Party software. (e.g. "Version 1.00.00")
[extension] Time date stamp at which this client_id was issued. Note the schema data type is TimeType and the presentation in OAuth message flow is xs:dateTime and requires a conversion when accessed. (e.g. "1403190000" => 2014-06-19T15:00:00Z)
[extension] Date time at which this client_secret expires -- value of 0 means the client_secret never expires. (e.g. "0" => never expires)
[extension] Array of email addresses for people responsible for the Authorized Third Party Application. These MAY be made available to Retail Customers for support requests for the Authorized Third Party application. The Data Custodian Authorization Server MAY use the email addresses as identifiers for an Authorized Third Party application administrative page. (e.g. "support@energyos.org")
[extension] The authentication method used by the OAuth 2.0 Token Endpoint to authenticate the Third Party Application. (e.g. "client_secret_basic")
[extension] Space separated list of scope values the Third Party Application may use when requesting access Tokens. (e.g. "FB=1_3_4_5_8_13_18_19_31_34_35_39;IntervalDuration=900_3600;BlockDuration=Daily; HistoryLength= 34128000;SubscriptionFrequency=Daily; AccountCollection=5;BR=1;")
[extension] Grant types this interface supports. (e.g. "client_credentials, authorization_code, refresh_token" in separate tags
[extension] Response types supported. (e.g. "code")
[extension] {ClientConfigurationURI} A URI used by a registered client to manage registration information. This URI is returned by the AuthorizationServer in the “registration_client_uri” field of the client information response. {AuthorizationServerRegistrationEndpoint}/ApplicationInformation/{ApplicationInformationID}. (e.g. "https://server.example.com/DataCustodian/espi/1_1/resource/ApplicationInformation/{ApplicationInformationID}/")
[extension] A credential obtained during Third Party registration with the Data Custodian to enable access to the ApplicationInformation resource. This is persisted in the ApplicationInformation resource structure. (e.g. "fe82518d-e325-404e-978c-c02f9339bccc")
[DEPRECATED][extension] The URI used by the Third Party to redirect the Retail Customer to the Data Custodian Scope Selection Screen (note that this will likely involve a dialog with the Retail Customer including a log in authentication process). (e.g. http://server.example.com/DataCustodian/RetailCustomer/ScopeSelection)
[extension] Represents a permission granted by an owner for access to a resource.
Atom Links:
self link to this resource
rel corresponding ApplicationInformation (if this is the client access containing token instance)
rel corresponding to the authorized resource (if this is the access_token containing instance for a customer resource)
Note: for privacy there is no identifier of the RetailCustomer in this structure but an implementation will have consider how to maintain a correspondence between a RetailCustomer and his authorization.
Restricts access to requests or subscriptions within this date time interval. (e.g. "duration=31536000,start=1333252800", a duration value of "0" (zero) indicates an infinite duration period)
Restricts access to the objects within the associated resource that were published within this date time interval. (e.g. "duration=31536000" for most recent 365 days)
The status of this authorization. (e.g. "1" => active)
Expiration period for the access token. (e.g. "1403190000" for 2014-06-19T15:00:00Z)
Type of grant being negotiated for. (e.g. "authorization_code")
Negotiated scope of the authorization. (e.g. "FB=1_3_4_5_13_14_15_1937_39;IntervalDuration=3600;BlockDuration=monthly;HistoryLength=94608000"
Type of token used. (e.g. "Bearer")
Contains last error returned to ThirdParty. (e.g. "server_error")
Contains free text string describing last error returned to ThirdParty. (e.g. "No Service")
Specific error URI for last returned error. (e.g. "na" if not supported)
URI that can be used to access the EUI data the Third Party is authorized to access. Can be used in a GET of the EUI resource subscription (e.g. "http://server.example.com/DataCustodian/espi/1_1/resource/Batch/Subscription/1").
URI that can be used to update or delete this Authorization. (e.g. "http://server.example.com/DataCustodian/espi/1_1/resource/Authorization/1")
URI that can be used to access PII data the Third Party is authorized to access. Can be used in a GET of the PII resource subscription (e.g. "http://server.example.com/DataCustodian/espi/1_1/resource/Batch/Subscription/2").
Note: This URI will have a differnt namespace than the URI value found in the resourceURI element.
Time sequence of Readings of the same ReadingType.
Specifies the time period during which the contained readings were taken.
One or more interval reading values measured by a meter or other asset.
Set of values obtained from the meter.
Characteristics associated with all Readings included in a MeterReading.
Code indicating how value is accumulated over time for Readings of ReadingType.
Code for commodity classification of Readings of ReadingType.
Code for consumption tier associated with a Reading of ReadingType.
Code for the currency for costs associated with this ReadingType. The valid values per the standard are defined in CurrencyCode.
Code describing a salient attribute of Readings of ReadingType.
Default value to be used if no value of ReadingQuality.quality is provided.
Specific format and valid values per the standard are specified in QualityOfReading.
Direction associated with current related Readings.
Default interval length specified in seconds for Readings of ReadingType.
Code for general classification of a Reading of ReadingType.
Code for phase information associated with Readings of ReadingType.
Code for the power of ten multiplier which, when used in combination with the uom, specifies the actual unit of measure for Readings of ReadingType.
Code used to specify a particular type of time interval method for Readings of ReadingType.
Code for the TOU type of Readings of ReadingType.
Code for the base unit of measure for Readings of ReadingType. Used in combination with the powerOfTenMultiplier to specify the actual unit of measure
[extension] Critical peak period (CPP) bucket the reading value is attributed to. Value 0 means not applicable. Even though CPP is usually considered a specialized form of time of use 'tou', this attribute is defined explicitly for flexibility.
[extension] Indication of a "harmonic" or "interharmonic" basis for the measurement. Value 0 in 'numerator' and 'denominator' means not applicable.
[extension] Time attribute inherent or fundamental to the reading value (as opposed to 'macroPeriod' that supplies an "adjective" to describe aspects of a time period with regard to the measurement). It refers to the way the value was originally measured and not to the frequency at which it is reported or presented. For example, an hourly interval of consumption data would have value 'hourly' as an attribute. However in the case of an hourly sampled voltage value, the meterReadings schema would carry the 'hourly' interval size information.
It is common for meters to report demand in a form that is measured over the course of a portion of an hour, while enterprise applications however commonly assume the demand (in kW or kVAr) normalized to 1 hour. The system that receives readings directly from the meter therefore must perform this transformation before publishing readings for use by the other enterprise systems. The scalar used is chosen based on the block size (not any sub-interval size).
[extension] Argument used to introduce numbers into the unit of measure description where they are needed (e.g., 4 where the measure needs an argument such as CEMI(n=4)). Most arguments used in practice however will be integers (i.e., 'denominator'=1).
Value 0 in 'numerator' and 'denominator' means not applicable.
Logical point on a network at which consumption or production is either physically measured (e.g., metered) or estimated (e.g., unmetered street lights).
Specifies the roles that this usage point has been assigned. Bit 1 - isMirror Bit 2 - isPremisesAggregationPoint Bit 3 - isPEV Bit 4 - isDER Bit 5 - isRevenueQuality Bit 6 - isDC Bit 7-16 - Reserved
Category of service provided to the customer.
Specifies the current status of this usage point. Valid values include: 0 = off 1 = on
[extension] Contains service delivery point information about the UsagePoint if it does represent the service delivery point.
[extension] Tracks the lifecycle of the metering installation at a usage point with respect to readiness for billing via advanced metering infrastructure reads.
[extension] True if as a result of an inspection or otherwise, there is a reason to suspect that a previous billing may have been performed with erroneous data. Value should be reset once this potential discrepancy has been resolved.
[extension] State of the usage point with respect to connection to the network.
[extension] Estimated load.
[extension] True if grounded.
[extension] If true, this usage point is a service delivery point, i.e., a usage point where the ownership of the service changes hands.
[extension] If true, this usage point is virtual, i.e., no physical location exists in the network where a meter could be located to collect the meter readings. For example, one may define a virtual usage point to serve as an aggregation of usage for all of a company's premises distributed widely across the distribution territory. Otherwise, the usage point is physical, i.e., there is a logical point in the network where a meter could be located to collect meter readings.
[extension] If true, minimal or zero usage is expected at this usage point for situations such as premises vacancy, logical or physical disconnect. It is used for readings validation and estimation.
[extension] Nominal service voltage.
[extension] Outage region in which this usage point is located.
[extension] Phase code. Number of wires and specific nominal phases can be deduced from enumeration literal values. For example, ABCN is three-phase, four-wire, s12n (splitSecondary12N) is single-phase, three-wire, and s1n and s2n are single-phase, two-wire.
[extension] Current flow that this usage point is configured to deliver.
[extension] Active power that this usage point is configured to deliver.
[extension] Cycle day on which the meter for this usage point will normally be read. Usually correlated with the billing cycle.
[extension] Identifier of the route to which this usage point is assigned for purposes of meter reading. Typically used to configure hand held meter reading systems prior to collection of reads.
[extension] Remarks about this usage point, for example the reason for it being rated with a non-nominal priority.
[extension] Priority of service for this usage point. Note that usage points at the same service location can have different priorities.
[extension] A single electrical system Node or subset of Nodes where a
physical injection or withdrawal of electricity is modeled and for which a Locational
Marginal Price is calculated by the RTO/ISO and used for financial settlements.
[extension] A sequence of references to AggregateNodes.
A summary of power quality events. This information represents a summary of power quality information typically required by customer facility energy management systems. It is not intended to satisfy the detailed requirements of power quality monitoring. All values are as defined by measurementProtocol during the period. The standards typically also give ranges of allowed values; the information attributes are the raw measurements, not the "yes/no" determination by the various standards. See referenced standards for definition, measurement protocol and period.
A measurement of long term Rapid Voltage Change in hundredths of a Volt. flickerPlt is derived from 2 hours of Pst values (12 values combined in cubic relationship).
flickerPst is a value measured over 10 minutes that characterizes the likelihood that the voltage fluctuations would result in perceptible light flicker. A value of 1.0 is designed to represent the level that 50% of people would perceive flicker in a 60 watt incandescent bulb. The value reported is represented as an integer in hundredths.
A measurement of the Harmonic Voltage during the period. For DC, distortion is with respect to a signal of zero Hz.
A count of Long Interruption events (as defined by measurementProtocol) during the summary interval period.
A measurement of the Mains [Signaling] Voltage during the summary interval period in uV.
A reference to the source standard used as the measurement protocol definition. Examples are: 0 = “IEEE1519-2009” 1 = “EN50160”
A measurement of the power frequency during the summary interval period in uHz.
A count of Rapid Voltage Change events during the summary interval period
A count of Short Interruption events during the summary interval period
Interval of summary period
A count of Supply Voltage Dip events during the summary interval period
A count of Supply Voltage Imbalance events during the summary interval period
A count of Supply Voltage Variations during the summary interval period
A count of Temporary Overvoltage events (as defined by measurementProtocol) during the summary interval period
[DEPRECATED] Summary of usage for a billing period
The billing period to which the included measurements apply. May also be an off-bill arbitrary period.
The amount of the bill for the referenced billingPeriod in hundred-thousandths of the currency specified in the ReadingType for this reading (e.g., 840 = USD, US dollar).
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the bill amount as of the date the summary is generated, in hundred-thousandths of the currency specified in the ReadingType for this reading. (e.g., 840 = USD, US dollar).
Additional charges from the for the referenced billingPeriod, in hundred-thousandths of the currency specified in the ReadingType for this reading. (e.g., 840 = USD, US dollar).
[extension] Additional charges from the for the referenced billingPeriod which in total add up to costAdditionalLastPeriod.
The ISO 4217 code indicating the currency applicable to the bill amounts in the summary.
[extension] The amount of energy consumed in the lfor the referenced billingPeriod.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the total consumption for the billing period.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the amount of energy consumed one year ago interpreted as same day of week same week of year (see ISO 8601) based on the day of the statusTimeStamp.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, net consumption for the current day (delivered - received) based on the day of the statusTimeStamp
If the summary contains data from a current period beyond the end of the referenced billingPeriod, overall energy consumption for the current day, based on the day of the statusTimeStamp.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, peak demand recorded for the current period.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the amount of energy consumed on the previous day one year ago interpreted as same day of week same week of year (see ISO 8601) based on the day of the statusTimestamp.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, net consumption for the previous day relative to the day of the statusTimestamp.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the total consumption for the previous day based on the day of the statusTimestamp.
Indication of the quality of the summary readings
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the current ratchet demand value for the ratchet demand over the ratchetDemandPeriod.
The period over which the ratchet demand applies
Date/Time status of this UsageSummary
[extension] The commodity for this summary report
[extension] Summary of usage for a billing period
[extension] List of rate options applied to the base tariff profile
The billing period to which the included measurements apply. May also be an off-bill arbitrary period.
The amount of the bill for the referenced billingPeriod in hundred-thousandths of the currency specified in the ReadingType for this reading (e.g., 840 = USD, US dollar).
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the bill amount as of the date the summary is generated, in hundred-thousandths of the currency specified in the ReadingType for this reading. (e.g., 840 = USD, US dollar).
Additional charges from the for the referenced billingPeriod, in hundred-thousandths of the currency specified in the ReadingType for this reading. (e.g., 840 = USD, US dollar).
[extension] Additional charges from the for the referenced billingPeriod which in total add up to costAdditionalLastPeriod.
The ISO 4217 code indicating the currency applicable to the bill amounts in the summary.
[extension] The amount of energy consumed in the lfor the referenced billingPeriod.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the total consumption for the billing period.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the amount of energy consumed one year ago interpreted as same day of week same week of year (see ISO 8601) based on the day of the statusTimeStamp.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, net consumption for the current day (delivered - received) based on the day of the statusTimeStamp
If the summary contains data from a current period beyond the end of the referenced billingPeriod, overall energy consumption for the current day, based on the day of the statusTimeStamp.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, peak demand recorded for the current period.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the amount of energy consumed on the previous day one year ago interpreted as same day of week same week of year (see ISO 8601) based on the day of the statusTimestamp.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, net consumption for the previous day relative to the day of the statusTimestamp.
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the total consumption for the previous day based on the day of the statusTimestamp.
Indication of the quality of the summary readings
If the summary contains data from a current period beyond the end of the referenced billingPeriod, the current ratchet demand value for the ratchet demand over the ratchetDemandPeriod.
The period over which the ratchet demand applies
Date/Time status of this UsageSummary
[extension] The commodity for this summary report
[extension] A schedule of charges; structure associated with Tariff that allows the definition of complex tariff structures such as step and time of use.
[extension] Cycle day on which the meter for this usage point will normally be read. Usually correlated with the billing cycle.
[extension] List of rate options applied to the base tariff profile
[extension] Source of Billing Charge
[extension] Contains attributes related to the configuration of the time service.
Rule to calculate end of daylight savings time in the current year. Result of dstEndRule must be greater than result of dstStartRule.
Daylight savings time offset from local standard time.
Rule to calculate start of daylight savings time in the current year. Result of dstEndRule must be greater than result of dstStartRule.
Local time zone offset from UTCTime. Does not include any daylight savings time offsets.
[extension] List of programIDmappings
[extension] single program id mapping
Type of billing tariff profile uses
Code (numeric value)
Name associated with code
Optional description of code
Specific value measured by a meter or other asset. Each Reading is associated with a specific ReadingType.
[correction] Specifies a cost associated with this reading, in hundred-thousandths of the currency specified in the ReadingType for this reading. (e.g., 840 = USD, US dollar)
One or more quality of reading values for the current interval reading.
The date time and duration of a reading. If not specified, readings for each “intervalLength” in ReadingType are present.
[correction] Value in units specified by ReadingType
[extension] Code for consumption tier associated with reading.
[extension] Code for the TOU type of reading.
[extension] Critical peak period (CPP) bucket the reading value is attributed to. Value 0 means not applicable. Even though CPP is usually considered a specialized form of time of use 'tou', this attribute is defined explicitly for flexibility.
Quality of a specific reading value or interval reading value. Note that more than one Quality may be applicable to a given Reading. Typically not used unless problems or unusual conditions occur (i.e., quality for each Reading is assumed to be 'Good' (valid) unless stated otherwise in associated ReadingQuality).
Quality, to be specified if different than ReadingType.defaultQuality. The specific format is specified per the standard is defined in QualityOfReading.
Category of service provided to the customer.
Service classification Examples are: 0 - electricity 1 - gas The list of specific valid values per the standard are itemized in ServiceKind.
An aggregated summary measurement reading.
The multiplier part of the unit of measure, e.g. “kilo” (k)
The date and time (if needed) of the summary measurement.
The units of the reading, e.g. “Wh”
The value of the summary measurement.
[extension] Reference to a full ReadingType.
Includes elements that make it possible to include multiple transactions in a single (batch) request.
An identifier for this object that is only unique within the containing collection.
Specifies the operation requested of this item.
Indicates the status code of the associated transaction.
Indicates the reason for the indicated status code.
[extension] Service Delivery Point is representation of revenue UsagePoint attributes
The name is any free human readable and possibly non unique text naming the object.
A schedule of charges; structure associated with Tariff that allows the definition of complex tariff structures such as step and time of use.
Agreement between the customer and the ServiceSupplier to pay for service at a specific service location. It provides for the recording of certain billing information about the type of service provided at the service location and is used during charge creation to determine the type of service.
[extension] List of rate options applied to the base tariff profile
A 128-bit field encoded as a hex string (32 characters / 16 octets)
A 32-bit field encoded as a hex string (8 characters / 4 octets)
A 16-bit field encoded as a hex string (4 characters / 2 octets)
An 8-bit field encoded as a hex string (2 characters / 1 octets)
[extension] Character string of max length 512
Character string of max length 256
Character string of max length 64
Character string of max length 32
Character string of max length 16
Character string of max length 8
Character string of max length 4
Unsigned integer, max inclusive 65535 (2^16-1), same as xs:unsignedShort
Unsigned integer, max inclusive 4294967295 (2^32-1), same as xs:unsignedInt
Unsigned integer, max inclusive 281474976710655 (2^48-1), restriction of xs:unsignedLong
Unsigned integer, max inclusive 255 (2^8-1), same as xs:unsignedByte
Signed integer, max inclusive -140737488355327 to +140737488355327 (2^47-1), restriction of xs:long
Signed integer, max inclusive (2^16-1), restriction of xs:short
Time is a signed 64-bit value representing the number of seconds since 0 hours, 0 minutes, 0 seconds, on the 1st of January, 1970.
Interval of date and time. End is not included because it can be derived from the start and the duration.
[correction] Duration of the interval, in seconds.
[correction] Date and time that this interval started.
This is a root class to provide common naming attributes for all classes needing naming attributes
This pattern defines a UUID
Superclass of all object classes to allow extensions. Inheritance from Object provides an inherent extension mechanism permitting custom data to be included in a separate namespace.
Contains an extension.
Contains the current status of the service.
The current status of the service.
[extension] Rational number = 'numerator' / 'denominator'.
[extension] Interharmonics are represented as a rational number 'numerator' / 'denominator', and harmonics are represented using the same mechanism and identified by 'denominator'=1.
[extension] List of resource URIs that can be used to GET ESPI resources
An individual resource URI.
[extension] Line item of detail for additional cost
Cost of line item.
Rounded to nearest increment.
Significant date for line item.
Comment or description of line item.
[extension] relevant measurment for line item.
[extension] Classification of a line item -- i.e. usage charge, taxes, etc...
[extension] Per Unit cost.
[extension] Time period covered by the LineItem, to support pricing changes in the middle of a billing period
[extension] Sequence of references to Pnodes assoicated with a UsagePoint.
pnodeRef structure.
[extension] References to associated AggregateNodes.
[extension] References to associated Tariff Riders.
[extension] Tariff Rider structure.
[extension] Reference to a Pnode.
type of pnode.
Reference to a Pnode.
[extension] Starting Effective Date of Pnode assignment
[extension] Ending Effective Date of Pnode assignment
[extension] Reference to an AggregateNode (could be a load aggregation point which is a specialization of AggregateNode).
Type of aggregateNode.
Reference to an AggregateNode.
[extension] Starting Effective Date of ANode assignment
[extension] Ending Effective Date of ANode assignment
[extension] Reference to a Tariff Rider.
[extension] Rate options applied to the base tariff profile
[extension] Retail Customer's Tariff Rider enrollment status
[extension] Effective date of Retail Customer's Tariff Rider enrollment status
[extension] Information about source of billing charge
[extension] Name of billing source
[extension] Token endpoint method in OAuth 2.0.
[extension] Indicates the client uses HTTP Basic authentication (RFC 6749 Section 2.3.1).
[extension] OAuth 2.0 ESPI supported grant types.
OAuth 2.0 Authorization Code Grant flow (RFC 6749 Section 4.1).
OAuth 2.0 Client Credentials Grant flow (RFC 6749 Section 4.4).
OAuth 2.0 Refresh Token flow (RFC 6749 Section 6.).
[extension] OAuth 2.0 ESPI supported response types.
Indicates a request for an authorization code (RFC 6749 Section 4.1.1)
[extension] OAuth 2.0 ESPI supported token types.
A security token with the property that any party in possession of the token (a "bearer") can use the token in any way that any other party in possession of it can. Using a bearer token does not require a bearer to prove possession of cryptographic key material (proof-of-possession) (RFC6750 Section 1.2).
[extension] OAuth 2.0 ESPI supported error codes.
The request is missing a required parameter, includes an unsupported parameter value (other than grant type), repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the client, or is otherwise malformed (RFC 6749 Sections 4.1.2.1 and 5.2).
Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method). The authorization server MAY return an HTTP 401 (Unauthorized) status code to indicate which HTTP authentication schemes are supported. If the client attempted to authenticate via the Authorization request header field, the authorization server MUST respond with an HTTP 401 (Unauthorized) status code and include the WWW-Authenticate response header field matching the authentication scheme used by the client. (RFC 6749 Section 5.2).
The provided authorization code or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client (RFC 6749 Section 5.2).
The authenticated client is not authorized to use this authorization grant type (RFC 6749 Sections 4.1.2.1 and 5.2).
The authorization grant type is not supported by the authorization server (RFC 6749 Section 5.2).
The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner (RFC 6749 Sections 4.1.2.1 and 5.2).
The value of one or more redirection URIs is invalid (RFC 7591 Section 3.2.2).
The value of one of the client metadata fields is invalid and server has rejected the request. Not that an authorization server MAY choose to substitute a valid value for any requested parameter of a client's metadata (RFC 7591 Section 3.2.2).
[DEPRECATED] Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method). The authorization server MAY return an HTTP 401 (Unauthorized) status code to indicate which HTTP authentication schemes are supported. If the client attempted to authenticate via the Authorization request header field, the authorization server MUST respond with an HTTP 401 (Unauthorized) status code and include the WWW-Authenticate response header field matching the authentication scheme used by the client.
The resource owner or authorization server denied the request (RFC 6749 Section 4.1.2.1).
The authorization server does not support obtaining an authorization code using this method (RFC 6749 Section 4.1.2.1).
The authorization server encountered an unexpected condition that prevented it from fulfilling the request (RFC 6749 Section 4.1.2.1).
The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server (RFC 6749 Section 4.1.2.1).
[extension] Code for classification billing line items.
Energy Generation Fee. A charge for generation of energy.
Energy Delivery Fee. A charge for delivery of energy.
Energy Usage Fee. A charge for electricity, natural gas, water consumption
Administrative Fee. A fee for administrative services.
Tax. A local, state, or federal energy tax.
Energy Generation Credit. A credit, discount or rebate for generation of energy.
Energy Delivery Credit. A credit, discount or rebate for delivery of energy.
Administrative Credit. A credit, discount or rebate for administrative services.
Payment. A payment for a previous billing.
Information. An informational line item.
Code indicating how value is accumulated over time for Readings of ReadingType. The list of valid values per the standard are defined in AccumulationBehaviorType.
none
Not Applicable or implied by the unit of measure.
bulkQuantity
A value from a register which represents the bulk quantity of a commodity. This quantity is computed as the integral of the commodity usage rate. This value is typically used as the basis for the dial reading at the meter, and as a result, will roll over upon reaching a maximum dial value. Note 1: With the metering system, the roll-over behavior typically implies a roll-under behavior so that the value presented is always a positive value (e.g. unsigned integer or positive decimal.) However, when communicating data between enterprise applications a negative value might occur in a case such as net metering. Note 2: A BulkQuantity refers primarily to the dial reading and not the consumption over a specific period of time.
continuousCumulative
The sum of the previous billing period values and the present period value. Note: “ContinuousCumulative” is commonly used in conjunction with “demand.” The “ContinuousCumulative Demand” would be the cumulative sum of the previous billing period maximum demand values (as occurring with each demand reset) summed with the present period maximum demand value (which has yet to be reset.)
cumulative
The sum of the previous billing period values. Note: “Cumulative” is commonly used in conjunction with “demand.” Each demand reset causes the maximum demand value for the present billing period (since the last demand reset) to accumulate as an accumulative total of all maximum demands. So instead of “zeroing” the demand register, a demand reset has the effect of adding the present maximum demand to this accumulating total.
deltaData
The difference between the value at the end of the prescribed interval and the beginning of the interval. This is used for incremental interval data. Note: One common application would be for load profile data, another use might be to report the number of events within an interval (such as the number of equipment energizations within the specified period of time.)
indicating
As if a needle is swung out on the meter face to a value to indicate the current value. (Note: An “indicating” value is typically measured over hundreds of milliseconds or greater, or may imply a “pusher” mechanism to capture a value. Compare this to “instantaneous” which is measured over a shorter period of time.)
summation
A form of accumulation which is selective with respect to time. Note : “Summation” could be considered a specialization of “Bulk Quantity” according to the rules of inheritance where “Summation” selectively accumulates pulses over a timing pattern, and “BulkQuantity” accumulates pulses all of the time.
timeDelay
A form of computation which introduces a time delay characteristic to the data value
instantaneous
Typically measured over the fastest period of time allowed by the definition of the metric (usually milliseconds or tens of milliseconds.) (Note: “Instantaneous” was moved to attribute #3 in 61968-9Ed2 from attribute #1 in 61968-9Ed1.)
latchingQuantity
When this description is applied to a metered value, it implies that the value is a time-independent cumulative quantity much a BulkQuantity, except that it latches upon the maximum value upon reaching that value. Any additional accumulation (positive or negative) is discarded until a reset occurs. Note: A LatchingQuantity may also occur in the downward direction – upon reaching a minimum value. The terms “maximum” or “minimum” will usually be included as an attribute when this type of accumulation behavior is present. When this description is applied to an encoded value (UOM= “Code”), it implies that the value has one or more bits which are latching. The condition that caused the bit to be set may have long since evaporated. In either case, the timestamp that accompanies the value may not coincide with the moment the value was initially set. In both cases a system will need to perform an operation to clear the latched value.
boundedQuantity
A time-independent cumulative quantity much a BulkQuantity or a LatchingQuantity, except that the accumulation stops at the maximum or minimum values. When the maximum is reached, any additional positive accumulation is discarded, but negative accumulation may be accepted (thus lowering the counter.) Likewise, when the negative bound is reached, any additional negative accumulation is discarded, but positive accumulation is accepted (thus increasing the counter.)
Code for commodity classification of Readings of ReadingType. The valid values per the standard are defined in CommodityType.
none
Not Applicable
electricity SecondaryMetered
All types of metered quantities. This type of reading comes from the meter and represents a “secondary” metered value.
electricity PrimaryMetered
It is possible for a meter to be outfitted with an external VT and/or CT. The meter might not be aware of these devices, and the display not compensate for their presence. Ultimately, when these scalars are applied, the value that represents the service value is called the “primary metered” value. The “index” in sub-category 3 mirrors those of sub-category 0.
communication
A measurement of the communication infrastructure itself.
air
Air
insulativeGas
Insulative Gas (SF6 is found separately below)
insulativeOil
Insulative Oil
naturalGas
Natural Gas
propane
Propane C3H8
potableWater
Drinkable water
steam
Water in steam form, usually used for heating.
wasteWater
Waste Water (Sewerage)
heatingFluid
This fluid is likely in liquid form. It is not necessarily water or water based. The warm fluid returns cooler than when it was sent. The heat conveyed may be metered.
coolingFluid
The cool fluid returns warmer than when it was sent. The heat conveyed may be metered.
nonpotableWater
Reclaimed water – possibly used for irrigation but not sufficiently treated to be considered safe for drinking.
nox
Nitrous Oxides NOX
so2
Sulfur Dioxide SO2
ch4
Methane CH4
co2
Carbon Dioxide CO2
carbon
Carbon
hch
Hexachlorocyclohexane HCH
pfc
Perfluorocarbons PFC
sf6
Sulfurhexafluoride SF6
tvLicence
Television
internet
Internet service
refuse
Trash
electricity TransmissionMetered
Electricity Transmission "metered" -- Service taken directly from transmission system without transformation from standard transmission voltages
Code for the currency for costs associated with this ReadingType. The valid values per the standard are defined in CurrencyCode.
USD
US dollar
EUR
European euro
AUD
Australian dollar
CAD
Canadian dollar
CHF
Swiss francs
CNY
Chinese yuan renminbi
DKK
Danish crown
GBP
British pound
JPY
Japanese yen
NOK
Norwegian crown
RUB
Russian ruble
SEK
Swedish crown
INR
India rupees
other
Another type of currency.
Code describing a salient attribute of Readings of ReadingType. Valid values per the standard are defined in DataQualifierType.
none
Not Applicable
average
Average value
excess
The value represents an amount over which a threshold was exceeded.
highThreshold
The value represents a programmed threshold.
lowThreshold
The value represents a programmed threshold.
maximum
The highest value observed
minimum
The smallest value observed
nominal
Nominal
normal
Normal
secondMaximum
The second highest value observed
secondMinimum
The second smallest value observed
thirdMaximum
The third highest value observed
fourthMaximum
The fourth highest value observed
fifthMaximum
The fifth highest value observed
sum
The accumulated sum
Direction associated with current related Readings. valid values per the standard are defined in FlowDirectionType.
none
Not Applicable (N/A)
forward
"Delivered," or "Imported" as defined 61968-2.Forward Active Energy is a positive kWh value as one would naturally expect to find as energy is supplied by the utility and consumed at the service. Forward Reactive Energy is a positive VArh value as one would naturally expect to find in the presence of inductive loading. In polyphase metering, the forward energy register is incremented when the sum of the phase energies is greater than zero.
lagging
Typically used to describe that a power factor is lagging the reference value. Note 1: When used to describe VA, “lagging” describes a form of measurement where reactive power is considered in all four quadrants, but real power is considered only in quadrants I and IV. Note 2: When used to describe power factor, the term “Lagging” implies that the PF is negative. The term “lagging” in this case takes the place of the negative sign. If a signed PF value is to be passed by the data producer, then the direction of flow enumeration zero (none) should be used in order to avoid the possibility of creating an expression that employs a double negative. The data consumer should be able to tell from the sign of the data if the PF is leading or lagging. This principle is analogous to the concept that “Reverse” energy is an implied negative value, and to publish a negative reverse value would be ambiguous. Note 3: Lagging power factors typically indicate inductive loading.
leading
Typically used to describe that a power factor is leading the reference value. Note: Leading power factors typically indicate capacitive loading.
net
|Forward| - |Reverse|, See 61968-2.Note: In some systems, the value passed as a “net” value could become negative. In other systems the value passed as a “net” value is always a positive number, and rolls-over and rolls-under as needed.
q1plusQ2
Reactive positive quadrants. (The term “lagging” is preferred.)
q1plusQ3
Quadrants 1 and 3
q1plusQ4
Quadrants 1 and 4 usually represent forward active energy
q1minusQ4
Q1 minus Q4
q2plusQ3
Quadrants 2 and 3 usually represent reverse active energy
q2plusQ4
Quadrants 2 and 4
q2minusQ3
Q2 minus Q3
q3plusQ4
Reactive negative quadrants. (The term “leading” is preferred.)
q3minusQ2
Q3 minus Q2
quadrant1
Q1 only
quadrant2
Q2 only
quadrant3
Q3 only
quadrant4
Q4 only
reverse
Reverse Active Energy is equivalent to "Received," or "Exported" as defined in 61968-2. Reverse Active Energy is a positive kWh value as one would expect to find when energy is backfed by the service onto the utility network. Reverse Reactive Energy is a positive VArh value as one would expect to find in the presence of capacitive loading and a leading Power Factor. In polyphase metering, the reverse energy register is incremented when the sum of the phase energies is less than zero. Note: The value passed as a reverse value is always a positive value. It is understood by the label “reverse” that it represents negative flow.
total
|Forward| + |Reverse|, See 61968-2. The sum of the commodity in all quadrants Q1+Q2+Q3+Q4. In polyphase metering, the total energy register is incremented when the absolute value of the sum of the phase energies is greater than zero.
totalByPhase
In polyphase metering, the total by phase energy register is incremented when the sum of the absolute values of the phase energies is greater than zero. In single phase metering, the formulas for “Total” and “Total by phase” collapse to the same expression. For communication purposes however, the “Total” enumeration should be used with single phase meter data.
Name of physical measurement
none
Not Applicable
apparentPowerFactor
Apparent Power Factor
currency
Currency
current
Current
currentAngle
Current Angle
currentImbalance
Current Imbalance
date
Date
demand
Demand
distance
Distance
distortionVoltAmperes
Distortion Volt Amperes
energization
Energization
energy
Energy
energizationLoadSide
Energization Load Side
fan
Fan
frequency
Frequency
Funds
Funds (Duplication of “currency”)
ieee1366ASAI
ieee1366ASAI
ieee1366ASIDI
ieee1366ASIDI
ieee1366ASIFI
ieee1366ASIFI
ieee1366CAIDI
ieee1366CAIDI
ieee1366CAIFI
ieee1366CAIFI
ieee1366CEMIn
ieee1366CEMIn
ieee1366CEMSMIn
ieee1366CEMSMIn
ieee1366CTAIDI
ieee1366CTAIDI
ieee1366MAIFI
ieee1366MAIFI
ieee1366MAIFIe
ieee1366MAIFIe
ieee1366SAIDI
ieee1366SAIDI
ieee1366SAIFI
ieee1366SAIFI
lineLosses
Line Losses
losses
Losses
negativeSequence
Negative Sequence
phasorPowerFactor
Phasor Power Factor
phasorReactivePower
Phasor Reactive Power
positiveSequence
Positive Sequence
power
Power
powerFactor
Power Factor
quantityPower
Quantity Power
sag
Sag (Voltage Dip)
swell
Swell
switchPosition
Switch Position
tapPosition
Tap Position
tariffRate
Tariff Rate
temperature
Temperature
totalHarmonicDistortion
Total Harmonic Distortion
transformerLosses
Transformer Losses
unipedeVoltageDip10to15
Unipede Voltage Dip 10 to 15
unipedeVoltageDip15to30
Unipede Voltage Dip 15 to 30
unipedeVoltageDip30to60
Unipede Voltage Dip 30 to 60
unipedeVoltageDip60to90
Unipede Voltage Dip 60 to 90
unipedeVoltageDip90to100
Unipede Voltage Dip 90 to 100
voltage
Voltage
voltageAngle
Voltage Angle
voltageExcursion
Voltage Excursion
voltageImbalance
Voltage Imbalance
volume
Volume (Clarified from Ed. 1. to indicate fluid volume)
zeroFlowDuration
Zero Flow Duration
zeroSequence
Zero Sequence
distortionPowerFactor
Distortion Power Factor
frequencyExcursion
Frequency Excursion (Usually expressed as a “count”)
applicationContext
Application Context
apTitle
Ap Title
assetNumber
Asset Number
bandwidth
Bandwidth
batteryVoltage
Battery Voltage
broadcastAddress
Broadcast Address
deviceAddressType1
Device Address Type 1
deviceAddressType2
Device Address Type 2
deviceAddressType3
Device Address Type 3
deviceAddressType4
Device Address Type 4
deviceClass
Device Class
electronicSerialNumber
Electronic Serial Number
endDeviceID
End Device ID
groupAddressType1
Group Address Type 1
groupAddressType2
Group Address Type 2
groupAddressType3
Group Address Type 3
groupAddressType4
Group Address Type 4
ipAddress
IP Address
macAddress
MAC Address
mfgAssignedConfigurationID
Mfg Assigned Configuration ID
mfgAssignedPhysicalSerialNumber
Mfg Assigned Physical Serial Number
mfgAssignedProductNumber
Mfg Assigned Product Number
mfgAssignedUniqueCommunicationAddress
Mfg Assigned Unique Communication Address
multiCastAddress
Multicast Address
oneWayAddress
One Way Address
signalStrength
Signal Strength
twoWayAddress
Two Way Address
signaltoNoiseRatio
Signal to Noise Ratio (moved here from Attribute #9 UOM)
alarm
Alarm
batteryCarryover
Battery Carryover
dataOverflowAlarm
Data Overflow Alarm
demandLimit
Demand Limit
demandReset
Demand Reset (usually expressed as a count as part of a billing cycle)
diagnostic
Diagnostic
emergencyLimit
Emergency Limit
encoderTamper
Encoder Tamper
ieee1366MomentaryInterruption
ieee1366 Momentary Interruption
ieee1366MomentaryInterruptionEvent
ieee1366 Momentary Interruption Event
ieee1366SustainedInterruption
ieee1366 Sustained Interruption
interruptionBehaviour
Interruption Behaviour
inversionTamper
Inversion Tamper
loadInterrupt
Load Interrupt
loadShed
Load Shed
maintenance
Maintenance
physicalTamper
Physical Tamper
powerLossTamper
Power Loss Tamper
powerOutage
Power Outage
powerQuality
Power Quality
powerRestoration
Power Restoration
programmed
Programmed
pushbutton
Push Button
relayActivation
Relay Activation
relayCycle
Relay Cycle (usually expressed as a count)
removalTamper
Removal Tamper
reprogrammingTamper
Reprogramming Tamper
reverseRotationTamper
Reverse Rotation Tamper
switchArmed
Switch Armed
switchDisabled
Switch Disabled
tamper
Tamper
watchdogTimeout
Watchdog Timeout
billLastPeriod
Customer’s bill for the previous billing period (Currency)
billToDate
Customer’s bill, as known thus far within the present billing period (Currency)
billCarryover
Customer’s bill for the (Currency)
connectionFee
Monthly fee for connection to commodity.
audibleVolume
Audible Volume (Sound)
volumetricFlow
Volumetric Flow
Enumeration of phase identifiers. Allows designation of phases for both transmission and distribution equipment, circuits and loads. Residential and small commercial loads are often served from single-phase, or split-phase, secondary circuits. Phases 1 and 2 refer to hot wires that are 180 degrees out of phase, while N refers to the neutral wire. Through single-phase transformer connections, these secondary circuits may be served from one or two of the primary phases A, B, and C. For three-phase loads, use the A, B, C phase codes instead of s12N.
ABCN
ABC to Neutral
ABC
Involving all phases
ABN
AB to Neutral
ACN
Phases A, C and neutral.
BCN
BC to neutral.
AB
Phases A to B
AC
Phases A and C
BC
Phases B to C
AN
Phases A to neutral.
BN
Phases B to neutral.
CN
Phases C to neutral.
A
Phase A.
B
Phase B.
C
Phase C.
N
Neutral
S2N
Phase S2 to neutral.
S12N
Phase S1, S2 to neutral.
S1N
Phase S1 to Neutral
S2
Phase S2.
S12
Phase S1 to S2
S12N
Phase S1, S2 to N
none
Not applicable to any phase
AtoAv
Phase A current relative to Phase A voltage
BAv
Phase B current or voltage relative to Phase A voltage
CAv
Phase C current or voltage relative to Phase A voltage
NG
Neutral to ground
S1
Phase S1
The power of ten unit multipliers.
p
Pico 10**-12
n
Nano 10**-9
micro
Micro 10**-6
m
Milli 10**-3
c
Centi 10**-2
d
Deci 10**-1
k
Kilo 10**3
M
Mega 10**6
G
Giga 10**9
T
Tera 10**12
none
Not Applicable or "x1"
da
deca 10**1
h
hecto 10**2
List of codes indicating the quality of the reading
valid
data that has gone through all required validation checks and either passed them all or has been verified
manually edited
Replaced or approved by a human
estimated using reference day
data value was replaced by a machine computed value based on analysis of historical data using the same type of measurement.
estimated using linear interpolation
data value was computed using linear interpolation based on the readings before and after it
questionable
data that has failed one or more checks
derived
data that has been calculated (using logic or mathematical operations)
projected (forecast)
data that has been calculated as a projection or forecast of future readings
mixed
indicates that the quality of this reading has mixed characteristics
raw
data that has not gone through the validation
normalized for weather
the values have been adjusted to account for weather
other
specifies that a characteristic applies other than those defined
validated
data that has been validated and possibly edited and/or estimated in accordance with approved procedures
verified
data that failed at least one of the required validation checks but was determined to represent actual usage
revenue-quality
data that is valid and acceptable for billing purposes
Kind of service represented by the UsagePoint
electricity
Electricity service.
gas
Gas service.
water
Water service.
time
Time service.
heat
Heat service.
refuse
Refuse (waster) service.
sewerage
Sewerage service.
rates
Rates (e.g. tax, charge, toll, duty, tariff, etc.) service.
tvLicence
TV license service.
internet
Internet service.
Code used to specify a particular type of time interval method for Readings of ReadingType. Valid values per the standard are defined in TimeAttributeType.
none
Not Applicable
tenMinute
10-minute
fifteenMinute
15-minute
oneMinute
1-minute
twentyfourHour
24-hour
thirtyMinute
30-minute
fiveMinute
5-minute
sixtyMinute
60-minute
twoMinute
2-minute
threeMinute
3-minute
present
Within the present period of time
previous
Shifted within the previous monthly cycle and data set
twentyMinute
20-minute interval
fixedBlock60Min
60-minute Fixed Block
fixedBlock30Min
30-minute Fixed Block
fixedBlock20Min
20-minute Fixed Block
fixedBlock15Min
15-minute Fixed Block
fixedBlock10Min
10-minute Fixed Block
fixedBlock5Min
5-minute Fixed Block
fixedBlock1Min
1-minute Fixed Block
rollingBlock60MinIntvl30MinSubIntvl
60-minute Rolling Block with 30-minute sub-intervals
rollingBlock60MinIntvl20MinSubIntvl
60-minute Rolling Block with 20-minute sub-intervals
rollingBlock60MinIntvl15MinSubIntvl
60-minute Rolling Block with 15-minute sub-intervals
rollingBlock60MinIntvl12MinSubIntvl
60-minute Rolling Block with 12-minute sub-intervals
rollingBlock60MinIntvl10MinSubIntvl
60-minute Rolling Block with 10-minute sub-intervals
rollingBlock60MinIntvl6MinSubIntvl
60-minute Rolling Block with 6-minute sub-intervals
rollingBlock60MinIntvl5MinSubIntvl
60-minute Rolling Block with 5-minute sub-intervals
rollingBlock60MinIntvl4MinSubIntvl
60-minute Rolling Block with 4-minute sub-intervals
rollingBlock30MinIntvl15MinSubIntvl
30-minute Rolling Block with 15-minute sub-intervals
rollingBlock30MinIntvl10MinSubIntvl
30-minute Rolling Block with 10-minute sub-intervals
rollingBlock30MinIntvl6MinSubIntvl
30-minute Rolling Block with 6-minute sub-intervals
rollingBlock30MinIntvl5MinSubIntvl
30-minute Rolling Block with 5-minute sub-intervals
rollingBlock30MinIntvl3MinSubIntvl
30-minute Rolling Block with 3-minute sub-intervals
rollingBlock30MinIntvl2MinSubIntvl
30-minute Rolling Block with 2-minute sub-intervals
rollingBlock15MinIntvl5MinSubIntvl
15-minute Rolling Block with 5-minute sub-intervals
rollingBlock15MinIntvl3MinSubIntvl
15-minute Rolling Block with 3-minute sub-intervals
rollingBlock15MinIntvl1MinSubIntvl
15-minute Rolling Block with 1-minute sub-intervals
rollingBlock10MinIntvl5MinSubIntvl
10-minute Rolling Block with 5-minute sub-intervals
rollingBlock10MinIntvl2MinSubIntvl
10-minute Rolling Block with 2-minute sub-intervals
rollingBlock10MinIntvl1MinSubIntvl
10-minute Rolling Block with 1-minute sub-intervals
rollingBlock5MinIntvl1MinSubIntvl
5-minute Rolling Block with 1-minute sub-intervals
[extension] Specific time intervals (e.g., billing period, daily, seasonal, etc) used to identify specific periods of time.
none
Not Applicable
billingPeriod
Captured during the billing period starting at midnight of the first day of the billing period (as defined by the billing cycle day). If during the current billing period, it specifies a period from the start of the current billing period until "now".
daily
Daily Period starting at midnight. If for the current day, this specifies the time from midnight to "now".
monthly
Monthly period starting at midnight on the first day of the month. If within the current month, this specifies the period from the start of the month until "now."
seasonal
A season of time spanning multiple months. E.g. "Summer," "Spring," "Fall," and "Winter" based cycle. If within the current season, it specifies the period from the start of the current season until "now."
weekly
Weekly period starting at midnight on the first day of the week and ending the instant before midnight the last day of the week. If within the current week, it specifies the period from the start of the week until "now."
specifiedPeriod
For the period defined by the start and end of the TimePeriod element in the message.
Code for the base unit of measure for Readings of ReadingType. Used in combination with the powerOfTenMultiplier to specify the actual unit of measure. Valid values per the standard are defined in UomType.
VA
Apparent power, Volt Ampere (See also real power and reactive power.), VA
W
Real power, Watt. By definition, one Watt equals one Joule per second. Electrical power may have real and reactive components. The real portion of electrical power (I²R) or VIcos?, is expressed in Watts. (See also apparent power and reactive power.), W
VAr
Reactive power, Volt Ampere reactive. The “reactive” or “imaginary” component of electrical power (VISin?). (See also real power and apparent power)., VAr
VAh
Apparent energy, Volt Ampere hours, VAh
Wh
Real energy, Watt hours, Wh
VArh
Reactive energy, Volt Ampere reactive hours, VArh
V
Electric potential, Volt (W/A), V
ohm
Electric resistance, Ohm (V/A), O
A
Current, ampere, A
F
Electric capacitance, Farad (C/V), °C
H
Electric inductance, Henry (Wb/A), H
degC
Relative temperature in degrees Celsius. In the SI unit system the symbol is ºC. Electric charge is measured in coulomb that has the unit symbol C. To distinguish degree Celsius from coulomb the symbol used in the UML is degC. Reason for not using ºC is the special character º is difficult to manage in software.
sec
Time, seconds, s
min
Time, minute = s * 60, min
h
Time, hour = minute * 60, h
deg
Plane angle, degrees, deg
rad
Plane angle, Radian (m/m), rad
J
Energy joule, (N·m = C·V = W·s), J
n
Force newton, (kg m/s²), N
siemens
Electric conductance, Siemens (A / V = 1 / O), S
none
N/A, None
Hz
Frequency hertz, (1/s), Hz
g
Mass in gram, g
pa
Pressure, Pascal (N/m²)(Note: the absolute or relative measurement of pressure is implied with this entry. See below for more explicit forms.), Pa
m
Length, meter, m
m2
Area, square meter, m²
m3
Volume, cubic meter, m³
A2
Amps squared, amp squared, A2
A2h
ampere-squared, Ampere-squared hour, A²h
A2s
Amps squared time, square amp second, A²s
Ah
Ampere-hours, Ampere-hours, Ah
APerA
Current, Ratio of Amperages, A/A
APerM
A/m, magnetic field strength, Ampere per metre, A/m
As
Amp seconds, amp seconds, As
b
Sound pressure level, Bel, acoustic, Combine with multiplier prefix “d” to form decibels of Sound Pressure Level“dB (SPL).”, B (SPL)
bm
Signal Strength, Bel-mW, normalized to 1mW. Note: to form “dBm” combine “Bm” with multiplier “d”. Bm
bq
Radioactivity, Becquerel (1/s), Bq
btu
Energy, British Thermal Units, BTU
btuPerH
Power, BTU per hour, BTU/h
cd
Luminous intensity, candela, cd
char
Number of characters, characters, char
HzPerSec
Rate of change of frequency, hertz per second, Hz/s
code
Application Value, encoded value, code
cosTheta
Power factor, Dimensionless, cos?
count
Amount of substance, counter value, count
ft3
Volume, cubic feet, ft³
ft3compensated
Volume, cubic feet, ft³(compensated)
ft3compensatedPerH
Volumetric flow rate, compensated cubic feet per hour, ft³(compensated)/h
gM2
Turbine inertia, gram·meter2 (Combine with multiplier prefix “k” to form kg·m2.), gm²
gPerG
Concentration, The ratio of the mass of a solute divided by the mass of the solution., g/g
gy
Absorbed dose, Gray (J/kg), GY
HzPerHz
Frequency, Rate of frequency change, Hz/Hz
charPerSec
Data rate, characters per second, char/s
imperialGal
Volume, imperial gallons, ImperialGal
imperialGalPerH
Volumetric flow rate, Imperial gallons per hour, ImperialGal/h
jPerK
Heat capacity, Joule/Kelvin, J/K
jPerKg
Specific energy, Joules / kg, J/kg
K
Temperature, Kelvin, K
kat
Catalytic activity, katal = mol / s, kat
kgM
Moment of mass ,kilogram meter (kg·m), M
kgPerM3
Density, gram/cubic meter (combine with prefix multiplier “k” to form kg/ m³), g/m³
litre
Volume, litre = dm3 = m3/1000., L
litreCompensated
Volume, litre, with the value compensated for weather effects, L(compensated)
litreCompensatedPerH
Volumetric flow rate, litres (compensated) per hour, L(compensated)/h
litrePerH
Volumetric flow rate, litres per hour, L/h
litrePerLitre
Concentration, The ratio of the volume of a solute divided by the volume of the solution., L/L
litrePerSec
Volumetric flow rate, Volumetric flow rate, L/s
litreUncompensated
Volume, litre, with the value uncompensated for weather effects., L(uncompensated)
litreUncompensatedPerH
Volumetric flow rate, litres (uncompensated) per hour, L(uncompensated)/h
lm
Luminous flux, lumen (cd sr), Lm
lx
Illuminance lux, (lm/m²), L(uncompensated)/h
m2PerSec
Viscosity, meter squared / second, m²/s
m3compensated
Volume, cubic meter, with the value compensated for weather effects., m3(compensated)
m3compensatedPerH
Volumetric flow rate, compensated cubic meters per hour, ³(compensated)/h
m3PerH
Volumetric flow rate, cubic meters per hour, m³/h
m3PerSec
m3PerSec, cubic meters per second, m³/s
m3uncompensated
m3uncompensated, cubic meter, with the value uncompensated for weather effects., m3(uncompensated)
m3uncompensatedPerH
Volumetric flow rate, uncompensated cubic meters per hour, m³(uncompensated)/h
meCode
EndDeviceEvent, value to be interpreted as a EndDeviceEventCode, meCode
mol
Amount of substance, mole, mol
molPerKg
Concentration, Molality, the amount of solute in moles and the amount of solvent in kilograms., mol/kg
molPerM3
Concentration, The amount of substance concentration, (c), the amount of solvent in moles divided by the volume of solution in m³., mol/ m³
molPerMol
Concentration, Molar fraction (?), the ratio of the molar amount of a solute divided by the molar amount of the solution.,mol/mol
money
Monetary unit, Generic money (Note: Specific monetary units are identified the currency class)., ¤
mPerM
Length, Ratio of length, m/m
mPerM3
Fuel efficiency, meters / cubic meter, m/m³
mPerSec
Velocity, meters per second (m/s), m/s
mPerSec2
Acceleration, meters per second squared, m/s²
ohmM
resistivity, ? (rho), ?m
paA
Pressure, Pascal, absolute pressure, PaA
paG
Pressure, Pascal, gauge pressure, PaG
psiA
Pressure, Pounds per square inch, absolute, psiA
psiG
Pressure, Pounds per square inch, gauge, psiG
q
Quantity power, Q, Q
q45
Quantity power, Q measured at 45º, Q45
q45h
Quantity energy, Q measured at 45º, Q45h
q60
Quantity power, Q measured at 60º, Q60
q60h
Quantity energy, Qh measured at 60º, Q60h
qh
Quantity energy, Qh, Qh
radPerSec
Angular velocity, radians per second, rad/s
rev
Amount of rotation, Revolutions, rev
revPerSec
Rotational speed, Rotations per second, rev/s
secPerSec
Time, Ratio of time (can be combined with an multiplier prefix to show rates such as a clock drift rate, e.g. “µs/s”), s/s
sr
Solid angle, Steradian (m2/m2), sr
status
State, "1" = "true", "live", "on", "high", "set"; "0" = "false", "dead", "off", "low", "cleared". Note: A Boolean value is preferred but other values may be supported, status
sv
Doe equivalent, Sievert (J/kg), Sv
t
Magnetic flux density, Tesla (Wb/m2), T
therm
Energy, Therm, therm
timeStamp
Timestamp, time and date per ISO 8601 format, timeStamp
usGal
Volume, US gallons, Gal
usGalPerH
Volumetric flow rate, US gallons per hour, USGal/h
V2
Volts squared, Volt squared (W2/A2), V²
V2h
volt-squared hour, Volt-squared-hours, V²h
VAhPerRev
Kh-Vah, apparent energy metering constant, VAh/rev
VArhPerRev
Kh-VArh, reactive energy metering constant, VArh/rev
VPerHz
Magnetic flux, Volts per Hertz, V/Hz
VPerV
Voltage, Ratio of voltages (e.g. mV/V), V/V
Vs
Volt seconds, Volt seconds (Ws/A), Vs
wb
Magnetic flux, Weber (V s), Wb
WhPerM3
Wh/m3, energy per volume, Wh/m³
WhPerRev
Kh-Wh, active energy metering constant, Wh/rev
wPerMK
Thermal conductivity, Watt/meter Kelvin, W/m K
WPerSec
Ramp rate, Watts per second, W/s
WPerVA
Power Factor, PF, W/VA
WPerW
Signal Strength, Ratio of power, W/W
indicates the status code of the associated transaction
Ok
Ok
Created
Created
Accepted
Accepted
No Content
No Content
Moved Permanently
Moved Permanently
Redirect
Redirect
Not Modified
Not Modified
Bad Request
Bad Request
Unauthorized
Unauthorized
Forbidden
Forbidden
Not Found
Not Found
Method Not Allowed
Method Not Allowed
Gone
Gone
Internal Server Error
Internal Server Error
Specifies the operation requested of this item
Create
Create
Read
Read
Update
Update
Delete
Delete
A code indicating the current status of the application. This value is provided by Data Custodian, cannot be modified by Third Party.
Review
Review
Production (Live)
Production (Live)
On Hold
On Hold
Revoked
Revoked
A code indicating the current status of the application
Development
Development
ReviewTest
Review/Test
Production
Live
Retired
Remove
A code indicating the type of application
Web
The application is on the web
Desktop
The application is on a desktop
Mobile
The application is on a mobile device
Device
The application is on another device
A code indicating the expected use of the application.
EnergyManagement
Energy Management
Comparisons
Analytical
Government
Governmental
Academic
Academic
LawEnforcement
Law Enforcement
A code indicating the status of an Authorization
Revoked
Revoked
Active
Active
Denied
Denied
The current status of the service
Unavailable
Unavailable
Normal
Normal; operational
Lifecycle states of the metering installation at a usage point with respect to readiness for billing via advanced metering infrastructure reads.
Usage point is equipped with an AMI capable meter that is not yet currently equipped with a communications module.
Usage point is equipped with an AMI capable meter; however, the AMI functionality has been disabled or is not being used.
Usage point is equipped with an operating AMI capable meter and accuracy has been certified for billing purposes.
Usage point is equipped with an AMI capable meter having communications capability.
Usage point is equipped with a non AMI capable meter.
Usage point is not currently equipped with a meter.
Usage point is equipped with an AMI capable meter that is functioning and communicating with the AMI network.
State of the usage point with respect to connection to the network.
The usage point is connected to the network and able to receive or send the applicable commodity (electricity, gas, water, etc.).
The usage point has been disconnected through operation of a disconnect function within the meter present at the usage point. The usage point is unable to receive or send the applicable commodity (electricity, gas, water, etc.) A logical disconnect can often be achieved without utilising a field crew.
The usage point has been disconnected from the network at a point upstream of the meter. The usage point is unable to receive or send the applicable commodity (electricity, gas, water, etc.). A physical disconnect is often achieved by utilising a field crew.
[extension] Bit map encoded rule from which is calculated the start or end time, within the current year, to which daylight savings time offset must be applied.
The rule encoding:
Bits 0 - 11: seconds 0 - 3599
Bits 12 - 16: hours 0 - 23
Bits 17 - 19: day of the week 0 = not applicable, 1 - 7 (Monday = 1)
Bits:20 - 24: day of the month 0 = not applicable, 1 - 31
Bits: 25 - 27: operator (detailed below)
Bits: 28 - 31: month 1 - 12
Rule value of 0xFFFFFFFF means rule processing/DST correction is disabled.
The operators:
0: DST starts/ends on the Day of the Month
1: DST starts/ends on the Day of the Week that is on or after the Day of the Month
2: DST starts/ends on the first occurrence of the Day of the Week in a month
3: DST starts/ends on the second occurrence of the Day of the Week in a month
4: DST starts/ends on the third occurrence of the Day of the Week in a month
5: DST starts/ends on the forth occurrence of the Day of the Week in a month
6: DST starts/ends on the fifth occurrence of the Day of the Week in a month
7: DST starts/ends on the last occurrence of the Day of the Week in a month
An example: DST starts on third Friday in March at 1:45 AM. The rule...
Seconds: 2700
Hours: 1
Day of Week: 5
Day of Month: 0
Operator: 4
Month: 3
Aggregate Node Types for example:
AG - Aggregated Generation
CPZ - Custom Price Zone
DPZ - Default Price Zone
LAP - Load Aggregation Point
TH - Trading Hub
SYS - System Zone
CA - Control Area
GA - generic aggregation
EHV - 500 kV
GH - generic hub
ZN - zone
INT - Interface
BUS - Bus
Aggregated Generation
Custom Price Zone
Default Price Zone
Load Aggregation Point
Trading Hub
System Zone
Control Area
Designated Congestion Area
generic aggregation
generic hub
500 kV - Extra High Voltage aggregate price nodes
Zone
Interface
Bus
Aggregated Nodes Types for example:
- SYS - System Zone/Region;
- RUC - RUC Zone;
- LFZ - Load Forecast Zone;
- REG - Market Energy/Ancillary Service Region;
- AGR - Aggregate Generation Resource;
- POD - Point of Delivery;
- ALR - Aggregate Load Resource;
- LTAC - Load TransmissionAccessCharge (TAC) Group;
- ACA - Adjacent Control Area
- ASR - Aggregated System Resource
- ECA - Embedded Control Area
System Zone/Region;
RUC Zone
Load Forecast Zone
Market Energy/Ancillary Service Region;
Aggregate Generation Resource;
Point of Delivery;
Aggregate Load Resource;
Load TransmissionAccessCharge (TAC) Group;
Adjacent Control Area
Aggregated System Resource
Embedded Control Area
[extension] Type of billing tariff profile uses
Time of Use
Consumption Peak Period
Consumption Tier
For example:
'Y' - Participates in both LMPM and SMPM
'N' - Not included in LMP price measures
'S' - Participates in SMPM price measures
'L' - Participates in LMPM price measures
Participates in both LMPM and SMPM
Not included in LMP price measures
Participates in SMPM price measures
Participates in LMPM price measures
[extension] Current Tariff Rider enrollment status
Currently NOT enrolled in Tariff Rider
Currently enrolled in the Tariff Rider
Currently pending enrollment in Tariff Rider