Get Service Point Summary
get
/spl/rest/apis/customer/v-model/servicePointsCommon/{servicePointId}/summary
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1SPSummary
Type:
Show Source
object
-
_self: string
_self
-
abolishedDate: string
(date)
This is the date of the abolishment of the service point at the premise.
-
c2mFields: object
c2mFields
-
cycleRouteSequence: number
Minimum Value:
-99999
Maximum Value:99999
Route DescriptionExample:210
-
deviceLocationDescription: string
Maximum Length:
100
Description of the location of the service point at the premise.Example:Left side of house
-
disconnectLocationDescription: string
Maximum Length:
100
If the service point source status is disconnected, use Disconnect Location to specify where service was severed.Example:Transformer - Electric
-
division: string
Maximum Length:
5
CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. The default value is based on the Country and the Postal Code, but can be overridden.Example:Ohio
-
hasEquipment: boolean
Has Equipment indicates if any equipment is linked to the service point. A value of true indicates that there is equipment linked to the service point.Example:
false
-
hasMultiItems: boolean
Has Multi Items indicates a service point with multiple non-badged items. A value of true indicates that there are multiple non-badged items for the service point.Example:
false
-
installationDate: string
(date)
This is the date of the installation of the service point at the premise.Example:
2018-08-24
-
instructionDescription: string
Maximum Length:
100
Instruction Details provides more detailed instructions to the individual who reads meters at this premise.Example:Verify serial number
-
isActive: boolean
Is Active indicates if the service point is In Service or Abolished. A value of true defines the service point as active.Example:
true
-
isConnected: boolean
Is Connected defines if the service point is connected to the source of service or not. A value of true defines the service point as connected.Example:
true
-
keyAtPremise: boolean
Define Key at Premise as true if the meter is secured in a locked area and your company has the key. If this field is turned on, you may also specify the Key ID.Example:
true
-
keyId: string
Maximum Length:
10
Key Id defines the key identifier if Key at Premise field is enabled.Example:12345
-
locationDetails: string
Maximum Length:
4000
Meter Location is used to define where the service point is located on the premise.Example:Location Details added in SP Live Data
-
measurementCycleDescription: string
Maximum Length:
150
Description for the service point's measurement cycle.Example:ZZT Monthly meter rd cycle - day 1 (M-D1)
-
meterReadInstructionDetails: string
Maximum Length:
250
MR Instruction defines specific instructions that are provided to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.Example:CON
-
okToEnter: boolean
Define OK to Enter as true if the meter is located in the interior of the premise and your company has permission to enter.Example:
true
-
premise: object
premise
-
routeDescription: string
Maximum Length:
150
Description for the Measurement Cycle Route.Example:MV90 Route 1
-
servicePointId: string
Maximum Length:
10
Service Point ID is a system assigned random number that stays with a service point record.Example:3996166619
-
servicePointType: object
servicePointType
The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.
-
timeZoneName: string
Maximum Length:
50
The description for the time zone that is displayed to customers.Example:US/Pacific
-
warningDescription: string
Maximum Length:
100
MR Warning Description defines a specific warning that is provided to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.Example:Mean dog at premise
Nested Schema : c2mFields
Type:
Show Source
object
-
estimationEligibilityDescription: string
Maximum Length:
100
Description for Estimation Eligibility -
mainContact: object
mainContact
-
marketDescription: string
Maximum Length:
100
Description for service point market.Example:ERCOT
-
mdmServicePointId: string
Maximum Length:
12
Service Point ID is a system assigned random number that stays with a service point record in Meter Data Management system.Example:848918749582
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
formattedAddress: string
Maximum Length:
254
The Premise ID is a system assigned random number that stays with a premise for life. -
lifeSupportSensitiveLoad: boolean
The Premise ID is a system assigned random number that stays with a premise for life.
-
lifeSupportSensitiveLoadDescription: string
Maximum Length:
1000
The Premise ID is a system assigned random number that stays with a premise for life. -
premiseId: string
Maximum Length:
10
The Premise ID is a system assigned random number that stays with a premise for life.
Nested Schema : servicePointType
Type:
object
The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.
Show Source
-
_link: string
_link
-
category: string
Maximum Length:
4
The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.Example:G-COM
-
servicePointType: string
Maximum Length:
30
The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.Example:G-COM
-
servicePointTypeDescription: string
Maximum Length:
150
The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.Example:G-COM
-
serviceType: string
Maximum Length:
80
The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.Example:G-COM
Nested Schema : mainContact
Type:
Show Source
object
-
_link: string
_link
-
contactId: string
Maximum Length:
10
Person Contact -
name: string
Maximum Length:
1
Person Contact
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.