Get Service Point
get
rest/apis/cross/v-model/servicePoints/{servicePointId}
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 : C1-ServicePt
Type:
Show Source
object
-
_self: string
_self
-
abolishedDate: string
(date)
Abolished Date is the date when service point was abolished.Example:
2005-01-01
-
characteristics: object
characteristics
-
disconnectLocation: object
disconnectLocation
If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
-
equipment: object
equipment
-
facilityLevel1: string
Maximum Length:
8
Designate the facility hierarchy that supplies service to the service point using the Facility Levels.Example:E (Substation - east)
-
facilityLevel2: string
Maximum Length:
8
Designate the facility hierarchy that supplies service to the service point using the Facility Levels.Example:2 (Feeder 2 )
-
facilityLevel3: string
Maximum Length:
8
Designate the facility hierarchy that supplies service to the service point using the Facility Levels.Example:A (Node A)
-
geographicLocations: object
geographicLocations
-
installationDate: string
(date)
Date of the installation of the service point connection at the premise.Example:
2007-06-1
-
keyAtPremise: boolean
Turn on Key at Premise 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.
-
keyId: string
Maximum Length:
10
Turn on Key at Premise 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. -
location: object
location
-
locationDetails: string
Maximum Length:
4000
Location Details are used to clarify the location at the premise.Example:Left side of house
-
meterReadInstruction: string
Maximum Length:
4
Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.Example:SER
-
meterReadInstructionDetails: string
Maximum Length:
250
Provides more detailed instructions to the individual who reads meters at this premise.Example:Suspect Dangerous occupants
-
meterReadWarning: string
Maximum Length:
4
Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.Example:DANG
-
multiItems: object
multiItems
-
okToEnter: boolean
If the Override premise field information is set to yes , then Turn on OK to Enter if the meter is located in the interior of the premise and your company has permission to enter.Example:
false
-
operationAreas: object
operationAreas
-
overridePremiseFieldInfo: string
Allowed Values:
[ "N ", "Y " ]
To override premise field information on a specific service point, set Override Premise Field Information to Yes. If the value is set to No, the premise information may not be overridden. * `N ` - No, * `Y ` - YesExample:N
-
premise: object
premise
-
serviceCycle: object
serviceCycle
If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.
-
serviceCycleRouteSequence: number
Minimum Value:
-99999999
Maximum Value:99999999
If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.Example:0
-
servicePointId: string
Maximum Length:
10
Service Point ID is a system assigned random number that stays with a service point record.Example:3996166619
-
servicePointSourceStatus: string
Allowed Values:
[ "C ", "D " ]
Service Point Source Status defines whether the service point is connected to the source of power. Valid values are: Connected and Disconnected. * `C ` - Connected, * `D ` - DisconnectedExample:C
-
servicePointStatus: string
Allowed Values:
[ "I ", "R " ]
Service Point Status controls whether the service point can be linked to new service agreements. SP status indicates if the service point is In Service or Abolished * `I ` - Out of Service, * `R ` - In ServiceExample:R
-
servicePointType: object
servicePointType
The Service Point Type defines specific types of points at which service is delivered.
-
serviceRoute: string
Maximum Length:
16
If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.Example:1
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : disconnectLocation
Type:
object
If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
Show Source
-
_link: string
_link
-
disconnectLocation: string
Maximum Length:
4
If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
Nested Schema : location
Type:
Show Source
object
-
_link: string
_link
-
meterLocation: string
Maximum Length:
4
Meter Location is used to define where the service point is located on the premise.Example:LEFT
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseId: string
Maximum Length:
10
The Premise ID is a system assigned random number that stays with a premise for life.
Nested Schema : serviceCycle
Type:
object
If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.
Show Source
-
_link: string
_link
-
serviceCycle: string
Maximum Length:
16
If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.Example:M-D1
Nested Schema : servicePointType
Type:
object
The Service Point Type defines specific types of points at which service is delivered.
Show Source
-
_link: string
_link
-
servicePointType: string
Maximum Length:
30
The Service Point Type defines specific types of points at which service is delivered.Example:G-COM
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.
-
typeOfCharacteristicValue: string
Allowed Values:
[ "ADV ", "DFV ", "FKV ", "FLV " ]
Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value -
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
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)
-
value: string
Maximum Length:
254
Adhoc Characteristic Value -
value2: string
Maximum Length:
50
Foreign Key Value 2 -
value3: string
Maximum Length:
50
Foreign Key Value 3 -
value4: string
Maximum Length:
50
Foreign Key Value 4 -
value5: string
Maximum Length:
50
Foreign Key Value 5
Nested Schema : items
Type:
Show Source
object
-
comment: string
Maximum Length:
60
Use comments to explain anything unusual about the piece of equipment. -
equipment: object
equipment
-
equipmentCount: number
Minimum Value:
-999999999.99
Maximum Value:999999999.99
Equipment Count field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.Example:1.00
-
installationDate: string
(date)
Date of the installation of the service point connection at the premise.Example:
2007-06-1
-
removalDate: string
(date)
Defines the date that the equipment was removed from the service point.Example:
2007-06-1
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : equipment
Type:
Show Source
object
-
_link: string
_link
-
equipmentId: string
Maximum Length:
10
Item ID
Nested Schema : items
Type:
Show Source
object
-
geographicType: object
geographicType
-
geographicValue: string
Maximum Length:
50
Specifies the geographic value such as a coordinate.Example:1002748
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : geographicType
Type:
Show Source
object
-
_link: string
_link
-
geographicType: string
Maximum Length:
8
Geographic Type
Nested Schema : items
Type:
Show Source
object
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.
-
multiItem: object
multiItem
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : items
Type:
Show Source
object
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.
-
itemCount: number
Minimum Value:
-999999999.99
Maximum Value:999999999.99
Indicates how many of the given type of item exist at the service point. -
itemType: object
itemType
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : itemType
Type:
Show Source
object
-
_link: string
_link
-
itemType: string
Maximum Length:
30
Item Type
Nested Schema : items
Type:
Show Source
object
-
fieldServiceClass: string
Maximum Length:
5
Indicates the field service classification.Example:METER
-
operationsArea: string
Maximum Length:
8
Specifies the operation area that manages field activities associated with the field service classification.Example:NORTH
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
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.