1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. V-Model
  4. Service Points
  5. Customer to Meter

Update Service Point

put

/rest/apis/cross/v-model/servicePoints/{servicePointId}

Request

Path Parameters
Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
  • Abolished Date is the date when service point was abolished.
    Example: 2005-01-01
  • characteristics
  • disconnectLocation
    If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
  • equipment
  • Maximum Length: 8
    Designate the facility hierarchy that supplies service to the service point using the Facility Levels.
    Example: E (Substation - east)
  • Maximum Length: 8
    Designate the facility hierarchy that supplies service to the service point using the Facility Levels.
    Example: 2 (Feeder 2 )
  • Maximum Length: 8
    Designate the facility hierarchy that supplies service to the service point using the Facility Levels.
    Example: A (Node A)
  • geographicLocations
  • Date of the installation of the service point connection at the premise.
    Example: 2007-06-1
  • 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.
  • 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
  • Maximum Length: 4000
    Location Details are used to clarify the location at the premise.
    Example: Left side of house
  • 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
  • Maximum Length: 250
    Provides more detailed instructions to the individual who reads meters at this premise.
    Example: Suspect Dangerous occupants
  • Maximum Length: 4
    Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.
    Example: DANG
  • multiItems
  • 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
  • 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 ` - Yes
    Example: N
  • premise
  • 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.
  • 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
  • Maximum Length: 10
    Service Point ID is a system assigned random number that stays with a service point record.
    Example: 3996166619
  • 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 ` - Disconnected
    Example: C
  • 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 Service
    Example: R
  • servicePointType
    The Service Point Type defines specific types of points at which service is delivered.
  • 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
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : disconnectLocation
Type: object
If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
Show Source
  • Maximum Length: 4
    If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
Nested Schema : equipment
Type: object
Show Source
Nested Schema : geographicLocations
Type: object
Show Source
Nested Schema : location
Type: object
Show Source
  • Maximum Length: 4
    Meter Location is used to define where the service point is located on the premise.
    Example: LEFT
Nested Schema : multiItems
Type: object
Show Source
Nested Schema : operationAreas
Type: object
Show Source
Nested Schema : premise
Type: object
Show Source
  • 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
  • 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
  • Maximum Length: 30
    The Service Point Type defines specific types of points at which service is delivered.
    Example: G-COM
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 60
    Use comments to explain anything unusual about the piece of equipment.
  • equipment
  • 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
  • Date of the installation of the service point connection at the premise.
    Example: 2007-06-1
  • Defines the date that the equipment was removed from the service point.
    Example: 2007-06-1
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : equipment
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : geographicType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : multiItem
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.
  • Minimum Value: -999999999.99
    Maximum Value: 999999999.99
    Indicates how many of the given type of item exist at the service point.
  • itemType
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : itemType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 5
    Indicates the field service classification.
    Example: METER
  • Maximum Length: 8
    Specifies the operation area that manages field activities associated with the field service classification.
    Example: NORTH
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Abolished Date is the date when service point was abolished.
    Example: 2005-01-01
  • characteristics
  • disconnectLocation
    If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
  • equipment
  • Maximum Length: 8
    Designate the facility hierarchy that supplies service to the service point using the Facility Levels.
    Example: E (Substation - east)
  • Maximum Length: 8
    Designate the facility hierarchy that supplies service to the service point using the Facility Levels.
    Example: 2 (Feeder 2 )
  • Maximum Length: 8
    Designate the facility hierarchy that supplies service to the service point using the Facility Levels.
    Example: A (Node A)
  • geographicLocations
  • Date of the installation of the service point connection at the premise.
    Example: 2007-06-1
  • 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.
  • 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
  • Maximum Length: 4000
    Location Details are used to clarify the location at the premise.
    Example: Left side of house
  • 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
  • Maximum Length: 250
    Provides more detailed instructions to the individual who reads meters at this premise.
    Example: Suspect Dangerous occupants
  • Maximum Length: 4
    Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.
    Example: DANG
  • multiItems
  • 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
  • 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 ` - Yes
    Example: N
  • premise
  • 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.
  • 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
  • Maximum Length: 10
    Service Point ID is a system assigned random number that stays with a service point record.
    Example: 3996166619
  • 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 ` - Disconnected
    Example: C
  • 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 Service
    Example: R
  • servicePointType
    The Service Point Type defines specific types of points at which service is delivered.
  • 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
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : disconnectLocation
Type: object
If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
Show Source
  • Maximum Length: 4
    If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
