Get Service Point
get
https://server:port/spl/rest/apis/customer/v-model/servicePoints/{servicePointId}
This Operation handles the Integration Suite API to Get Service Point.
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 : D1ServPoint
Type:
Show Source
object
-
_self: string
_self
-
accessGroup: object
accessGroup
Access Group
-
address: object
address
-
assetLocationId: string
Maximum Length:
120
Asset System SP ID -
creationDateTime: string
(date-time)
Create Date/TimeExample:
2012-01-19T03:25:38-08:00
-
deviceLocation: string
Allowed Values:
[ "ZZCIT", "ZZGR", "ZZBK", "ZZSR", "ZZRS", "ZZLS" ]
Device Location is used to define where the service point is located on the premise. * `ZZCIT` - Test CIT, * `ZZGR` - Garage, * `ZZBK` - Backyard, * `ZZSR` - SR related location, * `ZZRS` - Right Side, * `ZZLS` - Left SideExample:ZZBK
-
deviceLocationDetails: string
Maximum Length:
250
Location Details are used to clarify the location at the premise. -
disconnectLocation: string
Allowed Values:
[ "D1DV", "D1SR" ]
If the Service point source status is disconnected, use Disconnect Location to specify where service was severed. * `D1DV` - Device, * `D1SR` - SourceExample:D1SR
-
distributionNetworkFacility: string
Maximum Length:
14
Distribution Network Facility -
division: object
division
Divisions are used to delineate between different operating companies within a large conglomerate of utilities.
-
equipment: object
equipment
-
estimationEligibility: string
Allowed Values:
[ "D1EL", "D1NE" ]
Periodic estimation Eligibility determines if measuring component is eligible for estimation. * `D1EL` - Eligible, * `D1NE` - Not EligibleExample:D1EL
-
externalPremiseId: string
Maximum Length:
60
External Premise IDExample:0979106528
-
externalServicePointId: string
Maximum Length:
60
External Service Point ID defines External Systems with which Oracle Utilities Meter Data Management should be able to communicate.Example:0979106595
-
geographicLatitude: number
Minimum Value:
-9.99999999999999E8
Maximum Value:9.99999999999999E8
Geographic Latitude displays the geographic latitude information that defines where the service point is located.Example:40.779680
-
geographicLongitude: number
Minimum Value:
-9.99999999999999E8
Maximum Value:9.99999999999999E8
Geographic Longitude displays the geographic longitude information that defines where the service point is located.Example:-81.399990
-
key: string
Allowed Values:
[ "ZZKEY", "ZZ-KEY2", "false", "true", "ZZYES", "ZZNO" ]
Key * `ZZKEY` - Test Key, * `ZZ-KEY2` - Test Key 2, * `false` - No, * `true` - Yes, * `ZZYES` - Yes, * `ZZNO` - NoExample:ZZNO
-
keyId: string
Maximum Length:
30
Specify the Key ID if the meter is secured in a locked area and your company has the key.Example:No key at premise
-
lifeSupportSensitiveLoad: string
Allowed Values:
[ "ZZLS", "ZZNC", "ZZNL" ]
Indicates if the current service point supplies service to life support equipment (or if the load supplied to the service point is considered sensitive). * `ZZLS` - On life support, * `ZZNC` - None, * `ZZNL` - Not on life supportExample:ZZNL
-
lifeSupportSensitiveLoadDescription: string
Maximum Length:
4000
Life Support sensitive load descriptionExample:Not on life support
-
mainContact: string
Maximum Length:
12
The main contact for the service provider. -
market: object
market
Defines jurisdictions or regulatory environments in which a Service Point participates.
-
marketParticipants: object
marketParticipants
-
mdmExternalId: string
Maximum Length:
60
MDM External ID -
measurementCycle: object
measurementCycle
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
-
measurementCycleRoute: string
Maximum Length:
30
Route specifies the group of service points in a cycle that are visited by a meter reader.Example:R1
-
measurementCycleRouteSequence: number
Minimum Value:
-999999999
Maximum Value:999999999
Sequence -
multiItems: object
multiItems
-
okToEnter: string
Allowed Values:
[ "ZZCIT1", "false", "true", "ZZYES", "ZZNO" ]
Turn on OK to Enter if the meter is located in the interior of the premise and your company has permission to enter. * `ZZCIT1` - Test CIT, * `false` - False, * `true` - True, * `ZZYES` - Yes, * `ZZNO` - NoExample:false
-
parentServicePoint: object
parentServicePoint
-
primaryUsageSubscriptionId: string
Maximum Length:
12
Usage Subscription ID is a system assigned random number that stays with a usage subscription record. -
servicePointId: string
Maximum Length:
12
Service Point ID -
servicePointType: object
servicePointType
-
sourceStatus: string
Allowed Values:
[ "D1CN", "D1DC" ]
Service Point Source Status defines whether the service point is connected to the source of power. Valid values are: Connected and Disconnected. * `D1CN` - Connected, * `D1DC` - DisconnectedExample:D1CN
-
spInstruction: string
Allowed Values:
[ "ZZ-SPI", "ZZLRC", "ZZSPINSTR", "ZZTEST14521", "ZZCON", "ZZCHKSEAL", "ZZSER" ]
Indicate a SP Instruction if specific instructions should be downloaded to the person who reads the meter. * `ZZ-SPI` - ZZ-SPI, * `ZZLRC` - Leave read card with customer, * `ZZSPINSTR` - Test SPINSTR, * `ZZTEST14521` - test, * `ZZCON` - Verify constant, * `ZZCHKSEAL` - Check Seal, * `ZZSER` - Verify serial numberExample:ZZCHKSEAL
-
spInstructionDetails: string
Maximum Length:
250
SP Instruction Details provides more detailed instructions to the individual who reads meters at this premise.Example:Suspect Dangerous occupants
-
spWarning: string
Allowed Values:
[ "ZZ-BADDOG", "ZZWARN", "ZZCAT", "ZZNEIG", "ZZRS", "ZZDIVE", "ZZDANG", "ZZSW" ]
Indicate a SP Warning if a specific warning should be downloaded to the person who reads the meter. * `ZZ-BADDOG` - BAD DOG, * `ZZWARN` - Test Warn, * `ZZCAT` - Mean cat at premise, * `ZZNEIG` - Suspicious neighbor, * `ZZRS` - ZZRS, * `ZZDIVE` - History of service diversion, * `ZZDANG` - Suspect dangerous occupants, * `ZZSW` - ZZSWExample:ZZDANG
-
status: string
Maximum Length:
12
The current status of the service point.Example:ACTIVE
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2012-01-19T03:25:38-08:00
-
timeZone: object
timeZone
Enter the Time Zone in which the premise is located.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:5
Nested Schema : accessGroup
Type:
object
Access Group
Show Source
-
_link: string
_link
-
accessGroup: string
Maximum Length:
12
Access Group
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
The first line of the address.Example:329 NEWBURY AVE NW
-
address2: string
Maximum Length:
254
The second line of the address. -
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
city: string
Maximum Length:
90
The city of the address.Example:Uniontown
-
country: object
country
The country of the address.
-
county: string
Maximum Length:
90
The county of the address. -
postal: string
Maximum Length:
12
The postal of the address.Example:44685
-
state: string
Maximum Length:
6
The state of the address.Example:OH
-
streetNumber1: string
Maximum Length:
6
The first street number line of the address. -
streetNumber2: string
Maximum Length:
4
The second street number line of the address.
Nested Schema : division
Type:
object
Divisions are used to delineate between different operating companies within a large conglomerate of utilities.
Show Source
-
_link: string
_link
-
division: string
Maximum Length:
30
Divisions are used to delineate between different operating companies within a large conglomerate of utilities.Example:CA
Nested Schema : market
Type:
object
Defines jurisdictions or regulatory environments in which a Service Point participates.
Show Source
-
_link: string
_link
-
market: string
Maximum Length:
30
Defines jurisdictions or regulatory environments in which a Service Point participates.Example:ZZ_SMSR_MKT10111024
Nested Schema : measurementCycle
Type:
object
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
Show Source
-
_link: string
_link
-
measurementCycle: string
Maximum Length:
30
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.Example:MONTHLYDAY1
Nested Schema : parentServicePoint
Type:
Show Source
object
-
_link: string
_link
-
parentServicePointId: string
Maximum Length:
12
Related Service Point
Nested Schema : servicePointType
Type:
Show Source
object
-
_link: string
_link
-
servicePointType: string
Maximum Length:
30
Service Point Type
Nested Schema : timeZone
Type:
object
Enter the Time Zone in which the premise is located.
Show Source
-
_link: string
_link
-
timeZone: string
Maximum Length:
10
Enter the Time Zone in which the premise is located.Example:USPACIFIC
Nested Schema : country
Type:
object
The country of the address.
Show Source
-
_link: string
_link
-
country: string
Maximum Length:
3
The country of the address.Example:USA
Nested Schema : items
Type:
Show Source
object
-
comments: string
Maximum Length:
254
Use comments to explain anything unusual about the piece of equipment. -
crew: string
Maximum Length:
60
Crew -
equipment: object
equipment
-
equipmentCount: number
Minimum Value:
0
Maximum Value:9.9999999999E8
Equipment Count This 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
-
installDateTime: string
(date-time)
Date of the installation of the service point connection at the premise.Example:
2007-06-1
-
removalDateTime: string
(date-time)
Defines the date that the equipment was removed from the service point.Example:
2007-06-1
Nested Schema : equipment
Type:
Show Source
object
-
_link: string
_link
-
equipmentId: string
Maximum Length:
12
Device ID
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
The End Date/Time of the multi-item list.
-
marketRelationshipType: string
Allowed Values:
[ "ZZDE", "ZZDS", "ZZDT", "ZZRT", "ZZSE", "ZZSU" ]
Markets define market relationships for valid service providers and their roles within a market (distributor, etc.). * `ZZDE` - Distributor Type, * `ZZDS` - Distributor, * `ZZDT` - Distributor Type2, * `ZZRT` - Retailer, * `ZZSE` - Scheduling Entity, * `ZZSU` - SupplierExample:ZZDE
-
serviceProvider: object
serviceProvider
-
startDateTime: string
(date-time)
The Start Date/time of the multi-item list.
Nested Schema : serviceProvider
Type:
Show Source
object
-
_link: string
_link
-
serviceProvider: string
Maximum Length:
30
Service Provider
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
The End Date/Time of the multi-item list.
-
installationOverrideQuantity: number
Minimum Value:
-9.999999999999998E9
Maximum Value:9.999999999999998E9
Installation Override Quantity -
multiItemCounts: object
multiItemCounts
-
sqi: string
Maximum Length:
30
Used to further distinguish between measured quantities that have identical UOM/TOU combinations (i.e. Generated, Consumed, etc.) -
startDateTime: string
(date-time)
The Start Date/time of the multi-item list.
-
uom: string
Maximum Length:
30
A metric of how measurement data is measured (i.e. kWh, kVARh, CCF, etc.)
Nested Schema : items
Type:
Show Source
object
-
count: number
Minimum Value:
-9.9999999999E8
Maximum Value:9.9999999999E8
Indicates how many of the given type of item exist at the service point.Example:1.00
-
itemType: string
Maximum Length:
30
Indicates the type of itemExample:CT BADGE
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.