Create Service Point
post
https://server:port/spl/rest/apis/customer/v-model/servicePoints/
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accessGroup: string
Maximum Length:
12
Access Group -
address: object
address
-
assetSystemSPId: string
Maximum Length:
120
Identifier Value -
bo: string
Maximum Length:
30
Business Object -
characteristicList: object
characteristicList
-
creationDateTime: string
(date-time)
Create Date/Time
-
deviceLocation: string
Allowed Values:
[ "LEFT", "D1-LEFT", "ZZOK1", "GARG", "RIGH" ]
Device Location: * `LEFT` - Left, * `D1-LEFT` - Left, * `ZZOK1` - OK Test Device Location, * `GARG` - ZZ Garage, * `RIGH` - ZZ - Right -
deviceLocationDetails: string
Maximum Length:
250
Device Location Details -
disconnectLocation: string
Allowed Values:
[ "D1DV", "D1SR" ]
Disconnect Location: * `D1DV` - Device, * `D1SR` - Source -
distributionNetworkFacility: string
Maximum Length:
14
Distribution Network Facility -
division: string
Maximum Length:
30
Division -
equipments: object
equipments
-
estimationEligibility: string
Allowed Values:
[ "D1EL", "D1NE" ]
Estimation Eligibility: * `D1EL` - Eligible, * `D1NE` - Not Eligible -
externalId: string
Maximum Length:
10
CCB Service Point ID -
geocodeLatitude: number
Minimum Value:
-9.99999999999999E8
Maximum Value:9.99999999999999E8
Geographic Latitude -
geocodeLongitude: number
Minimum Value:
-9.99999999999999E8
Maximum Value:9.99999999999999E8
Geographic Longitude -
key: string
Allowed Values:
[ "ZZ", "ZZ1", "ZZ2", "false", "true", "ZZ-False", "ZZ-True" ]
Key: * `ZZ` - ZZ, * `ZZ1` - ZZ1, * `ZZ2` - ZZ2, * `false` - False, * `true` - True, * `ZZ-False` - ZZ-False, * `ZZ-True` - ZZ-True -
keyId: string
Maximum Length:
30
Key ID -
lifeSupportSensitiveLoad: string
Allowed Values:
[ "Y ", "ZZLS", "ZZNC", "ZZNL" ]
Life Support / Sensitive Load: * `Y ` - Yes, * `ZZLS` - On life support, * `ZZNC` - On partial support, * `ZZNL` - Not on life support -
lifeSupportSensitiveLoadDescription: string
Maximum Length:
4000
Description -
mainContact: string
Maximum Length:
12
Contact ID -
market: object
market
-
measurementCycle: object
measurementCycle
-
measurementCycleRoute: string
Maximum Length:
30
Route -
measurementCycleRouteSequence: number
Minimum Value:
-999999999
Maximum Value:999999999
Sequence -
multiItems: object
multiItems
-
okToEnter: string
Allowed Values:
[ "false", "true", "ZZNO" ]
OK To Enter: * `false` - False, * `true` - True, * `ZZNO` - No -
parentServicePoint: object
parentServicePoint
-
premise: object
premise
-
primaryUsId: string
Maximum Length:
12
Usage Subscription -
servicePointId: string
Maximum Length:
12
Service Point ID -
servicePointType: object
servicePointType
-
sourceStatus: string
Allowed Values:
[ "D1CN", "D1DC" ]
Source Status: * `D1CN` - Connected, * `D1DC` - Disconnected -
spInstruction: string
Allowed Values:
[ "ZZ1", "SER", "CHKS", "C", "CON", "S", "ZZZ", "LRC" ]
SP Instruction: * `ZZ1` - ZZ1, * `SER` - SER Test, * `CHKS` - CHKS Test, * `C` - CON, * `CON` - CON Test, * `S` - SER, * `ZZZ` - ZZZ, * `LRC` - LRC Test -
spInstructionDetails: string
Maximum Length:
250
SP Instruction Details -
spWarning: string
Allowed Values:
[ "NEIG", "C", "D", "DIVE", "CAT", "DANG", "DOG" ]
SP Warning: * `NEIG` - Neig, * `C` - Cat, * `D` - Dog, * `DIVE` - Dive, * `CAT` - Cat, * `DANG` - Dang, * `DOG` - Dog -
status: string
Maximum Length:
12
Status -
statusDateTime: string
(date-time)
Status Date/Time
-
statusReason: string
Maximum Length:
30
Status Reason -
timeZone: object
timeZone
Timezone
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
Address 2 -
address3: string
Maximum Length:
254
Address 3 -
address4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
County -
geographic: string
Maximum Length:
11
Geographical Code -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
inCityLimit: boolean
In City Limit
-
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2
Nested Schema : measurementCycle
Type:
Show Source
object
-
measurementCycle: string
Maximum Length:
30
Measurement Cycle
Nested Schema : parentServicePoint
Type:
Show Source
object
-
parentSPId: string
Maximum Length:
12
Related Service Point
Nested Schema : premise
Type:
Show Source
object
-
externalPremiseId: string
Maximum Length:
10
Premise
Nested Schema : servicePointType
Type:
Show Source
object
-
spType: string
Maximum Length:
30
Service Point Type
Nested Schema : timeZone
Type:
object
Timezone
Show Source
-
timeZone: string
Maximum Length:
10
TimezoneExample:USPACIFIC
Nested Schema : items
Type:
Show Source
object
-
adhocCharacteristicValue: string
Maximum Length:
254
Adhoc Characteristic Value -
characteristicType: object
characteristicType
-
characteristicValue: string
Maximum Length:
16
Value of the characteristic as additional data for the record. -
characteristicValueFK2: string
Maximum Length:
50
Characteristic Value FK 2 -
characteristicValueFK3: string
Maximum Length:
50
Characteristic Value FK 3 -
characteristicValueFk4: string
Maximum Length:
50
Characteristic Value FK 4 -
characteristicValueFK5: string
Maximum Length:
50
Characteristic Value FK 5 -
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
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValueForeignKey
Type:
Show Source
object
-
characteristicValueForeignKey1: string
Maximum Length:
50
Characteristic Value FK 1
Nested Schema : items
Type:
Show Source
object
-
comments: string
Maximum Length:
254
Comments -
crew: string
Maximum Length:
60
Crew -
equipment: object
equipment
-
equipmentCount: number
Minimum Value:
0
Maximum Value:9.9999999999E8
Equipment Count -
installDateTime: string
(date-time)
Installation Date/Time
-
removalDateTime: string
(date-time)
Removal Date/Time
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
End Date/Time
-
installationOverrideQuantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Installation Override Quantity (Daily) -
multiItemCounts: object
multiItemCounts
-
sqi: string
Maximum Length:
30
Service Quantity Identifier -
startDateTime: string
(date-time)
Start Date/Time
-
uom: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
count: number
Minimum Value:
-9.9999999999E8
Maximum Value:9.9999999999E8
Item Count -
itemType: string
Maximum Length:
30
Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.Example:ZZ_DVCTYP_7529
Root Schema : schema
Type:
Show Source
object
-
accessGroup: string
Maximum Length:
12
Access Group -
address: object
address
-
assetSystemSPId: string
Maximum Length:
120
Identifier Value -
bo: string
Maximum Length:
30
Business Object -
characteristicList: object
characteristicList
-
creationDateTime: string
(date-time)
Create Date/Time
-
deviceLocation: string
Allowed Values:
[ "LEFT", "D1-LEFT", "ZZOK1", "GARG", "RIGH" ]
Device Location: * `LEFT` - Left, * `D1-LEFT` - Left, * `ZZOK1` - OK Test Device Location, * `GARG` - ZZ Garage, * `RIGH` - ZZ - Right -
deviceLocationDetails: string
Maximum Length:
250
Device Location Details -
disconnectLocation: string
Allowed Values:
[ "D1DV", "D1SR" ]
Disconnect Location: * `D1DV` - Device, * `D1SR` - Source -
distributionNetworkFacility: string
Maximum Length:
14
Distribution Network Facility -
division: string
Maximum Length:
30
Division -
equipments: object
equipments
-
estimationEligibility: string
Allowed Values:
[ "D1EL", "D1NE" ]
Estimation Eligibility: * `D1EL` - Eligible, * `D1NE` - Not Eligible -
externalId: string
Maximum Length:
10
CCB Service Point ID -
geocodeLatitude: number
Minimum Value:
-9.99999999999999E8
Maximum Value:9.99999999999999E8
Geographic Latitude -
geocodeLongitude: number
Minimum Value:
-9.99999999999999E8
Maximum Value:9.99999999999999E8
Geographic Longitude -
key: string
Allowed Values:
[ "ZZ", "ZZ1", "ZZ2", "false", "true", "ZZ-False", "ZZ-True" ]
Key: * `ZZ` - ZZ, * `ZZ1` - ZZ1, * `ZZ2` - ZZ2, * `false` - False, * `true` - True, * `ZZ-False` - ZZ-False, * `ZZ-True` - ZZ-True -
keyId: string
Maximum Length:
30
Key ID -
lifeSupportSensitiveLoad: string
Allowed Values:
[ "Y ", "ZZLS", "ZZNC", "ZZNL" ]
Life Support / Sensitive Load: * `Y ` - Yes, * `ZZLS` - On life support, * `ZZNC` - On partial support, * `ZZNL` - Not on life support -
lifeSupportSensitiveLoadDescription: string
Maximum Length:
4000
Description -
mainContact: string
Maximum Length:
12
Contact ID -
market: object
market
-
measurementCycle: object
measurementCycle
-
measurementCycleRoute: string
Maximum Length:
30
Route -
measurementCycleRouteSequence: number
Minimum Value:
-999999999
Maximum Value:999999999
Sequence -
multiItems: object
multiItems
-
okToEnter: string
Allowed Values:
[ "false", "true", "ZZNO" ]
OK To Enter: * `false` - False, * `true` - True, * `ZZNO` - No -
parentServicePoint: object
parentServicePoint
-
premise: object
premise
-
primaryUsId: string
Maximum Length:
12
Usage Subscription -
servicePointId: string
Maximum Length:
12
Service Point ID -
servicePointType: object
servicePointType
-
sourceStatus: string
Allowed Values:
[ "D1CN", "D1DC" ]
Source Status: * `D1CN` - Connected, * `D1DC` - Disconnected -
spInstruction: string
Allowed Values:
[ "ZZ1", "SER", "CHKS", "C", "CON", "S", "ZZZ", "LRC" ]
SP Instruction: * `ZZ1` - ZZ1, * `SER` - SER Test, * `CHKS` - CHKS Test, * `C` - CON, * `CON` - CON Test, * `S` - SER, * `ZZZ` - ZZZ, * `LRC` - LRC Test -
spInstructionDetails: string
Maximum Length:
250
SP Instruction Details -
spWarning: string
Allowed Values:
[ "NEIG", "C", "D", "DIVE", "CAT", "DANG", "DOG" ]
SP Warning: * `NEIG` - Neig, * `C` - Cat, * `D` - Dog, * `DIVE` - Dive, * `CAT` - Cat, * `DANG` - Dang, * `DOG` - Dog -
status: string
Maximum Length:
12
Status -
statusDateTime: string
(date-time)
Status Date/Time
-
statusReason: string
Maximum Length:
30
Status Reason -
timeZone: object
timeZone
Timezone
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
Address 2 -
address3: string
Maximum Length:
254
Address 3 -
address4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
County -
geographic: string
Maximum Length:
11
Geographical Code -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
inCityLimit: boolean
In City Limit
-
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2
Nested Schema : measurementCycle
Type:
Show Source
object
-
measurementCycle: string
Maximum Length:
30
Measurement Cycle
Nested Schema : parentServicePoint
Type:
Show Source
object
-
parentSPId: string
Maximum Length:
12
Related Service Point
Nested Schema : premise
Type:
Show Source
object
-
externalPremiseId: string
Maximum Length:
10
Premise
Nested Schema : servicePointType
Type:
Show Source
object
-
spType: string
Maximum Length:
30
Service Point Type
Nested Schema : timeZone
Type:
object
Timezone
Show Source
-
timeZone: string
Maximum Length:
10
TimezoneExample:USPACIFIC
Nested Schema : items
Type:
Show Source
object
-
adhocCharacteristicValue: string
Maximum Length:
254
Adhoc Characteristic Value -
characteristicType: object
characteristicType
-
characteristicValue: string
Maximum Length:
16
Value of the characteristic as additional data for the record. -
characteristicValueFK2: string
Maximum Length:
50
Characteristic Value FK 2 -
characteristicValueFK3: string
Maximum Length:
50
Characteristic Value FK 3 -
characteristicValueFk4: string
Maximum Length:
50
Characteristic Value FK 4 -
characteristicValueFK5: string
Maximum Length:
50
Characteristic Value FK 5 -
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
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValueForeignKey
Type:
Show Source
object
-
characteristicValueForeignKey1: string
Maximum Length:
50
Characteristic Value FK 1
Nested Schema : items
Type:
Show Source
object
-
comments: string
Maximum Length:
254
Comments -
crew: string
Maximum Length:
60
Crew -
equipment: object
equipment
-
equipmentCount: number
Minimum Value:
0
Maximum Value:9.9999999999E8
Equipment Count -
installDateTime: string
(date-time)
Installation Date/Time
-
removalDateTime: string
(date-time)
Removal Date/Time
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
End Date/Time
-
installationOverrideQuantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Installation Override Quantity (Daily) -
multiItemCounts: object
multiItemCounts
-
sqi: string
Maximum Length:
30
Service Quantity Identifier -
startDateTime: string
(date-time)
Start Date/Time
-
uom: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
count: number
Minimum Value:
-9.9999999999E8
Maximum Value:9.9999999999E8
Item Count -
itemType: string
Maximum Length:
30
Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.Example:ZZ_DVCTYP_7529
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1ServicePnt
Type:
Show Source
object
-
_self: string
_self
-
accessGroup: string
Maximum Length:
12
Access Group -
address: object
address
-
assetSystemSPId: string
Maximum Length:
120
Identifier Value -
characteristicList: object
characteristicList
-
creationDateTime: string
(date-time)
Create Date/Time
-
deviceLocation: string
Allowed Values:
[ "LEFT", "D1-LEFT", "ZZOK1", "GARG", "RIGH" ]
Device Location: * `LEFT` - Left, * `D1-LEFT` - Left, * `ZZOK1` - OK Test Device Location, * `GARG` - ZZ Garage, * `RIGH` - ZZ - Right -
deviceLocationDetails: string
Maximum Length:
250
Device Location Details -
disconnectLocation: string
Allowed Values:
[ "D1DV", "D1SR" ]
Disconnect Location: * `D1DV` - Device, * `D1SR` - Source -
distributionNetworkFacility: string
Maximum Length:
14
Distribution Network Facility -
division: string
Maximum Length:
30
Division -
equipments: object
equipments
-
estimationEligibility: string
Allowed Values:
[ "D1EL", "D1NE" ]
Estimation Eligibility: * `D1EL` - Eligible, * `D1NE` - Not Eligible -
externalId: string
Maximum Length:
10
CCB Service Point ID -
geocodeLatitude: number
Minimum Value:
-9.99999999999999E8
Maximum Value:9.99999999999999E8
Geographic Latitude -
geocodeLongitude: number
Minimum Value:
-9.99999999999999E8
Maximum Value:9.99999999999999E8
Geographic Longitude -
key: string
Allowed Values:
[ "ZZ", "ZZ1", "ZZ2", "false", "true", "ZZ-False", "ZZ-True" ]
Key: * `ZZ` - ZZ, * `ZZ1` - ZZ1, * `ZZ2` - ZZ2, * `false` - False, * `true` - True, * `ZZ-False` - ZZ-False, * `ZZ-True` - ZZ-True -
keyId: string
Maximum Length:
30
Key ID -
lifeSupportSensitiveLoad: string
Allowed Values:
[ "Y ", "ZZLS", "ZZNC", "ZZNL" ]
Life Support / Sensitive Load: * `Y ` - Yes, * `ZZLS` - On life support, * `ZZNC` - On partial support, * `ZZNL` - Not on life support -
lifeSupportSensitiveLoadDescription: string
Maximum Length:
4000
Description -
mainContact: string
Maximum Length:
12
Contact ID -
market: object
market
-
measurementCycle: object
measurementCycle
-
measurementCycleRoute: string
Maximum Length:
30
Route -
measurementCycleRouteSequence: number
Minimum Value:
-999999999
Maximum Value:999999999
Sequence -
multiItems: object
multiItems
-
okToEnter: string
Allowed Values:
[ "false", "true", "ZZNO" ]
OK To Enter: * `false` - False, * `true` - True, * `ZZNO` - No -
parentServicePoint: object
parentServicePoint
-
premise: object
premise
-
primaryUsId: string
Maximum Length:
12
Usage Subscription -
servicePointId: string
Maximum Length:
12
Service Point ID -
servicePointType: object
servicePointType
-
sourceStatus: string
Allowed Values:
[ "D1CN", "D1DC" ]
Source Status: * `D1CN` - Connected, * `D1DC` - Disconnected -
spInstruction: string
Allowed Values:
[ "ZZ1", "SER", "CHKS", "C", "CON", "S", "ZZZ", "LRC" ]
SP Instruction: * `ZZ1` - ZZ1, * `SER` - SER Test, * `CHKS` - CHKS Test, * `C` - CON, * `CON` - CON Test, * `S` - SER, * `ZZZ` - ZZZ, * `LRC` - LRC Test -
spInstructionDetails: string
Maximum Length:
250
SP Instruction Details -
spWarning: string
Allowed Values:
[ "NEIG", "C", "D", "DIVE", "CAT", "DANG", "DOG" ]
SP Warning: * `NEIG` - Neig, * `C` - Cat, * `D` - Dog, * `DIVE` - Dive, * `CAT` - Cat, * `DANG` - Dang, * `DOG` - Dog -
status: string
Maximum Length:
12
Status -
statusDateTime: string
(date-time)
Status Date/Time
-
statusReason: string
Maximum Length:
30
Status Reason -
timeZone: object
timeZone
Timezone
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
Address 2 -
address3: string
Maximum Length:
254
Address 3 -
address4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
County -
geographic: string
Maximum Length:
11
Geographical Code -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
inCityLimit: boolean
In City Limit
-
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2
Nested Schema : market
Type:
Show Source
object
-
_link: string
_link
-
market: string
Maximum Length:
30
Market
Nested Schema : measurementCycle
Type:
Show Source
object
-
_link: string
_link
-
measurementCycle: string
Maximum Length:
30
Measurement Cycle
Nested Schema : parentServicePoint
Type:
Show Source
object
-
_link: string
_link
-
parentSPId: string
Maximum Length:
12
Related Service Point
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
externalPremiseId: string
Maximum Length:
10
Premise
Nested Schema : servicePointType
Type:
Show Source
object
-
_link: string
_link
-
spType: string
Maximum Length:
30
Service Point Type
Nested Schema : timeZone
Type:
object
Timezone
Show Source
-
_link: string
_link
-
timeZone: string
Maximum Length:
10
TimezoneExample:USPACIFIC
Nested Schema : country
Type:
Show Source
object
-
_link: string
_link
-
country: string
Maximum Length:
3
Country
Nested Schema : items
Type:
Show Source
object
-
adhocCharacteristicValue: string
Maximum Length:
254
Adhoc Characteristic Value -
characteristicType: object
characteristicType
-
characteristicValue: string
Maximum Length:
16
Value of the characteristic as additional data for the record. -
characteristicValueFK2: string
Maximum Length:
50
Characteristic Value FK 2 -
characteristicValueFK3: string
Maximum Length:
50
Characteristic Value FK 3 -
characteristicValueFk4: string
Maximum Length:
50
Characteristic Value FK 4 -
characteristicValueFK5: string
Maximum Length:
50
Characteristic Value FK 5 -
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
Version
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
-
characteristicValueForeignKey1: string
Maximum Length:
50
Characteristic Value FK 1
Nested Schema : items
Type:
Show Source
object
-
comments: string
Maximum Length:
254
Comments -
crew: string
Maximum Length:
60
Crew -
equipment: object
equipment
-
equipmentCount: number
Minimum Value:
0
Maximum Value:9.9999999999E8
Equipment Count -
installDateTime: string
(date-time)
Installation Date/Time
-
removalDateTime: string
(date-time)
Removal Date/Time
Nested Schema : equipment
Type:
Show Source
object
-
_link: string
_link
-
itemId: string
Maximum Length:
12
Equipment ID
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
End Date/Time
-
installationOverrideQuantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Installation Override Quantity (Daily) -
multiItemCounts: object
multiItemCounts
-
sqi: string
Maximum Length:
30
Service Quantity Identifier -
startDateTime: string
(date-time)
Start Date/Time
-
uom: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
count: number
Minimum Value:
-9.9999999999E8
Maximum Value:9.9999999999E8
Item Count -
itemType: string
Maximum Length:
30
Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.Example:ZZ_DVCTYP_7529
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.