Nested Schema : equipment
Type: object
Show Source
Nested Schema : geographicLocations
Type: object
Show Source
Nested Schema : location
Type: object
Show Source
  • Maximum Length: 4
    Meter Location is used to define where the service point is located on the premise.
    Example: LEFT
Nested Schema : multiItems
Type: object
Show Source
Nested Schema : operationAreas
Type: object
Show Source
Nested Schema : premise
Type: object
Show Source
  • 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
  • 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
  • Maximum Length: 30
    The Service Point Type defines specific types of points at which service is delivered.
    Example: G-COM
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 60
    Use comments to explain anything unusual about the piece of equipment.
  • equipment
  • 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
  • Date of the installation of the service point connection at the premise.
    Example: 2007-06-1
  • Defines the date that the equipment was removed from the service point.
    Example: 2007-06-1
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : equipment
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : geographicType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : multiItem
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.
  • Minimum Value: -999999999.99
    Maximum Value: 999999999.99
    Indicates how many of the given type of item exist at the service point.
  • itemType
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : itemType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 5
    Indicates the field service classification.
    Example: METER
  • Maximum Length: 8
    Specifies the operation area that manages field activities associated with the field service classification.
    Example: NORTH
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1-ServicePt
Type: object
Show Source
  • _self
  • Abolished Date is the date when service point was abolished.
    Example: 2005-01-01
  • characteristics
  • disconnectLocation
    If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
  • equipment
  • Maximum Length: 8
    Designate the facility hierarchy that supplies service to the service point using the Facility Levels.
    Example: E (Substation - east)
  • Maximum Length: 8
    Designate the facility hierarchy that supplies service to the service point using the Facility Levels.
    Example: 2 (Feeder 2 )
  • Maximum Length: 8
    Designate the facility hierarchy that supplies service to the service point using the Facility Levels.
    Example: A (Node A)
  • geographicLocations
  • Date of the installation of the service point connection at the premise.
    Example: 2007-06-1
  • 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.
  • 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
  • Maximum Length: 4000
    Location Details are used to clarify the location at the premise.
    Example: Left side of house
  • 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
  • Maximum Length: 250
    Provides more detailed instructions to the individual who reads meters at this premise.
    Example: Suspect Dangerous occupants
  • Maximum Length: 4
    Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.
    Example: DANG
  • multiItems
  • 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
  • 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 ` - Yes
    Example: N
  • premise
  • 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.
  • 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
  • Maximum Length: 10
    Service Point ID is a system assigned random number that stays with a service point record.
    Example: 3996166619
  • 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 ` - Disconnected
    Example: C
  • 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 Service
    Example: R
  • servicePointType
    The Service Point Type defines specific types of points at which service is delivered.
  • 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
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : disconnectLocation
Type: object
If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
Show Source
Nested Schema : equipment
Type: object
Show Source
Nested Schema : geographicLocations
Type: object
Show Source
Nested Schema : location
Type: object
Show Source
Nested Schema : multiItems
Type: object
Show Source
Nested Schema : operationAreas
Type: object
Show Source
Nested Schema : premise
Type: object
Show Source
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
  • 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
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 60
    Use comments to explain anything unusual about the piece of equipment.
  • equipment
  • 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
  • Date of the installation of the service point connection at the premise.
    Example: 2007-06-1
  • Defines the date that the equipment was removed from the service point.
    Example: 2007-06-1
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : equipment
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : geographicType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : multiItem
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.
  • Minimum Value: -999999999.99
    Maximum Value: 999999999.99
    Indicates how many of the given type of item exist at the service point.
  • itemType
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : itemType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 5
    Indicates the field service classification.
    Example: METER
  • Maximum Length: 8
    Specifies the operation area that manages field activities associated with the field service classification.
    Example: NORTH
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top