Oracle Utilities REST API for Metering and Customer Information

Retrieve Service Points Info corresponding to a Premise

get

/rest/apis/customer/v-model/servicePointSearch/{premiseId}/getServicePointsInfoForPremise

Request

Path Parameters

premiseId(required): string
Premise ID is a system-assigned, unique identifier for the primary premise associated with the service agreement.
Example:
```
3364881208
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1PremToSPs

Type: object

Show Source

limit: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

Limit determines the page size, or maximum number of results, of the search query.

Example: 20
offset: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

Offset determines the starting point of results to return for the search query.

Example: 0
servicePointList: array servicePointList
totalNumberOfRecords: number

Minimum Value: 0

Maximum Value: 99999

The total number of records returned in a service point search.

Example: 3

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit determines the page size, or maximum number of results, of the search query.",
            "example":"20"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset determines the starting point of results to return for the search query.",
            "example":"0"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"The total number of records returned in a service point search.",
            "example":"3"
        },
        "servicePointList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID is a system assigned random number that defines a service point record."
                    },
                    "servicePointTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Service Point Type Description"
                    },
                    "isMetered":{
                        "type":"boolean",
                        "description":"Indicates a service point sub type as a metered service point when defined as true. A value of false indicates that the service point is not metered.",
                        "example":"true"
                    },
                    "servicePointDescription":{
                        "type":"string",
                        "enum":[
                            "I   ",
                            "R   "
                        ],
                        "description":"Service Point Status:\n* `I   ` - Out of Service,\n* `R   ` - In Service"
                    },
                    "installationDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The installation date for a service point."
                    },
                    "abolishedDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Out of Service Date"
                    },
                    "sourceStatusDescription":{
                        "type":"string",
                        "enum":[
                            "C   ",
                            "D   "
                        ],
                        "description":"A description or label of the service point source status.\n* `C   ` - Connected,\n* `D   ` - Disconnected",
                        "example":"Connected"
                    },
                    "badgedDevice":{
                        "type":"object",
                        "properties":{
                            "deviceTypeDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"The general description or label for a device type.",
                                "example":"10K mercury vapor"
                            },
                            "deviceInfo":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Relevant information about the device.",
                                "example":"10K mercury vapor / L029 / SKS-029 - Active"
                            },
                            "badgeNumber":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Badge Number"
                            },
                            "deviceInstallationDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The installation date and time for a service point device.",
                                "example":"2004-04-21T00:00:00-07:00"
                            },
                            "deviceStatus":{
                                "type":"string",
                                "maxLength":4,
                                "description":"The status of a device.",
                                "example":"on"
                            }
                        }
                    },
                    "unbadgedDevices":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "startDateTime":{
                                    "type":"string",
                                    "format":"date-time",
                                    "description":"Start Date/Time"
                                },
                                "unbadgedDevicesInfo":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "deviceTypeDescription":{
                                                "type":"string",
                                                "maxLength":100,
                                                "description":"The general description or label for a device type.",
                                                "example":"10K mercury vapor"
                                            },
                                            "numberInstalled":{
                                                "type":"number",
                                                "maximum":99999,
                                                "minimum":0,
                                                "description":"Unbadged device count"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PremToSPs"
    }
}

Nested Schema : servicePointList

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "servicePointId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID is a system assigned random number that defines a service point record."
            },
            "servicePointTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Service Point Type Description"
            },
            "isMetered":{
                "type":"boolean",
                "description":"Indicates a service point sub type as a metered service point when defined as true. A value of false indicates that the service point is not metered.",
                "example":"true"
            },
            "servicePointDescription":{
                "type":"string",
                "enum":[
                    "I   ",
                    "R   "
                ],
                "description":"Service Point Status:\n* `I   ` - Out of Service,\n* `R   ` - In Service"
            },
            "installationDate":{
                "type":"string",
                "format":"date",
                "description":"The installation date for a service point."
            },
            "abolishedDate":{
                "type":"string",
                "format":"date",
                "description":"Out of Service Date"
            },
            "sourceStatusDescription":{
                "type":"string",
                "enum":[
                    "C   ",
                    "D   "
                ],
                "description":"A description or label of the service point source status.\n* `C   ` - Connected,\n* `D   ` - Disconnected",
                "example":"Connected"
            },
            "badgedDevice":{
                "type":"object",
                "properties":{
                    "deviceTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"The general description or label for a device type.",
                        "example":"10K mercury vapor"
                    },
                    "deviceInfo":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Relevant information about the device.",
                        "example":"10K mercury vapor / L029 / SKS-029 - Active"
                    },
                    "badgeNumber":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Badge Number"
                    },
                    "deviceInstallationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The installation date and time for a service point device.",
                        "example":"2004-04-21T00:00:00-07:00"
                    },
                    "deviceStatus":{
                        "type":"string",
                        "maxLength":4,
                        "description":"The status of a device.",
                        "example":"on"
                    }
                }
            },
            "unbadgedDevices":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "startDateTime":{
                            "type":"string",
                            "format":"date-time",
                            "description":"Start Date/Time"
                        },
                        "unbadgedDevicesInfo":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "deviceTypeDescription":{
                                        "type":"string",
                                        "maxLength":100,
                                        "description":"The general description or label for a device type.",
                                        "example":"10K mercury vapor"
                                    },
                                    "numberInstalled":{
                                        "type":"number",
                                        "maximum":99999,
                                        "minimum":0,
                                        "description":"Unbadged device count"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

abolishedDate: string (date)

Out of Service Date
badgedDevice: object badgedDevice
installationDate: string (date)

The installation date for a service point.
isMetered: boolean

Indicates a service point sub type as a metered service point when defined as true. A value of false indicates that the service point is not metered.

Example: true
servicePointDescription: string

Allowed Values: [ "I ", "R " ]

Service Point Status: * `I ` - Out of Service, * `R ` - In Service
servicePointId: string

Maximum Length: 10

Service Point ID is a system assigned random number that defines a service point record.
servicePointTypeDescription: string

Maximum Length: 150

Service Point Type Description
sourceStatusDescription: string

Allowed Values: [ "C ", "D " ]

A description or label of the service point source status. * `C ` - Connected, * `D ` - Disconnected

Example: Connected
unbadgedDevices: array unbadgedDevices

{
    "type":"object",
    "properties":{
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is a system assigned random number that defines a service point record."
        },
        "servicePointTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Service Point Type Description"
        },
        "isMetered":{
            "type":"boolean",
            "description":"Indicates a service point sub type as a metered service point when defined as true. A value of false indicates that the service point is not metered.",
            "example":"true"
        },
        "servicePointDescription":{
            "type":"string",
            "enum":[
                "I   ",
                "R   "
            ],
            "description":"Service Point Status:\n* `I   ` - Out of Service,\n* `R   ` - In Service"
        },
        "installationDate":{
            "type":"string",
            "format":"date",
            "description":"The installation date for a service point."
        },
        "abolishedDate":{
            "type":"string",
            "format":"date",
            "description":"Out of Service Date"
        },
        "sourceStatusDescription":{
            "type":"string",
            "enum":[
                "C   ",
                "D   "
            ],
            "description":"A description or label of the service point source status.\n* `C   ` - Connected,\n* `D   ` - Disconnected",
            "example":"Connected"
        },
        "badgedDevice":{
            "type":"object",
            "properties":{
                "deviceTypeDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"The general description or label for a device type.",
                    "example":"10K mercury vapor"
                },
                "deviceInfo":{
                    "type":"string",
                    "maxLength":150,
                    "description":"Relevant information about the device.",
                    "example":"10K mercury vapor / L029 / SKS-029 - Active"
                },
                "badgeNumber":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Badge Number"
                },
                "deviceInstallationDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The installation date and time for a service point device.",
                    "example":"2004-04-21T00:00:00-07:00"
                },
                "deviceStatus":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The status of a device.",
                    "example":"on"
                }
            }
        },
        "unbadgedDevices":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start Date/Time"
                    },
                    "unbadgedDevicesInfo":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "deviceTypeDescription":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"The general description or label for a device type.",
                                    "example":"10K mercury vapor"
                                },
                                "numberInstalled":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":0,
                                    "description":"Unbadged device count"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : badgedDevice

Type: object

Show Source

badgeNumber: string

Maximum Length: 30

Badge Number
deviceInfo: string

Maximum Length: 150

Relevant information about the device.

Example: 10K mercury vapor / L029 / SKS-029 - Active
deviceInstallationDateTime: string (date-time)

The installation date and time for a service point device.

Example: 2004-04-21T00:00:00-07:00
deviceStatus: string

Maximum Length: 4

The status of a device.

Example: on
deviceTypeDescription: string

Maximum Length: 100

The general description or label for a device type.

Example: 10K mercury vapor

{
    "type":"object",
    "properties":{
        "deviceTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"The general description or label for a device type.",
            "example":"10K mercury vapor"
        },
        "deviceInfo":{
            "type":"string",
            "maxLength":150,
            "description":"Relevant information about the device.",
            "example":"10K mercury vapor / L029 / SKS-029 - Active"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":30,
            "description":"Badge Number"
        },
        "deviceInstallationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The installation date and time for a service point device.",
            "example":"2004-04-21T00:00:00-07:00"
        },
        "deviceStatus":{
            "type":"string",
            "maxLength":4,
            "description":"The status of a device.",
            "example":"on"
        }
    }
}

Nested Schema : unbadgedDevices

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Start Date/Time"
            },
            "unbadgedDevicesInfo":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "deviceTypeDescription":{
                            "type":"string",
                            "maxLength":100,
                            "description":"The general description or label for a device type.",
                            "example":"10K mercury vapor"
                        },
                        "numberInstalled":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":0,
                            "description":"Unbadged device count"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

startDateTime: string (date-time)

Start Date/Time
unbadgedDevicesInfo: array unbadgedDevicesInfo

{
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Date/Time"
        },
        "unbadgedDevicesInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deviceTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"The general description or label for a device type.",
                        "example":"10K mercury vapor"
                    },
                    "numberInstalled":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":0,
                        "description":"Unbadged device count"
                    }
                }
            }
        }
    }
}

Nested Schema : unbadgedDevicesInfo

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deviceTypeDescription":{
                "type":"string",
                "maxLength":100,
                "description":"The general description or label for a device type.",
                "example":"10K mercury vapor"
            },
            "numberInstalled":{
                "type":"number",
                "maximum":99999,
                "minimum":0,
                "description":"Unbadged device count"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

deviceTypeDescription: string

Maximum Length: 100

The general description or label for a device type.

Example: 10K mercury vapor
numberInstalled: number

Minimum Value: 0

Maximum Value: 99999

Unbadged device count

{
    "type":"object",
    "properties":{
        "deviceTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"The general description or label for a device type.",
            "example":"10K mercury vapor"
        },
        "numberInstalled":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Unbadged device count"
        }
    }
}

400 Response

Bad Request

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}