Multi-Account Usage Summary for a date range
post
https://server:port/spl/rest/apis/customer/usage/usageData/multiAccountSummary
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accounts: array
accounts
-
endDate: string
(date)
The end date for the service agreement.Example:
2022-12-20
-
filters: array
filters
-
startDate: string
(date)
The start date for the service agreement.Example:
2022-12-20
Nested Schema : items
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The unique identifier of the account for the customer who is responsible for the bill.Example:2335597500
Nested Schema : items
Type:
Show Source
object
-
serviceType: string
Maximum Length:
80
The type of service associated with the service agreement.Example:W
-
unitOfMeasure: string
Maximum Length:
30
The unit of measure of the bill segments's usage value.Example:KWH
Root Schema : schema
Type:
Show Source
object
-
accounts: array
accounts
-
endDate: string
(date)
The end date for the service agreement.Example:
2022-12-20
-
filters: array
filters
-
startDate: string
(date)
The start date for the service agreement.Example:
2022-12-20
Nested Schema : items
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The unique identifier of the account for the customer who is responsible for the bill.Example:2335597500
Nested Schema : items
Type:
Show Source
object
-
serviceType: string
Maximum Length:
80
The type of service associated with the service agreement.Example:W
-
unitOfMeasure: string
Maximum Length:
30
The unit of measure of the bill segments's usage value.Example:KWH
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
firstBillDate: string
(date)
The date of the earliest bill found in the requested timeframe.Example:
2000-09-01
-
lastBillDate: string
(date)
The date of the latest bill found in the requested timeframe.Example:
2000-01-01
-
usageDetails: array
usageDetails
-
usageFound: boolean
The Usage found flag indicates that usage data was available in the requested timeframe.Example:
Y
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
The unique identifier of the account for the customer who is responsible for the bill.Example:2335597500
Nested Schema : items
Type:
Show Source
object
-
peakIndicator: string
Maximum Length:
1
Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.Example:false
-
serviceType: object
serviceType
The type of service associated with the service agreement.
-
unitOfMeasure: string
Maximum Length:
30
The unit of measure of the bill segments's usage value.Example:KWH
-
usage: array
usage
Nested Schema : serviceType
Type:
object
The type of service associated with the service agreement.
Show Source
-
_link: string
_link
-
serviceType: string
Maximum Length:
80
The type of service associated with the service agreement.Example:W
Nested Schema : items
Type:
Show Source
object
-
serviceQuantityIdentifer: 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)
-
timeOfUse: 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.