Single Service Usage Summary for a date range
post
https://server:port/spl/rest/apis/customer/usage/usageData/singleServiceSummary
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
billDate: string
(date)
The business date that was used when the bill was generated.
-
drillDownAvailable: boolean
Flag to indicate whether drill down to more granular usage values such as daily or hourly values are available. Drill Down Available is true only when SA type's Special Role Flag is 'BD' otherwise, false.Example:
true
-
endDate: string
(date)
The end date for the service agreement.Example:
2022-12-20
-
peakIndicator: boolean
Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.Example:
false
-
serviceAgreementId: string
Maximum Length:
10
The bill segment's service agreement unique identifier. -
startDate: string
(date)
The start date for the service agreement.Example:
2022-12-20
-
timeScale: string
Allowed Values:
[ "C1BP", "C1HR", "C1WK", "C1YR" ]
The time scale definition defines the length of time covered by each usage group - ranging from the usage from a bill period down to hourly usage values. * `C1BP` - Bill Period View, * `C1HR` - Hourly View, * `C1WK` - Week View, * `C1YR` - Year ViewExample:C1BP
-
unitOfMeasure: string
Maximum Length:
30
The unit of measure of the bill segments' service quantity.Example:KWH
Root Schema : schema
Type:
Show Source
object
-
billDate: string
(date)
The business date that was used when the bill was generated.
-
drillDownAvailable: boolean
Flag to indicate whether drill down to more granular usage values such as daily or hourly values are available. Drill Down Available is true only when SA type's Special Role Flag is 'BD' otherwise, false.Example:
true
-
endDate: string
(date)
The end date for the service agreement.Example:
2022-12-20
-
peakIndicator: boolean
Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.Example:
false
-
serviceAgreementId: string
Maximum Length:
10
The bill segment's service agreement unique identifier. -
startDate: string
(date)
The start date for the service agreement.Example:
2022-12-20
-
timeScale: string
Allowed Values:
[ "C1BP", "C1HR", "C1WK", "C1YR" ]
The time scale definition defines the length of time covered by each usage group - ranging from the usage from a bill period down to hourly usage values. * `C1BP` - Bill Period View, * `C1HR` - Hourly View, * `C1WK` - Week View, * `C1YR` - Year ViewExample:C1BP
-
unitOfMeasure: string
Maximum Length:
30
The unit of measure of the bill segments' service quantity.Example:KWH
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1GetBiUsg
Type:
Show Source
object
-
drillDownAvailable: boolean
Flag to indicate whether drill down to more granular usage values such as daily or hourly values are available. Drill Down Available is true only when SA type's Special Role Flag is 'BD' otherwise, false.Example:
true
-
peakIndicator: boolean
Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.Example:
false
-
serviceAgreementId: string
Maximum Length:
10
The bill segment's service agreement unique identifier. -
timeZone: string
Maximum Length:
50
The Olson timezone name as defined in the Utility's installation setting that indicates when the usage occurred. -
unitOfMeasure: string
Maximum Length:
30
The unit of measure of the bill segments' service quantity.Example:KWH
-
usageDetails: array
usageDetails
Nested Schema : usagePeriod
Type:
Show Source
object
-
billDate: string
(date)
The business date that was used when the bill was generated.
-
endDateTime: string
(date-time)
The end datetime is the end point for the for a usage calculation in the group.Example:
1999-07-31
-
group: string
Maximum Length:
30
The Usage Group is a label for the specific time period that has been summarized in the groupExample:2020-05-01T00:00:00-07:00
-
startDateTime: string
(date-time)
The start datetime is the beginning point for the usage calculation in the groupExample:
1998-07-31
-
usage: array
usage
Nested Schema : items
Type:
Show Source
object
-
sqi: string
Maximum Length:
30
Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.Example:DAMT (Daily Amount)
-
tou: string
Maximum Length:
30
The time-of-use classification of the bill segment's service quantity.Example:OFF
-
usageIdentifier: string
Maximum Length:
100
An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.Example:KWH--(UOM-TOU-SQI)
-
usageValue: number
Minimum Value:
0
Maximum Value:9999.999999
The total usage value. Refer to the defined unit of measure for complete context of this value.Example:31743.8
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.