Create Usage Transaction
post
https://server:port/ouaf/rest/apis/meter/usage/usageTransactions/
This Operation handles the Integration Suite API to Create Usage Transaction.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
alignmentDateTime: string
(date-time)
Alignment Date/Time
-
automatedRetry: string
Allowed Values:
[ "D1NA", "D1NO", "D1YS" ]
A flag that indicates if creation of the usage transaction should be automatically retried in the event of an error. * `D1NA` - No - Automatic Discard, * `D1NO` - No, * `D1YS` - YesExample:D1NA
-
billCondition: string
Allowed Values:
[ "D2CL", "D2IC", "D2IL", "D2IM" ]
The status of the bill associated with the usage transaction (if applicable), used for informational purposes only. * `D2CL` - Closing, * `D2IC` - Initial and Closing, * `D2IL` - Initial, * `D2IM` - InterimExample:D2IL
-
calculationGroup: object
calculationGroup
-
calculationMode: string
Allowed Values:
[ "D2HC" ]
A flag that indicates the mode in which the usage transaction calculations are/were performed. * `D2HC` - Hypothetical CalculationExample:D2HC
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
254
comments -
currentToDoId: string
Maximum Length:
14
To Do ID -
dateBreaks: object
dateBreaks
-
deferCalculation: string
Allowed Values:
[ "D2NO", "D2YS" ]
Defer Calculation: * `D2NO` - No, * `D2YS` - Yes -
endDateTime: string
(date-time)
End Date/Time
-
estimateThroughDate: string
(date)
Estimate Through DateExample:
07-01-2017
-
exceptions: object
exceptions
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:DELT
-
initialCalculation: boolean
Initial CalculationExample:
true
-
intervalMeasuringComponent: object
intervalMeasuringComponent
-
isTraceOn: string
Allowed Values:
[ "D1NO", "D1YS" ]
Indicates if tracing is on for the usage transaction. * `D1NO` - Off, * `D1YS` - OnExample:D1YS
-
linkedToFrozenBillSegment: string
Allowed Values:
[ "D1NO", "D1YS" ]
This flag indicates (Yes or No) whether or not the usage transaction is linked to a frozen bill segment. * `D1NO` - No, * `D1YS` - YesExample:D1NO
-
measurementCycle: object
measurementCycle
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
-
measurementCycleRoute: string
Maximum Length:
30
Route specifies the group of service points in a cycle that are visited by a meter reader. -
nextActions: object
nextActions
-
nextRetryDateTime: string
(date-time)
Next Retry Date/Time
-
previousToDoId: string
Maximum Length:
14
To Do ID -
previousUsageTransaction: object
previousUsageTransaction
-
requestMode: string
Allowed Values:
[ "D2BB", "D2OB" ]
Request * `D2BB` - Batch, * `D2OB` - OnlineExample:D2BB
-
retryUntilDateTime: string
(date-time)
The date time until which the system will attempt to retry creating the usage transaction in the event of an error (applicable only if the Automated Retry flag is set to "Yes").
-
scalarMeasuringComponent: object
scalarMeasuringComponent
-
scheduledSelectionDate: string
(date)
Scheduled Selection Date
-
serviceQuantitiesData: object
serviceQuantitiesData
-
skipDetails: object
skipDetails
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
status: string
Maximum Length:
12
Status -
subUsageToDoIds: object
subUsageToDoIds
-
subUsageTransactionExist: string
Allowed Values:
[ "D2NO", "D2YS" ]
Sub Usage Transactions flag * `D2NO` - No, * `D2YS` - YesExample:D2NO
-
subUsageTransactions: object
subUsageTransactions
-
traces: object
traces
-
usageAdjustmentProfileFactors: object
usageAdjustmentProfileFactors
-
usageExternalId: string
Maximum Length:
60
An ID used by external systems used to identify the usage transaction .When Oracle Utilities Meter Data Management is integrated with Oracle Utilities Customer Care and Billing, Oracle Utilities Customer Care and Billing can send this to help identify the previous usage transaction. -
usagePeriods: object
usagePeriods
-
usageSubscription: object
usageSubscription
-
usageTransactionId: string
Maximum Length:
14
Usage Transaction ID is a system assigned random number that stays with a usage transaction record.Example:05458709929330
-
usageTransactionReadingDetails: object
usageTransactionReadingDetails
-
usageType: string
Allowed Values:
[ "D2CS", "D2IN", "D2IS", "D2PS", "D2SC", "D2SF" ]
Usage Type flag * `D2CS` - Correlated SQ, * `D2IN` - Frequently Read, * `D2IS` - Frequently Read and Manually Read Scalar, * `D2PS` - Profiled SQ, * `D2SC` - Manually Read Scalar, * `D2SF` - Deprecated - Scalar For Calculation Purposes OnlyExample:D2CS
-
usedOnBill: string
Allowed Values:
[ "D1NO", "D1YS" ]
This flag indicates (Yes or No) whether or not the usage transaction's service quantities have been used on a completed bill. * `D1NO` - No, * `D1YS` - YesExample:D1YS
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:2
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : intervalMeasuringComponent
Type:
Show Source
object
-
endDateTimeFrom: string
(date-time)
Defines the start date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
endDateTimeTo: string
(date-time)
Defines the end date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
Nested Schema : measurementCycle
Type:
object
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
Show Source
-
measurementCycle: string
Maximum Length:
30
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
Nested Schema : previousUsageTransaction
Type:
Show Source
object
-
previousUsageTransactionId: string
Maximum Length:
14
Usage Transaction ID
Nested Schema : scalarMeasuringComponent
Type:
Show Source
object
-
allowEstimate: string
Allowed Values:
[ "D2AE", "D2DE" ]
Allow Estimate indicates whether or not to allow use of estimated measurement data when calculating usage. * `D2AE` - Allow Estimates, * `D2DE` - Do Not Allow EstimatesExample:D2AE
-
endDateTimeFrom: string
(date-time)
Defines the start date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
endDateTimeTo: string
(date-time)
Defines the end date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
endRangeOption: string
Allowed Values:
[ "D2SC", "D2SP" ]
End Range Option indicates the end range option. Valid values include "Specified" and "Derive Using Service Cycle Schedule" * `D2SC` - Derive Using Service Cycle Schedule, * `D2SP` - SpecifiedExample:D2SC
-
estimateDate: string
(date)
Estimate Date indicates the date on which estimated measurement data used in the usage calculation was estimated.
-
estimateTime: string
Allowed Values:
[ "D1EF", "D1ET" ]
Estimate Time * `D1EF` - End Date Time From, * `D1ET` - End Date Time ToExample:D1EF
-
isEstimate: string
Allowed Values:
[ "D2NO", "D2YS" ]
Is Estimate indicates if estimated measurement data was used in the usage calculation. * `D2NO` - No, * `D2YS` - YesExample:D2NO
-
maxDaysOffset: number
Minimum Value:
-999
Maximum Value:999
Minimum Offset Days / Maximum Offset Days are used when End Range Option is set to "Dervice Using Service Cycle Schedule", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date. -
minDaysOffset: number
Minimum Value:
-999
Maximum Value:999
Minimum Offset Days / Maximum Offset Days are used when End Range Option is set to "Dervice Using Service Cycle Schedule", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date. -
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
Nested Schema : skipDetails
Type:
Show Source
object
-
nextScheduledReadDate: string
(date)
The next scheduled read date for the device from which the measurements used to create the usage transaction came.
-
skip: string
Allowed Values:
[ "D2NO", "D2YS" ]
A flag that indicates if the usage transaction should be skipped. * `D2NO` - No, * `D2YS` - YesExample:D2NO
-
skipReason: string
Allowed Values:
[ "D2NS" ]
Reason for skipping the usage transaction. * `D2NS` - No Scheduled ReadExample:D2NS
Nested Schema : usageSubscription
Type:
Show Source
object
-
usageSubscriptionId: string
Maximum Length:
12
Usage Subscription
Nested Schema : items
Type:
Show Source
object
-
adhocCharacteristicValue: string
Maximum Length:
254
Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite.Example:77
-
characteristicType: object
characteristicType
-
characteristicValue: string
Maximum Length:
16
Characteristic Value Indicate the value of the characteristic.Example:ADV
-
characteristicValueForeignKey: object
characteristicValueForeignKey
-
effectiveDate: string
(date)
Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValueForeignKey
Type:
Show Source
object
-
id: string
(characteristicValueForeignKey1)
Nested Schema : items
Type:
Show Source
object
-
dateBreak: string
(date)
Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the usage transaction (and its related account).
Nested Schema : items
Type:
Show Source
object
-
exceptionRequiresApproval: string
Allowed Values:
[ "D1NO", "D1YS" ]
Exception Requires Approval flag * `D1NO` - No, * `D1YS` - YesExample:D1NO
-
exceptionSeverity: string
Allowed Values:
[ "D1IF", "D1IS", "D1TM" ]
Exception Severity * `D1IF` - Information, * `D1IS` - Issues, * `D1TM` - TerminateExample:D1IF
-
exceptionType: string
Maximum Length:
30
Exception Type -
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application Framework. -
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageParameters: object
messageParameters
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence -
toDoRole: string
Maximum Length:
10
To Do Role -
toDoType: string
Maximum Length:
8
To Do Type -
usageGroup: string
Maximum Length:
30
Usage group used to calculate usage transactions (e.g., bill determinants)Example:ZZS-MRULEGRP-SCALAR-ITEM
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
Nested Schema : items
Type:
Show Source
object
-
parameter: string
Maximum Length:
2000
Message Parameter Value -
parameterType: string
Allowed Values:
[ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameterExample:AMT
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Message Parameter Sequence
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Nested Schema : items
Type:
Show Source
object
-
periodSequenceNumber: number
Minimum Value:
-999
Maximum Value:999
Period Sequence Number -
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
serviceQuantityDataDateTime: string
(date-time)
Service Quantity Data Date/Time
-
serviceQuantityIntervalCondition: string
Maximum Length:
254
Service Quantity Interval Condition -
serviceQuantitySequenceNumber: number
Minimum Value:
-99999
Maximum Value:99999
Service Quantity Sequence
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: object
calculationGroup
-
endDateTime: string
(date-time)
(endDateTime)
-
startDateTime: string
(date-time)
(startDateTime)
-
subUsageTransactionId: string
(subUsageTransactionId)
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : items
Type:
Show Source
object
-
criteriaSequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
duration: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Duration -
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application Framework. -
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageParameters: object
messageParameters
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence -
usageGroup: string
Maximum Length:
30
Usage group used to calculate usage transactions (e.g., bill determinants)Example:ZZS-MRULEGRP-SCALAR-ITEM
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
Nested Schema : items
Type:
Show Source
object
-
parameter: string
Maximum Length:
2000
Message Parameter Value -
parameterType: string
Allowed Values:
[ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameterExample:AMT
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Message Parameter Sequence
Nested Schema : items
Type:
Show Source
object
-
profileFactor: string
Maximum Length:
30
Factor -
value: string
Maximum Length:
16
Factor Characteristic Value
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
End Date/Time
-
itemDetail: object
itemDetail
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Period Sequence Number -
serviceQuantities: object
serviceQuantities
-
sqsEstimationIndicators: object
sqsEstimationIndicators
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
usageType: string
Allowed Values:
[ "D2CS", "D2IN", "D2IS", "D2PS", "D2SC", "D2SF" ]
Usage Type flag * `D2CS` - Correlated SQ, * `D2IN` - Frequently Read, * `D2IS` - Frequently Read and Manually Read Scalar, * `D2PS` - Profiled SQ, * `D2SC` - Manually Read Scalar, * `D2SF` - Deprecated - Scalar For Calculation Purposes OnlyExample:D2CS
Nested Schema : items
Type:
Show Source
object
-
badgedItem: object
badgedItem
-
calculationGroup: object
calculationGroup
-
endDateTime: string
(date-time)
End Date/Time
-
itemCount: number
Minimum Value:
-9.9999999999E8
Maximum Value:9.9999999999E8
Item Count -
itemDetailsSeq: number
Minimum Value:
0
Maximum Value:99999
Item Detail Sequence -
itemType: object
itemType
-
overrideQuantity: string
Allowed Values:
[ "D1OP" ]
Override Quantity flag * `D1OP` - Override Quantity PresentExample:D1OP
-
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
servicePoint: object
servicePoint
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
uom: object
uom
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
Nested Schema : badgedItem
Type:
Show Source
object
-
badgedItemId: string
Maximum Length:
12
Device ID
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: object
calculationGroup
-
calculationRule: object
calculationRule
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
estimationIndicator: string
Allowed Values:
[ "D2ES", "D2NE" ]
Estimation Indicator * `D2ES` - Estimated, * `D2NE` - Not Estimated -
factor: object
factor
-
intervalData: string
Allowed Values:
[ "D1EX", "D1NE" ]
Interval Data: * `D1EX` - Exist, * `D1NE` - Does Not Exist -
measuringComponent: object
measuringComponent
-
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
secondsPerInterval: integer
Interval Size
-
servicePoint: object
servicePoint
-
shouldExtractIntervalData: string
Allowed Values:
[ "D1NO", "D1YS" ]
Extract Interval Data: * `D1NO` - No, * `D1YS` - Yes -
sqi: object
sqi
-
sqSequence: number
Minimum Value:
-99999
Maximum Value:99999
Service Quantity Sequence -
sqType: string
Allowed Values:
[ "D1FC", "D1IT", "D1MC", "D1OT", "D1PK", "D1SU" ]
Usage Service Quantity Type * `D1FC` - Factor, * `D1IT` - Item, * `D1MC` - Measuring Component, * `D1OT` - Other, * `D1PK` - Peak Across Usage Periods, * `D1SU` - SummationExample:D1FC
-
tou: object
tou
-
touMap: object
touMap
-
uom: object
uom
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : calculationRule
Type:
Show Source
object
-
calculationRule: string
Maximum Length:
30
Calculation Rule
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
characteristicValue: string
Maximum Length:
16
Characteristic Value
Nested Schema : measuringComponent
Type:
Show Source
object
-
measuringComponentId: string
Maximum Length:
12
Measuring Component ID
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : sqi
Type:
Show Source
object
-
sqi: string
Maximum Length:
30
Service Quantity Identifier
Nested Schema : items
Type:
Show Source
object
-
estimationIndicator: string
Allowed Values:
[ "D2ES", "D2NE" ]
Estimation Indicator * `D2ES` - Estimated, * `D2NE` - Not Estimated -
sqi: object
sqi
-
tou: object
tou
-
uom: object
uom
Nested Schema : sqi
Type:
Show Source
object
-
sqi: string
Maximum Length:
30
Service Quantity Identifier
Nested Schema : items
Type:
Show Source
object
-
appliedMultiplier: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Applied MultiplierExample:123.000000
-
calculationGroup: object
calculationGroup
-
endDateTime: string
(date-time)
End Date/Time
-
endMeasurement: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
End MeasurementExample:0.080000
-
endMeasurementCondition: string
Allowed Values:
[ "102000", "ZZ-test-mark1", "100000", "901000", "ZZBUG", "402000", "201000", "ZZ-500001", "501000", "ZZ-301024", "ZZ-301022", "101500", "ZZ-301501", "ZZ-401000", "ZZ-301515", "ZZ-301514", "ZZ-301513", "101000", "409000", "401000", "zz-test3", "ZZ-TestBug", "zz-test5", "ZZ-301031", "ZZ-301491", "100500", "ZZ-301511", "ZZ-TEST-AGAIN", "301000", "ZZ_Test211" ]
Condition: * `102000` - No Read - Disconnected, * `ZZ-test-mark1` - zz-test-mark1, * `100000` - No Read - System, * `901000` - Super, * `ZZBUG` - Override description, * `402000` - Office Estimate, * `201000` - Missing, * `ZZ-500001` - Prorated, * `501000` - Regular, * `ZZ-301024` - ZZ Estimate - Interval Interpolation, * `ZZ-301022` - ZZ Estimate - Interval Averaging, * `101500` - No Read - Outage Fill, * `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read, * `ZZ-401000` - ZZ-External Estimate, * `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read, * `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval, * `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar, * `101000` - No Read - Outage, * `409000` - Combined Quantity, * `401000` - External Estimate, * `zz-test3` - Override description, * `ZZ-TestBug` - ZZ-TestBug-Override description, * `zz-test5` - zz test 5, * `ZZ-301031` - ZZ Estimate - Int Adj From Scalar, * `ZZ-301491` - ZZ Estimate - Scalar Estimation, * `100500` - No Read - Field, * `ZZ-301511` - ZZ Scalar Proration from Estimation Read, * `ZZ-TEST-AGAIN` - ZZ-TEST ONLY, * `301000` - System Estimate, * `ZZ_Test211` - ZZ_Test211-UPD -
finalQuantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Final QuantityExample:9.840000
-
finalSqi: object
finalSqi
-
finalTou: object
finalTou
-
finalUom: object
finalUom
-
mcHowToUse: string
Allowed Values:
[ "+ ", "- ", "C ", "P " ]
How To Use * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - PeakExample:P
-
measuresPeakQuantity: string
Allowed Values:
[ "D1DP", "D1MP" ]
Measures Peak Quantity * `D1DP` - No, * `D1MP` - YesExample:D1DP
-
measuringComponentId: string
Maximum Length:
12
Measuring Component IDExample:658852900520
-
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
servicePoint: object
servicePoint
-
spHowToUse: string
Allowed Values:
[ "D1AD", "D1CK", "D1ST" ]
Usage: * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - Subtract -
sqi: object
sqi
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
startMeasurement: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Start MeasurementExample:0.000000
-
startMeasurementCondition: string
Allowed Values:
[ "102000", "ZZ-test-mark1", "100000", "901000", "ZZBUG", "402000", "201000", "ZZ-500001", "501000", "ZZ-301024", "ZZ-301022", "101500", "ZZ-301501", "ZZ-401000", "ZZ-301515", "ZZ-301514", "ZZ-301513", "101000", "409000", "401000", "zz-test3", "ZZ-TestBug", "zz-test5", "ZZ-301031", "ZZ-301491", "100500", "ZZ-301511", "ZZ-TEST-AGAIN", "301000", "ZZ_Test211" ]
Start Measurement Condition * `102000` - No Read - Disconnected, * `ZZ-test-mark1` - zz-test-mark1, * `100000` - No Read - System, * `901000` - Super, * `ZZBUG` - Override description, * `402000` - Office Estimate, * `201000` - Missing, * `ZZ-500001` - Prorated, * `501000` - Regular, * `ZZ-301024` - ZZ Estimate - Interval Interpolation, * `ZZ-301022` - ZZ Estimate - Interval Averaging, * `101500` - No Read - Outage Fill, * `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read, * `ZZ-401000` - ZZ-External Estimate, * `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read, * `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval, * `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar, * `101000` - No Read - Outage, * `409000` - Combined Quantity, * `401000` - External Estimate, * `zz-test3` - Override description, * `ZZ-TestBug` - ZZ-TestBug-Override description, * `zz-test5` - zz test 5, * `ZZ-301031` - ZZ Estimate - Int Adj From Scalar, * `ZZ-301491` - ZZ Estimate - Scalar Estimation, * `100500` - No Read - Field, * `ZZ-301511` - ZZ Scalar Proration from Estimation Read, * `ZZ-TEST-AGAIN` - ZZ-TEST ONLY, * `301000` - System Estimate, * `ZZ_Test211` - ZZ_Test211-UPDExample:501000
-
tou: object
tou
-
uom: object
uom
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
-
usePercent: number
Minimum Value:
-999
Maximum Value:999
Use percentExample:100
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : sqi
Type:
Show Source
object
-
sqi: string
Maximum Length:
30
Service Quantity Identifier
Root Schema : schema
Type:
Show Source
object
-
alignmentDateTime: string
(date-time)
Alignment Date/Time
-
automatedRetry: string
Allowed Values:
[ "D1NA", "D1NO", "D1YS" ]
A flag that indicates if creation of the usage transaction should be automatically retried in the event of an error. * `D1NA` - No - Automatic Discard, * `D1NO` - No, * `D1YS` - YesExample:D1NA
-
billCondition: string
Allowed Values:
[ "D2CL", "D2IC", "D2IL", "D2IM" ]
The status of the bill associated with the usage transaction (if applicable), used for informational purposes only. * `D2CL` - Closing, * `D2IC` - Initial and Closing, * `D2IL` - Initial, * `D2IM` - InterimExample:D2IL
-
calculationGroup: object
calculationGroup
-
calculationMode: string
Allowed Values:
[ "D2HC" ]
A flag that indicates the mode in which the usage transaction calculations are/were performed. * `D2HC` - Hypothetical CalculationExample:D2HC
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
254
comments -
currentToDoId: string
Maximum Length:
14
To Do ID -
dateBreaks: object
dateBreaks
-
deferCalculation: string
Allowed Values:
[ "D2NO", "D2YS" ]
Defer Calculation: * `D2NO` - No, * `D2YS` - Yes -
endDateTime: string
(date-time)
End Date/Time
-
estimateThroughDate: string
(date)
Estimate Through DateExample:
07-01-2017
-
exceptions: object
exceptions
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:DELT
-
initialCalculation: boolean
Initial CalculationExample:
true
-
intervalMeasuringComponent: object
intervalMeasuringComponent
-
isTraceOn: string
Allowed Values:
[ "D1NO", "D1YS" ]
Indicates if tracing is on for the usage transaction. * `D1NO` - Off, * `D1YS` - OnExample:D1YS
-
linkedToFrozenBillSegment: string
Allowed Values:
[ "D1NO", "D1YS" ]
This flag indicates (Yes or No) whether or not the usage transaction is linked to a frozen bill segment. * `D1NO` - No, * `D1YS` - YesExample:D1NO
-
measurementCycle: object
measurementCycle
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
-
measurementCycleRoute: string
Maximum Length:
30
Route specifies the group of service points in a cycle that are visited by a meter reader. -
nextActions: object
nextActions
-
nextRetryDateTime: string
(date-time)
Next Retry Date/Time
-
previousToDoId: string
Maximum Length:
14
To Do ID -
previousUsageTransaction: object
previousUsageTransaction
-
requestMode: string
Allowed Values:
[ "D2BB", "D2OB" ]
Request * `D2BB` - Batch, * `D2OB` - OnlineExample:D2BB
-
retryUntilDateTime: string
(date-time)
The date time until which the system will attempt to retry creating the usage transaction in the event of an error (applicable only if the Automated Retry flag is set to "Yes").
-
scalarMeasuringComponent: object
scalarMeasuringComponent
-
scheduledSelectionDate: string
(date)
Scheduled Selection Date
-
serviceQuantitiesData: object
serviceQuantitiesData
-
skipDetails: object
skipDetails
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
status: string
Maximum Length:
12
Status -
subUsageToDoIds: object
subUsageToDoIds
-
subUsageTransactionExist: string
Allowed Values:
[ "D2NO", "D2YS" ]
Sub Usage Transactions flag * `D2NO` - No, * `D2YS` - YesExample:D2NO
-
subUsageTransactions: object
subUsageTransactions
-
traces: object
traces
-
usageAdjustmentProfileFactors: object
usageAdjustmentProfileFactors
-
usageExternalId: string
Maximum Length:
60
An ID used by external systems used to identify the usage transaction .When Oracle Utilities Meter Data Management is integrated with Oracle Utilities Customer Care and Billing, Oracle Utilities Customer Care and Billing can send this to help identify the previous usage transaction. -
usagePeriods: object
usagePeriods
-
usageSubscription: object
usageSubscription
-
usageTransactionId: string
Maximum Length:
14
Usage Transaction ID is a system assigned random number that stays with a usage transaction record.Example:05458709929330
-
usageTransactionReadingDetails: object
usageTransactionReadingDetails
-
usageType: string
Allowed Values:
[ "D2CS", "D2IN", "D2IS", "D2PS", "D2SC", "D2SF" ]
Usage Type flag * `D2CS` - Correlated SQ, * `D2IN` - Frequently Read, * `D2IS` - Frequently Read and Manually Read Scalar, * `D2PS` - Profiled SQ, * `D2SC` - Manually Read Scalar, * `D2SF` - Deprecated - Scalar For Calculation Purposes OnlyExample:D2CS
-
usedOnBill: string
Allowed Values:
[ "D1NO", "D1YS" ]
This flag indicates (Yes or No) whether or not the usage transaction's service quantities have been used on a completed bill. * `D1NO` - No, * `D1YS` - YesExample:D1YS
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:2
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : intervalMeasuringComponent
Type:
Show Source
object
-
endDateTimeFrom: string
(date-time)
Defines the start date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
endDateTimeTo: string
(date-time)
Defines the end date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
Nested Schema : measurementCycle
Type:
object
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
Show Source
-
measurementCycle: string
Maximum Length:
30
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
Nested Schema : previousUsageTransaction
Type:
Show Source
object
-
previousUsageTransactionId: string
Maximum Length:
14
Usage Transaction ID
Nested Schema : scalarMeasuringComponent
Type:
Show Source
object
-
allowEstimate: string
Allowed Values:
[ "D2AE", "D2DE" ]
Allow Estimate indicates whether or not to allow use of estimated measurement data when calculating usage. * `D2AE` - Allow Estimates, * `D2DE` - Do Not Allow EstimatesExample:D2AE
-
endDateTimeFrom: string
(date-time)
Defines the start date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
endDateTimeTo: string
(date-time)
Defines the end date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
endRangeOption: string
Allowed Values:
[ "D2SC", "D2SP" ]
End Range Option indicates the end range option. Valid values include "Specified" and "Derive Using Service Cycle Schedule" * `D2SC` - Derive Using Service Cycle Schedule, * `D2SP` - SpecifiedExample:D2SC
-
estimateDate: string
(date)
Estimate Date indicates the date on which estimated measurement data used in the usage calculation was estimated.
-
estimateTime: string
Allowed Values:
[ "D1EF", "D1ET" ]
Estimate Time * `D1EF` - End Date Time From, * `D1ET` - End Date Time ToExample:D1EF
-
isEstimate: string
Allowed Values:
[ "D2NO", "D2YS" ]
Is Estimate indicates if estimated measurement data was used in the usage calculation. * `D2NO` - No, * `D2YS` - YesExample:D2NO
-
maxDaysOffset: number
Minimum Value:
-999
Maximum Value:999
Minimum Offset Days / Maximum Offset Days are used when End Range Option is set to "Dervice Using Service Cycle Schedule", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date. -
minDaysOffset: number
Minimum Value:
-999
Maximum Value:999
Minimum Offset Days / Maximum Offset Days are used when End Range Option is set to "Dervice Using Service Cycle Schedule", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date. -
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
Nested Schema : skipDetails
Type:
Show Source
object
-
nextScheduledReadDate: string
(date)
The next scheduled read date for the device from which the measurements used to create the usage transaction came.
-
skip: string
Allowed Values:
[ "D2NO", "D2YS" ]
A flag that indicates if the usage transaction should be skipped. * `D2NO` - No, * `D2YS` - YesExample:D2NO
-
skipReason: string
Allowed Values:
[ "D2NS" ]
Reason for skipping the usage transaction. * `D2NS` - No Scheduled ReadExample:D2NS
Nested Schema : usageSubscription
Type:
Show Source
object
-
usageSubscriptionId: string
Maximum Length:
12
Usage Subscription
Nested Schema : items
Type:
Show Source
object
-
adhocCharacteristicValue: string
Maximum Length:
254
Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite.Example:77
-
characteristicType: object
characteristicType
-
characteristicValue: string
Maximum Length:
16
Characteristic Value Indicate the value of the characteristic.Example:ADV
-
characteristicValueForeignKey: object
characteristicValueForeignKey
-
effectiveDate: string
(date)
Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValueForeignKey
Type:
Show Source
object
-
id: string
(characteristicValueForeignKey1)
Nested Schema : items
Type:
Show Source
object
-
dateBreak: string
(date)
Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the usage transaction (and its related account).
Nested Schema : items
Type:
Show Source
object
-
exceptionRequiresApproval: string
Allowed Values:
[ "D1NO", "D1YS" ]
Exception Requires Approval flag * `D1NO` - No, * `D1YS` - YesExample:D1NO
-
exceptionSeverity: string
Allowed Values:
[ "D1IF", "D1IS", "D1TM" ]
Exception Severity * `D1IF` - Information, * `D1IS` - Issues, * `D1TM` - TerminateExample:D1IF
-
exceptionType: string
Maximum Length:
30
Exception Type -
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application Framework. -
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageParameters: object
messageParameters
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence -
toDoRole: string
Maximum Length:
10
To Do Role -
toDoType: string
Maximum Length:
8
To Do Type -
usageGroup: string
Maximum Length:
30
Usage group used to calculate usage transactions (e.g., bill determinants)Example:ZZS-MRULEGRP-SCALAR-ITEM
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
Nested Schema : items
Type:
Show Source
object
-
parameter: string
Maximum Length:
2000
Message Parameter Value -
parameterType: string
Allowed Values:
[ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameterExample:AMT
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Message Parameter Sequence
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Nested Schema : items
Type:
Show Source
object
-
periodSequenceNumber: number
Minimum Value:
-999
Maximum Value:999
Period Sequence Number -
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
serviceQuantityDataDateTime: string
(date-time)
Service Quantity Data Date/Time
-
serviceQuantityIntervalCondition: string
Maximum Length:
254
Service Quantity Interval Condition -
serviceQuantitySequenceNumber: number
Minimum Value:
-99999
Maximum Value:99999
Service Quantity Sequence
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: object
calculationGroup
-
endDateTime: string
(date-time)
(endDateTime)
-
startDateTime: string
(date-time)
(startDateTime)
-
subUsageTransactionId: string
(subUsageTransactionId)
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : items
Type:
Show Source
object
-
criteriaSequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
duration: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Duration -
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application Framework. -
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageParameters: object
messageParameters
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence -
usageGroup: string
Maximum Length:
30
Usage group used to calculate usage transactions (e.g., bill determinants)Example:ZZS-MRULEGRP-SCALAR-ITEM
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
Nested Schema : items
Type:
Show Source
object
-
parameter: string
Maximum Length:
2000
Message Parameter Value -
parameterType: string
Allowed Values:
[ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameterExample:AMT
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Message Parameter Sequence
Nested Schema : items
Type:
Show Source
object
-
profileFactor: string
Maximum Length:
30
Factor -
value: string
Maximum Length:
16
Factor Characteristic Value
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
End Date/Time
-
itemDetail: object
itemDetail
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Period Sequence Number -
serviceQuantities: object
serviceQuantities
-
sqsEstimationIndicators: object
sqsEstimationIndicators
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
usageType: string
Allowed Values:
[ "D2CS", "D2IN", "D2IS", "D2PS", "D2SC", "D2SF" ]
Usage Type flag * `D2CS` - Correlated SQ, * `D2IN` - Frequently Read, * `D2IS` - Frequently Read and Manually Read Scalar, * `D2PS` - Profiled SQ, * `D2SC` - Manually Read Scalar, * `D2SF` - Deprecated - Scalar For Calculation Purposes OnlyExample:D2CS
Nested Schema : items
Type:
Show Source
object
-
badgedItem: object
badgedItem
-
calculationGroup: object
calculationGroup
-
endDateTime: string
(date-time)
End Date/Time
-
itemCount: number
Minimum Value:
-9.9999999999E8
Maximum Value:9.9999999999E8
Item Count -
itemDetailsSeq: number
Minimum Value:
0
Maximum Value:99999
Item Detail Sequence -
itemType: object
itemType
-
overrideQuantity: string
Allowed Values:
[ "D1OP" ]
Override Quantity flag * `D1OP` - Override Quantity PresentExample:D1OP
-
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
servicePoint: object
servicePoint
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
uom: object
uom
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
Nested Schema : badgedItem
Type:
Show Source
object
-
badgedItemId: string
Maximum Length:
12
Device ID
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: object
calculationGroup
-
calculationRule: object
calculationRule
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
estimationIndicator: string
Allowed Values:
[ "D2ES", "D2NE" ]
Estimation Indicator * `D2ES` - Estimated, * `D2NE` - Not Estimated -
factor: object
factor
-
intervalData: string
Allowed Values:
[ "D1EX", "D1NE" ]
Interval Data: * `D1EX` - Exist, * `D1NE` - Does Not Exist -
measuringComponent: object
measuringComponent
-
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
secondsPerInterval: integer
Interval Size
-
servicePoint: object
servicePoint
-
shouldExtractIntervalData: string
Allowed Values:
[ "D1NO", "D1YS" ]
Extract Interval Data: * `D1NO` - No, * `D1YS` - Yes -
sqi: object
sqi
-
sqSequence: number
Minimum Value:
-99999
Maximum Value:99999
Service Quantity Sequence -
sqType: string
Allowed Values:
[ "D1FC", "D1IT", "D1MC", "D1OT", "D1PK", "D1SU" ]
Usage Service Quantity Type * `D1FC` - Factor, * `D1IT` - Item, * `D1MC` - Measuring Component, * `D1OT` - Other, * `D1PK` - Peak Across Usage Periods, * `D1SU` - SummationExample:D1FC
-
tou: object
tou
-
touMap: object
touMap
-
uom: object
uom
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : calculationRule
Type:
Show Source
object
-
calculationRule: string
Maximum Length:
30
Calculation Rule
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
characteristicValue: string
Maximum Length:
16
Characteristic Value
Nested Schema : measuringComponent
Type:
Show Source
object
-
measuringComponentId: string
Maximum Length:
12
Measuring Component ID
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : sqi
Type:
Show Source
object
-
sqi: string
Maximum Length:
30
Service Quantity Identifier
Nested Schema : items
Type:
Show Source
object
-
estimationIndicator: string
Allowed Values:
[ "D2ES", "D2NE" ]
Estimation Indicator * `D2ES` - Estimated, * `D2NE` - Not Estimated -
sqi: object
sqi
-
tou: object
tou
-
uom: object
uom
Nested Schema : sqi
Type:
Show Source
object
-
sqi: string
Maximum Length:
30
Service Quantity Identifier
Nested Schema : items
Type:
Show Source
object
-
appliedMultiplier: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Applied MultiplierExample:123.000000
-
calculationGroup: object
calculationGroup
-
endDateTime: string
(date-time)
End Date/Time
-
endMeasurement: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
End MeasurementExample:0.080000
-
endMeasurementCondition: string
Allowed Values:
[ "102000", "ZZ-test-mark1", "100000", "901000", "ZZBUG", "402000", "201000", "ZZ-500001", "501000", "ZZ-301024", "ZZ-301022", "101500", "ZZ-301501", "ZZ-401000", "ZZ-301515", "ZZ-301514", "ZZ-301513", "101000", "409000", "401000", "zz-test3", "ZZ-TestBug", "zz-test5", "ZZ-301031", "ZZ-301491", "100500", "ZZ-301511", "ZZ-TEST-AGAIN", "301000", "ZZ_Test211" ]
Condition: * `102000` - No Read - Disconnected, * `ZZ-test-mark1` - zz-test-mark1, * `100000` - No Read - System, * `901000` - Super, * `ZZBUG` - Override description, * `402000` - Office Estimate, * `201000` - Missing, * `ZZ-500001` - Prorated, * `501000` - Regular, * `ZZ-301024` - ZZ Estimate - Interval Interpolation, * `ZZ-301022` - ZZ Estimate - Interval Averaging, * `101500` - No Read - Outage Fill, * `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read, * `ZZ-401000` - ZZ-External Estimate, * `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read, * `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval, * `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar, * `101000` - No Read - Outage, * `409000` - Combined Quantity, * `401000` - External Estimate, * `zz-test3` - Override description, * `ZZ-TestBug` - ZZ-TestBug-Override description, * `zz-test5` - zz test 5, * `ZZ-301031` - ZZ Estimate - Int Adj From Scalar, * `ZZ-301491` - ZZ Estimate - Scalar Estimation, * `100500` - No Read - Field, * `ZZ-301511` - ZZ Scalar Proration from Estimation Read, * `ZZ-TEST-AGAIN` - ZZ-TEST ONLY, * `301000` - System Estimate, * `ZZ_Test211` - ZZ_Test211-UPD -
finalQuantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Final QuantityExample:9.840000
-
finalSqi: object
finalSqi
-
finalTou: object
finalTou
-
finalUom: object
finalUom
-
mcHowToUse: string
Allowed Values:
[ "+ ", "- ", "C ", "P " ]
How To Use * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - PeakExample:P
-
measuresPeakQuantity: string
Allowed Values:
[ "D1DP", "D1MP" ]
Measures Peak Quantity * `D1DP` - No, * `D1MP` - YesExample:D1DP
-
measuringComponentId: string
Maximum Length:
12
Measuring Component IDExample:658852900520
-
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
servicePoint: object
servicePoint
-
spHowToUse: string
Allowed Values:
[ "D1AD", "D1CK", "D1ST" ]
Usage: * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - Subtract -
sqi: object
sqi
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
startMeasurement: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Start MeasurementExample:0.000000
-
startMeasurementCondition: string
Allowed Values:
[ "102000", "ZZ-test-mark1", "100000", "901000", "ZZBUG", "402000", "201000", "ZZ-500001", "501000", "ZZ-301024", "ZZ-301022", "101500", "ZZ-301501", "ZZ-401000", "ZZ-301515", "ZZ-301514", "ZZ-301513", "101000", "409000", "401000", "zz-test3", "ZZ-TestBug", "zz-test5", "ZZ-301031", "ZZ-301491", "100500", "ZZ-301511", "ZZ-TEST-AGAIN", "301000", "ZZ_Test211" ]
Start Measurement Condition * `102000` - No Read - Disconnected, * `ZZ-test-mark1` - zz-test-mark1, * `100000` - No Read - System, * `901000` - Super, * `ZZBUG` - Override description, * `402000` - Office Estimate, * `201000` - Missing, * `ZZ-500001` - Prorated, * `501000` - Regular, * `ZZ-301024` - ZZ Estimate - Interval Interpolation, * `ZZ-301022` - ZZ Estimate - Interval Averaging, * `101500` - No Read - Outage Fill, * `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read, * `ZZ-401000` - ZZ-External Estimate, * `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read, * `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval, * `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar, * `101000` - No Read - Outage, * `409000` - Combined Quantity, * `401000` - External Estimate, * `zz-test3` - Override description, * `ZZ-TestBug` - ZZ-TestBug-Override description, * `zz-test5` - zz test 5, * `ZZ-301031` - ZZ Estimate - Int Adj From Scalar, * `ZZ-301491` - ZZ Estimate - Scalar Estimation, * `100500` - No Read - Field, * `ZZ-301511` - ZZ Scalar Proration from Estimation Read, * `ZZ-TEST-AGAIN` - ZZ-TEST ONLY, * `301000` - System Estimate, * `ZZ_Test211` - ZZ_Test211-UPDExample:501000
-
tou: object
tou
-
uom: object
uom
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
-
usePercent: number
Minimum Value:
-999
Maximum Value:999
Use percentExample:100
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : sqi
Type:
Show Source
object
-
sqi: string
Maximum Length:
30
Service Quantity Identifier
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : D1UsgTransac
Type:
Show Source
object
-
_self: string
_self
-
alignmentDateTime: string
(date-time)
Alignment Date/Time
-
automatedRetry: string
Allowed Values:
[ "D1NA", "D1NO", "D1YS" ]
A flag that indicates if creation of the usage transaction should be automatically retried in the event of an error. * `D1NA` - No - Automatic Discard, * `D1NO` - No, * `D1YS` - YesExample:D1NA
-
billCondition: string
Allowed Values:
[ "D2CL", "D2IC", "D2IL", "D2IM" ]
The status of the bill associated with the usage transaction (if applicable), used for informational purposes only. * `D2CL` - Closing, * `D2IC` - Initial and Closing, * `D2IL` - Initial, * `D2IM` - InterimExample:D2IL
-
calculationGroup: object
calculationGroup
-
calculationMode: string
Allowed Values:
[ "D2HC" ]
A flag that indicates the mode in which the usage transaction calculations are/were performed. * `D2HC` - Hypothetical CalculationExample:D2HC
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
254
comments -
currentToDoId: string
Maximum Length:
14
To Do ID -
dateBreaks: object
dateBreaks
-
deferCalculation: string
Allowed Values:
[ "D2NO", "D2YS" ]
Defer Calculation: * `D2NO` - No, * `D2YS` - Yes -
endDateTime: string
(date-time)
End Date/Time
-
estimateThroughDate: string
(date)
Estimate Through DateExample:
07-01-2017
-
exceptions: object
exceptions
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:DELT
-
initialCalculation: boolean
Initial CalculationExample:
true
-
intervalMeasuringComponent: object
intervalMeasuringComponent
-
isTraceOn: string
Allowed Values:
[ "D1NO", "D1YS" ]
Indicates if tracing is on for the usage transaction. * `D1NO` - Off, * `D1YS` - OnExample:D1YS
-
linkedToFrozenBillSegment: string
Allowed Values:
[ "D1NO", "D1YS" ]
This flag indicates (Yes or No) whether or not the usage transaction is linked to a frozen bill segment. * `D1NO` - No, * `D1YS` - YesExample:D1NO
-
measurementCycle: object
measurementCycle
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
-
measurementCycleRoute: string
Maximum Length:
30
Route specifies the group of service points in a cycle that are visited by a meter reader. -
nextActions: object
nextActions
-
nextRetryDateTime: string
(date-time)
Next Retry Date/Time
-
previousToDoId: string
Maximum Length:
14
To Do ID -
previousUsageTransaction: object
previousUsageTransaction
-
requestMode: string
Allowed Values:
[ "D2BB", "D2OB" ]
Request * `D2BB` - Batch, * `D2OB` - OnlineExample:D2BB
-
retryUntilDateTime: string
(date-time)
The date time until which the system will attempt to retry creating the usage transaction in the event of an error (applicable only if the Automated Retry flag is set to "Yes").
-
scalarMeasuringComponent: object
scalarMeasuringComponent
-
scheduledSelectionDate: string
(date)
Scheduled Selection Date
-
serviceQuantitiesData: object
serviceQuantitiesData
-
skipDetails: object
skipDetails
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
status: string
Maximum Length:
12
Status -
subUsageToDoIds: object
subUsageToDoIds
-
subUsageTransactionExist: string
Allowed Values:
[ "D2NO", "D2YS" ]
Sub Usage Transactions flag * `D2NO` - No, * `D2YS` - YesExample:D2NO
-
subUsageTransactions: object
subUsageTransactions
-
traces: object
traces
-
usageAdjustmentProfileFactors: object
usageAdjustmentProfileFactors
-
usageExternalId: string
Maximum Length:
60
An ID used by external systems used to identify the usage transaction .When Oracle Utilities Meter Data Management is integrated with Oracle Utilities Customer Care and Billing, Oracle Utilities Customer Care and Billing can send this to help identify the previous usage transaction. -
usagePeriods: object
usagePeriods
-
usageSubscription: object
usageSubscription
-
usageTransactionId: string
Maximum Length:
14
Usage Transaction ID is a system assigned random number that stays with a usage transaction record.Example:05458709929330
-
usageTransactionReadingDetails: object
usageTransactionReadingDetails
-
usageType: string
Allowed Values:
[ "D2CS", "D2IN", "D2IS", "D2PS", "D2SC", "D2SF" ]
Usage Type flag * `D2CS` - Correlated SQ, * `D2IN` - Frequently Read, * `D2IS` - Frequently Read and Manually Read Scalar, * `D2PS` - Profiled SQ, * `D2SC` - Manually Read Scalar, * `D2SF` - Deprecated - Scalar For Calculation Purposes OnlyExample:D2CS
-
usedOnBill: string
Allowed Values:
[ "D1NO", "D1YS" ]
This flag indicates (Yes or No) whether or not the usage transaction's service quantities have been used on a completed bill. * `D1NO` - No, * `D1YS` - YesExample:D1YS
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:2
Nested Schema : calculationGroup
Type:
Show Source
object
-
_link: string
_link
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : intervalMeasuringComponent
Type:
Show Source
object
-
endDateTimeFrom: string
(date-time)
Defines the start date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
endDateTimeTo: string
(date-time)
Defines the end date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
Nested Schema : measurementCycle
Type:
object
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
Show Source
-
_link: string
_link
-
measurementCycle: string
Maximum Length:
30
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
Nested Schema : previousUsageTransaction
Type:
Show Source
object
-
_link: string
_link
-
previousUsageTransactionId: string
Maximum Length:
14
Usage Transaction ID
Nested Schema : scalarMeasuringComponent
Type:
Show Source
object
-
allowEstimate: string
Allowed Values:
[ "D2AE", "D2DE" ]
Allow Estimate indicates whether or not to allow use of estimated measurement data when calculating usage. * `D2AE` - Allow Estimates, * `D2DE` - Do Not Allow EstimatesExample:D2AE
-
endDateTimeFrom: string
(date-time)
Defines the start date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
endDateTimeTo: string
(date-time)
Defines the end date and time for the 'end range' of the usage period.Example:
2013-01-03T00:00:00-08:00
-
endRangeOption: string
Allowed Values:
[ "D2SC", "D2SP" ]
End Range Option indicates the end range option. Valid values include "Specified" and "Derive Using Service Cycle Schedule" * `D2SC` - Derive Using Service Cycle Schedule, * `D2SP` - SpecifiedExample:D2SC
-
estimateDate: string
(date)
Estimate Date indicates the date on which estimated measurement data used in the usage calculation was estimated.
-
estimateTime: string
Allowed Values:
[ "D1EF", "D1ET" ]
Estimate Time * `D1EF` - End Date Time From, * `D1ET` - End Date Time ToExample:D1EF
-
isEstimate: string
Allowed Values:
[ "D2NO", "D2YS" ]
Is Estimate indicates if estimated measurement data was used in the usage calculation. * `D2NO` - No, * `D2YS` - YesExample:D2NO
-
maxDaysOffset: number
Minimum Value:
-999
Maximum Value:999
Minimum Offset Days / Maximum Offset Days are used when End Range Option is set to "Dervice Using Service Cycle Schedule", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date. -
minDaysOffset: number
Minimum Value:
-999
Maximum Value:999
Minimum Offset Days / Maximum Offset Days are used when End Range Option is set to "Dervice Using Service Cycle Schedule", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date. -
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
Nested Schema : skipDetails
Type:
Show Source
object
-
nextScheduledReadDate: string
(date)
The next scheduled read date for the device from which the measurements used to create the usage transaction came.
-
skip: string
Allowed Values:
[ "D2NO", "D2YS" ]
A flag that indicates if the usage transaction should be skipped. * `D2NO` - No, * `D2YS` - YesExample:D2NO
-
skipReason: string
Allowed Values:
[ "D2NS" ]
Reason for skipping the usage transaction. * `D2NS` - No Scheduled ReadExample:D2NS
Nested Schema : usageSubscription
Type:
Show Source
object
-
_link: string
_link
-
usageSubscriptionId: string
Maximum Length:
12
Usage Subscription
Nested Schema : items
Type:
Show Source
object
-
adhocCharacteristicValue: string
Maximum Length:
254
Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite.Example:77
-
characteristicType: object
characteristicType
-
characteristicValue: string
Maximum Length:
16
Characteristic Value Indicate the value of the characteristic.Example:ADV
-
characteristicValueForeignKey: object
characteristicValueForeignKey
-
effectiveDate: string
(date)
Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValueForeignKey
Type:
Show Source
object
-
_link: string
_link
-
id: string
(characteristicValueForeignKey1)
Nested Schema : items
Type:
Show Source
object
-
dateBreak: string
(date)
Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the usage transaction (and its related account).
Nested Schema : items
Type:
Show Source
object
-
exceptionRequiresApproval: string
Allowed Values:
[ "D1NO", "D1YS" ]
Exception Requires Approval flag * `D1NO` - No, * `D1YS` - YesExample:D1NO
-
exceptionSeverity: string
Allowed Values:
[ "D1IF", "D1IS", "D1TM" ]
Exception Severity * `D1IF` - Information, * `D1IS` - Issues, * `D1TM` - TerminateExample:D1IF
-
exceptionType: string
Maximum Length:
30
Exception Type -
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application Framework. -
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageParameters: object
messageParameters
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence -
toDoRole: string
Maximum Length:
10
To Do Role -
toDoType: string
Maximum Length:
8
To Do Type -
usageGroup: string
Maximum Length:
30
Usage group used to calculate usage transactions (e.g., bill determinants)Example:ZZS-MRULEGRP-SCALAR-ITEM
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
Nested Schema : items
Type:
Show Source
object
-
parameter: string
Maximum Length:
2000
Message Parameter Value -
parameterType: string
Allowed Values:
[ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameterExample:AMT
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Message Parameter Sequence
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Nested Schema : items
Type:
Show Source
object
-
periodSequenceNumber: number
Minimum Value:
-999
Maximum Value:999
Period Sequence Number -
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
serviceQuantityDataDateTime: string
(date-time)
Service Quantity Data Date/Time
-
serviceQuantityIntervalCondition: string
Maximum Length:
254
Service Quantity Interval Condition -
serviceQuantitySequenceNumber: number
Minimum Value:
-99999
Maximum Value:99999
Service Quantity Sequence
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: object
calculationGroup
-
endDateTime: string
(date-time)
(endDateTime)
-
startDateTime: string
(date-time)
(startDateTime)
-
subUsageTransactionId: string
(subUsageTransactionId)
Nested Schema : calculationGroup
Type:
Show Source
object
-
_link: string
_link
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : items
Type:
Show Source
object
-
criteriaSequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
duration: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Duration -
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application Framework. -
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageParameters: object
messageParameters
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence -
usageGroup: string
Maximum Length:
30
Usage group used to calculate usage transactions (e.g., bill determinants)Example:ZZS-MRULEGRP-SCALAR-ITEM
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
Nested Schema : items
Type:
Show Source
object
-
parameter: string
Maximum Length:
2000
Message Parameter Value -
parameterType: string
Allowed Values:
[ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameterExample:AMT
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Message Parameter Sequence
Nested Schema : items
Type:
Show Source
object
-
profileFactor: string
Maximum Length:
30
Factor -
value: string
Maximum Length:
16
Factor Characteristic Value
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
End Date/Time
-
itemDetail: object
itemDetail
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Period Sequence Number -
serviceQuantities: object
serviceQuantities
-
sqsEstimationIndicators: object
sqsEstimationIndicators
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
usageType: string
Allowed Values:
[ "D2CS", "D2IN", "D2IS", "D2PS", "D2SC", "D2SF" ]
Usage Type flag * `D2CS` - Correlated SQ, * `D2IN` - Frequently Read, * `D2IS` - Frequently Read and Manually Read Scalar, * `D2PS` - Profiled SQ, * `D2SC` - Manually Read Scalar, * `D2SF` - Deprecated - Scalar For Calculation Purposes OnlyExample:D2CS
Nested Schema : items
Type:
Show Source
object
-
badgedItem: object
badgedItem
-
calculationGroup: object
calculationGroup
-
endDateTime: string
(date-time)
End Date/Time
-
itemCount: number
Minimum Value:
-9.9999999999E8
Maximum Value:9.9999999999E8
Item Count -
itemDetailsSeq: number
Minimum Value:
0
Maximum Value:99999
Item Detail Sequence -
itemType: object
itemType
-
overrideQuantity: string
Allowed Values:
[ "D1OP" ]
Override Quantity flag * `D1OP` - Override Quantity PresentExample:D1OP
-
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
servicePoint: object
servicePoint
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
uom: object
uom
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
Nested Schema : badgedItem
Type:
Show Source
object
-
_link: string
_link
-
badgedItemId: string
Maximum Length:
12
Device ID
Nested Schema : calculationGroup
Type:
Show Source
object
-
_link: string
_link
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : itemType
Type:
Show Source
object
-
_link: string
_link
-
itemType: string
Maximum Length:
30
Device Type
Nested Schema : servicePoint
Type:
Show Source
object
-
_link: string
_link
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : uom
Type:
Show Source
object
-
_link: string
_link
-
uom: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: object
calculationGroup
-
calculationRule: object
calculationRule
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
estimationIndicator: string
Allowed Values:
[ "D2ES", "D2NE" ]
Estimation Indicator * `D2ES` - Estimated, * `D2NE` - Not Estimated -
factor: object
factor
-
intervalData: string
Allowed Values:
[ "D1EX", "D1NE" ]
Interval Data: * `D1EX` - Exist, * `D1NE` - Does Not Exist -
measuringComponent: object
measuringComponent
-
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
secondsPerInterval: integer
Interval Size
-
servicePoint: object
servicePoint
-
shouldExtractIntervalData: string
Allowed Values:
[ "D1NO", "D1YS" ]
Extract Interval Data: * `D1NO` - No, * `D1YS` - Yes -
sqi: object
sqi
-
sqSequence: number
Minimum Value:
-99999
Maximum Value:99999
Service Quantity Sequence -
sqType: string
Allowed Values:
[ "D1FC", "D1IT", "D1MC", "D1OT", "D1PK", "D1SU" ]
Usage Service Quantity Type * `D1FC` - Factor, * `D1IT` - Item, * `D1MC` - Measuring Component, * `D1OT` - Other, * `D1PK` - Peak Across Usage Periods, * `D1SU` - SummationExample:D1FC
-
tou: object
tou
-
touMap: object
touMap
-
uom: object
uom
Nested Schema : calculationGroup
Type:
Show Source
object
-
_link: string
_link
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : calculationRule
Type:
Show Source
object
-
_link: string
_link
-
calculationRule: string
Maximum Length:
30
Calculation Rule
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
_link
-
characteristicValue: string
Maximum Length:
16
Characteristic Value
Nested Schema : factor
Type:
Show Source
object
-
_link: string
_link
-
factor: string
Maximum Length:
30
Factor
Nested Schema : measuringComponent
Type:
Show Source
object
-
_link: string
_link
-
measuringComponentId: string
Maximum Length:
12
Measuring Component ID
Nested Schema : servicePoint
Type:
Show Source
object
-
_link: string
_link
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : sqi
Type:
Show Source
object
-
_link: string
_link
-
sqi: string
Maximum Length:
30
Service Quantity Identifier
Nested Schema : tou
Type:
Show Source
object
-
_link: string
_link
-
tou: string
Maximum Length:
30
Time of Use
Nested Schema : touMap
Type:
Show Source
object
-
_link: string
_link
-
touMap: string
Maximum Length:
12
TOU Map
Nested Schema : uom
Type:
Show Source
object
-
_link: string
_link
-
uom: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
estimationIndicator: string
Allowed Values:
[ "D2ES", "D2NE" ]
Estimation Indicator * `D2ES` - Estimated, * `D2NE` - Not Estimated -
sqi: object
sqi
-
tou: object
tou
-
uom: object
uom
Nested Schema : sqi
Type:
Show Source
object
-
_link: string
_link
-
sqi: string
Maximum Length:
30
Service Quantity Identifier
Nested Schema : tou
Type:
Show Source
object
-
_link: string
_link
-
tou: string
Maximum Length:
30
Time of Use
Nested Schema : uom
Type:
Show Source
object
-
_link: string
_link
-
uom: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
appliedMultiplier: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Applied MultiplierExample:123.000000
-
calculationGroup: object
calculationGroup
-
endDateTime: string
(date-time)
End Date/Time
-
endMeasurement: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
End MeasurementExample:0.080000
-
endMeasurementCondition: string
Allowed Values:
[ "102000", "ZZ-test-mark1", "100000", "901000", "ZZBUG", "402000", "201000", "ZZ-500001", "501000", "ZZ-301024", "ZZ-301022", "101500", "ZZ-301501", "ZZ-401000", "ZZ-301515", "ZZ-301514", "ZZ-301513", "101000", "409000", "401000", "zz-test3", "ZZ-TestBug", "zz-test5", "ZZ-301031", "ZZ-301491", "100500", "ZZ-301511", "ZZ-TEST-AGAIN", "301000", "ZZ_Test211" ]
Condition: * `102000` - No Read - Disconnected, * `ZZ-test-mark1` - zz-test-mark1, * `100000` - No Read - System, * `901000` - Super, * `ZZBUG` - Override description, * `402000` - Office Estimate, * `201000` - Missing, * `ZZ-500001` - Prorated, * `501000` - Regular, * `ZZ-301024` - ZZ Estimate - Interval Interpolation, * `ZZ-301022` - ZZ Estimate - Interval Averaging, * `101500` - No Read - Outage Fill, * `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read, * `ZZ-401000` - ZZ-External Estimate, * `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read, * `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval, * `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar, * `101000` - No Read - Outage, * `409000` - Combined Quantity, * `401000` - External Estimate, * `zz-test3` - Override description, * `ZZ-TestBug` - ZZ-TestBug-Override description, * `zz-test5` - zz test 5, * `ZZ-301031` - ZZ Estimate - Int Adj From Scalar, * `ZZ-301491` - ZZ Estimate - Scalar Estimation, * `100500` - No Read - Field, * `ZZ-301511` - ZZ Scalar Proration from Estimation Read, * `ZZ-TEST-AGAIN` - ZZ-TEST ONLY, * `301000` - System Estimate, * `ZZ_Test211` - ZZ_Test211-UPD -
finalQuantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Final QuantityExample:9.840000
-
finalSqi: object
finalSqi
-
finalTou: object
finalTou
-
finalUom: object
finalUom
-
mcHowToUse: string
Allowed Values:
[ "+ ", "- ", "C ", "P " ]
How To Use * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - PeakExample:P
-
measuresPeakQuantity: string
Allowed Values:
[ "D1DP", "D1MP" ]
Measures Peak Quantity * `D1DP` - No, * `D1MP` - YesExample:D1DP
-
measuringComponentId: string
Maximum Length:
12
Measuring Component IDExample:658852900520
-
quantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
QuantityExample:9.840000
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
servicePoint: object
servicePoint
-
spHowToUse: string
Allowed Values:
[ "D1AD", "D1CK", "D1ST" ]
Usage: * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - Subtract -
sqi: object
sqi
-
startDateTime: string
(date-time)
Defines the start date and time of the usage period.Example:
2013-01-02T00:00:00-08:00
-
startMeasurement: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Start MeasurementExample:0.000000
-
startMeasurementCondition: string
Allowed Values:
[ "102000", "ZZ-test-mark1", "100000", "901000", "ZZBUG", "402000", "201000", "ZZ-500001", "501000", "ZZ-301024", "ZZ-301022", "101500", "ZZ-301501", "ZZ-401000", "ZZ-301515", "ZZ-301514", "ZZ-301513", "101000", "409000", "401000", "zz-test3", "ZZ-TestBug", "zz-test5", "ZZ-301031", "ZZ-301491", "100500", "ZZ-301511", "ZZ-TEST-AGAIN", "301000", "ZZ_Test211" ]
Start Measurement Condition * `102000` - No Read - Disconnected, * `ZZ-test-mark1` - zz-test-mark1, * `100000` - No Read - System, * `901000` - Super, * `ZZBUG` - Override description, * `402000` - Office Estimate, * `201000` - Missing, * `ZZ-500001` - Prorated, * `501000` - Regular, * `ZZ-301024` - ZZ Estimate - Interval Interpolation, * `ZZ-301022` - ZZ Estimate - Interval Averaging, * `101500` - No Read - Outage Fill, * `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read, * `ZZ-401000` - ZZ-External Estimate, * `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read, * `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval, * `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar, * `101000` - No Read - Outage, * `409000` - Combined Quantity, * `401000` - External Estimate, * `zz-test3` - Override description, * `ZZ-TestBug` - ZZ-TestBug-Override description, * `zz-test5` - zz test 5, * `ZZ-301031` - ZZ Estimate - Int Adj From Scalar, * `ZZ-301491` - ZZ Estimate - Scalar Estimation, * `100500` - No Read - Field, * `ZZ-301511` - ZZ Scalar Proration from Estimation Read, * `ZZ-TEST-AGAIN` - ZZ-TEST ONLY, * `301000` - System Estimate, * `ZZ_Test211` - ZZ_Test211-UPDExample:501000
-
tou: object
tou
-
uom: object
uom
-
usageRule: string
Maximum Length:
30
Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.Example:ZZS-MRULGRP-SCALAR-RULE
-
usePercent: number
Minimum Value:
-999
Maximum Value:999
Use percentExample:100
Nested Schema : calculationGroup
Type:
Show Source
object
-
_link: string
_link
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Nested Schema : finalSqi
Type:
Show Source
object
-
_link: string
_link
-
finalSqi: string
Maximum Length:
30
Final SQI
Nested Schema : finalTou
Type:
Show Source
object
-
_link: string
_link
-
finalTou: string
Maximum Length:
30
Final TOU
Nested Schema : finalUom
Type:
Show Source
object
-
_link: string
_link
-
finalUom: string
Maximum Length:
30
Final UOM
Nested Schema : servicePoint
Type:
Show Source
object
-
_link: string
_link
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : sqi
Type:
Show Source
object
-
_link: string
_link
-
sqi: string
Maximum Length:
30
Service Quantity Identifier
Nested Schema : tou
Type:
Show Source
object
-
_link: string
_link
-
tou: string
Maximum Length:
30
Time of Use
Nested Schema : uom
Type:
Show Source
object
-
_link: string
_link
-
uom: string
Maximum Length:
30
Unit of Measure
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.