Search SP for Premise
post
https://server:port/spl/rest/apis/cross/v-model/servicePoints/summary
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page LimitExample:15
-
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page OffsetExample:25
-
premiseId: string
Maximum Length:
10
The Premise ID is a system assigned random number that stays with a premise for life.
Root Schema : schema
Type:
Show Source
object
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page LimitExample:15
-
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page OffsetExample:25
-
premiseId: string
Maximum Length:
10
The Premise ID is a system assigned random number that stays with a premise for life.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1GtPremAcc
Type:
Show Source
object
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page LimitExample:15
-
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page OffsetExample:25
-
servicePointList: array
servicePointList
-
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of RecordsExample:67
Nested Schema : items
Type:
Show Source
object
-
badgeNumber: string
Maximum Length:
120
The Badge Number is the identifier stamped on the meter. This is not the manufacturer's serial number.Example:BN20_YC_7529
-
deviceId: string
Maximum Length:
12
Device ID indicates the unique system identifier of additional equipment installed at the service point.Example:832023898296
-
deviceType: 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
-
deviceTypeDescription: string
Maximum Length:
100
Description for Device TypeExample:00ZZ_DVCTYP_7529
-
manufacturer: string
Maximum Length:
30
Manufacturer is the meter device manufacturer.Example:ZZ_MANUFACTURER_7529
-
model: string
Maximum Length:
30
ModelExample:E
-
serialNumber: string
Maximum Length:
120
The device identifier for the Serial Number.Example:BN20_YC_7529
-
servicePointId: string
Maximum Length:
10
Service Point ID is a system assigned random number that stays with a service point record.Example:3996166619
-
servicePointType: string
Maximum Length:
30
Service Point Type indicates the category of the device location where the service is delivered.Example:ZZ_ERT_ITM_SP_TYPE_01
-
servicePointTypeDescription: string
Maximum Length:
50
Description for Service Point TypeExample:ERT ITEM SP Type 01
-
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the SA type.Example:E
-
serviceTypeDescription: string
Maximum Length:
100
Description for Service TypeExample:Electric
-
timeZone: string
Maximum Length:
10
TimezoneExample:USPACIFIC
-
timeZoneName: string
Maximum Length:
50
Timezone NameExample:US/Pacific
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.