Oracle Utilities REST API for Metering and Customer Information

Search SP for Premise

post

https://server:port/spl/rest/apis/cross/v-model/servicePoints/summary

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

limit: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

Page Limit

Example: 15
offset: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

Page Offset

Example: 25
premiseId: string

Maximum Length: 10

The Premise ID is a system assigned random number that stays with a premise for life.

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"The Premise ID is a system assigned random number that stays with a premise for life."
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Limit",
            "example":"15"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Offset",
            "example":"25"
        }
    },
    "xml":{
        "name":"X1GtPremAcc"
    }
}

Root Schema : schema

Type: object

Show Source

limit: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

Page Limit

Example: 15
offset: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

Page Offset

Example: 25
premiseId: string

Maximum Length: 10

The Premise ID is a system assigned random number that stays with a premise for life.

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"The Premise ID is a system assigned random number that stays with a premise for life."
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Limit",
            "example":"15"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Offset",
            "example":"25"
        }
    },
    "xml":{
        "name":"X1GtPremAcc"
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : X1GtPremAcc

Type: object

Show Source

limit: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

Page Limit

Example: 15
offset: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

Page Offset

Example: 25
servicePointList: array servicePointList
totalNumberOfRecords: number

Minimum Value: 0

Maximum Value: 99999

Total Number Of Records

Example: 67

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Limit",
            "example":"15"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Offset",
            "example":"25"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records",
            "example":"67"
        },
        "servicePointList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                        "example":"3996166619"
                    },
                    "servicePointType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Point Type indicates the category of the device location where the service is delivered.",
                        "example":"ZZ_ERT_ITM_SP_TYPE_01"
                    },
                    "servicePointTypeDescription":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Description for Service Point Type",
                        "example":"ERT ITEM SP Type 01"
                    },
                    "timeZone":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Timezone",
                        "example":"USPACIFIC"
                    },
                    "timeZoneName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Timezone Name",
                        "example":"US/Pacific"
                    },
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "example":"E"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description for Service Type",
                        "example":"Electric"
                    },
                    "deviceId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Device ID indicates the unique system identifier of additional equipment installed at the service point.",
                        "example":"832023898296"
                    },
                    "deviceType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                        "example":"ZZ_DVCTYP_7529"
                    },
                    "deviceTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description for Device Type",
                        "example":"00ZZ_DVCTYP_7529"
                    },
                    "serialNumber":{
                        "type":"string",
                        "maxLength":120,
                        "description":"The device identifier for the Serial Number.",
                        "example":"BN20_YC_7529"
                    },
                    "badgeNumber":{
                        "type":"string",
                        "maxLength":120,
                        "description":"The Badge Number is the identifier stamped on the meter. This is not the manufacturer's serial number.",
                        "example":"BN20_YC_7529"
                    },
                    "manufacturer":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Manufacturer is the meter device manufacturer.",
                        "example":"ZZ_MANUFACTURER_7529"
                    },
                    "model":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Model",
                        "example":"E"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1GtPremAcc"
    }
}

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 stays with a service point record.",
                "example":"3996166619"
            },
            "servicePointType":{
                "type":"string",
                "maxLength":30,
                "description":"Service Point Type indicates the category of the device location where the service is delivered.",
                "example":"ZZ_ERT_ITM_SP_TYPE_01"
            },
            "servicePointTypeDescription":{
                "type":"string",
                "maxLength":50,
                "description":"Description for Service Point Type",
                "example":"ERT ITEM SP Type 01"
            },
            "timeZone":{
                "type":"string",
                "maxLength":10,
                "description":"Timezone",
                "example":"USPACIFIC"
            },
            "timeZoneName":{
                "type":"string",
                "maxLength":50,
                "description":"Timezone Name",
                "example":"US/Pacific"
            },
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type defines the type of service associated with the SA type.",
                "example":"E"
            },
            "serviceTypeDescription":{
                "type":"string",
                "maxLength":100,
                "description":"Description for Service Type",
                "example":"Electric"
            },
            "deviceId":{
                "type":"string",
                "maxLength":12,
                "description":"Device ID indicates the unique system identifier of additional equipment installed at the service point.",
                "example":"832023898296"
            },
            "deviceType":{
                "type":"string",
                "maxLength":30,
                "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                "example":"ZZ_DVCTYP_7529"
            },
            "deviceTypeDescription":{
                "type":"string",
                "maxLength":100,
                "description":"Description for Device Type",
                "example":"00ZZ_DVCTYP_7529"
            },
            "serialNumber":{
                "type":"string",
                "maxLength":120,
                "description":"The device identifier for the Serial Number.",
                "example":"BN20_YC_7529"
            },
            "badgeNumber":{
                "type":"string",
                "maxLength":120,
                "description":"The Badge Number is the identifier stamped on the meter. This is not the manufacturer's serial number.",
                "example":"BN20_YC_7529"
            },
            "manufacturer":{
                "type":"string",
                "maxLength":30,
                "description":"Manufacturer is the meter device manufacturer.",
                "example":"ZZ_MANUFACTURER_7529"
            },
            "model":{
                "type":"string",
                "maxLength":30,
                "description":"Model",
                "example":"E"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

badgeNumber: string

Maximum Length: 120

The Badge Number is the identifier stamped on the meter. This is not the manufacturer's serial number.

Example: BN20_YC_7529
deviceId: string

Maximum Length: 12

Device ID indicates the unique system identifier of additional equipment installed at the service point.

Example: 832023898296
deviceType: string

Maximum Length: 30

Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.

Example: ZZ_DVCTYP_7529
deviceTypeDescription: string

Maximum Length: 100

Description for Device Type

Example: 00ZZ_DVCTYP_7529
manufacturer: string

Maximum Length: 30

Manufacturer is the meter device manufacturer.

Example: ZZ_MANUFACTURER_7529
model: string

Maximum Length: 30

Model

Example: E
serialNumber: string

Maximum Length: 120

The device identifier for the Serial Number.

Example: BN20_YC_7529
servicePointId: string

Maximum Length: 10

Service Point ID is a system assigned random number that stays with a service point record.

Example: 3996166619
servicePointType: string

Maximum Length: 30

Service Point Type indicates the category of the device location where the service is delivered.

Example: ZZ_ERT_ITM_SP_TYPE_01
servicePointTypeDescription: string

Maximum Length: 50

Description for Service Point Type

Example: ERT ITEM SP Type 01
serviceType: string

Maximum Length: 80

Service Type defines the type of service associated with the SA type.

Example: E
serviceTypeDescription: string

Maximum Length: 100

Description for Service Type

Example: Electric
timeZone: string

Maximum Length: 10

Timezone

Example: USPACIFIC
timeZoneName: string

Maximum Length: 50

Timezone Name

Example: US/Pacific

{
    "type":"object",
    "properties":{
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
            "example":"3996166619"
        },
        "servicePointType":{
            "type":"string",
            "maxLength":30,
            "description":"Service Point Type indicates the category of the device location where the service is delivered.",
            "example":"ZZ_ERT_ITM_SP_TYPE_01"
        },
        "servicePointTypeDescription":{
            "type":"string",
            "maxLength":50,
            "description":"Description for Service Point Type",
            "example":"ERT ITEM SP Type 01"
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Timezone",
            "example":"USPACIFIC"
        },
        "timeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"Timezone Name",
            "example":"US/Pacific"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Description for Service Type",
            "example":"Electric"
        },
        "deviceId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID indicates the unique system identifier of additional equipment installed at the service point.",
            "example":"832023898296"
        },
        "deviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
            "example":"ZZ_DVCTYP_7529"
        },
        "deviceTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Description for Device Type",
            "example":"00ZZ_DVCTYP_7529"
        },
        "serialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Serial Number.",
            "example":"BN20_YC_7529"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The Badge Number is the identifier stamped on the meter. This is not the manufacturer's serial number.",
            "example":"BN20_YC_7529"
        },
        "manufacturer":{
            "type":"string",
            "maxLength":30,
            "description":"Manufacturer is the meter device manufacturer.",
            "example":"ZZ_MANUFACTURER_7529"
        },
        "model":{
            "type":"string",
            "maxLength":30,
            "description":"Model",
            "example":"E"
        }
    }
}

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."
        }
    }
}