Oracle Utilities REST API for Metering and Customer Information

Get Service Point Reading Details

get

/rest/apis/customer/v-model/servicePointsCommon/{servicePointId}/servicePointReadingDetails

Request

Path Parameters

servicePointId(required): string
Service Point ID is a system assigned random number that stays with a service point record.
Example:
```
5555400391
```

Query Parameters

endDate: string
Optional end date for requesting the service point usage data.
Example:
```
2024-02-20
```
limit: number
Limit determines the page size, or maximum number of results, of the search query.
Example:
```
20
```
offset: number
Offset determines the starting point of results to return for the search query.
Example:
```
0
```
startDate: string
Optional start date for requesting the service point usage data.
Example:
```
2023-01-10
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1SPReadDet

Type: object

Show Source

billedReadings: object billedReadings
endDate: string (date)

Optional end date for requesting the service point usage data.

Example: 2024-02-20
entityTimeZoneName: string

Maximum Length: 50

The description for the time zone that is displayed to customers.

Example: US/Pacific
hasMore: boolean

Has More

Example: false
limit: number

Minimum Value: 0

Maximum Value: 999999999.999999

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

Example: 20
nextScheduledReadDate: string (date)

Date of the next scheduled meter reading for the service point.

Example: 12-03-2024
offset: number

Minimum Value: 0

Maximum Value: 999999999.999999

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

Example: 0
premiseTimeZone: string

Maximum Length: 10

The Olson timezone name as defined in the Utility's installation setting that indicates when the usage occurred.

Example: USPACIFIC
servicePointId: string

Maximum Length: 10

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

Example: 5555400391
startDate: string (date)

Optional start date for requesting the service point usage data.

Example: 2023-01-10
totalNumberOfRecords: number

Minimum Value: 0

Maximum Value: 99999

The total number of records returned

Example: 3

{
    "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":"5555400391"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Optional start date for requesting the service point usage data.",
            "example":"2023-01-10"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"Optional end date for requesting the service point usage data.",
            "example":"2024-02-20"
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Limit determines the page size, or maximum number of results, of the search query.",
            "example":"20"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "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",
            "example":"3"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Has More",
            "example":"false"
        },
        "nextScheduledReadDate":{
            "type":"string",
            "format":"date",
            "description":"Date of the next scheduled meter reading for the service point.",
            "example":"12-03-2024"
        },
        "premiseTimeZone":{
            "type":"string",
            "maxLength":10,
            "description":"The Olson timezone name as defined in the Utility's installation setting that indicates when the usage occurred.",
            "example":"USPACIFIC"
        },
        "entityTimeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"The description for the time zone that is displayed to customers.",
            "example":"US/Pacific"
        },
        "billedReadings":{
            "type":"object",
            "properties":{
                "billedReadingDetails":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "billSegmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"The system-assigned unique identifier of the bill segment."
                            },
                            "readSeq":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence",
                                "example":"1"
                            },
                            "endReadDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"End Read Date/Time is the date and time of the end meter read.",
                                "example":"1998-09-30T00:00:00-04:00"
                            },
                            "endReading":{
                                "type":"number",
                                "maximum":0,
                                "minimum":0,
                                "description":"End Register Reading is the end register reading.",
                                "example":"11578.000000"
                            },
                            "quantity":{
                                "type":"number",
                                "maximum":"1000000000000",
                                "minimum":0,
                                "description":"Measured quantity since the previous reading.",
                                "example":"208.000000"
                            },
                            "usageIdentifier":{
                                "type":"string",
                                "maxLength":100,
                                "description":"An identifier for the usage value, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                                "example":"KWH-ON-"
                            },
                            "finalUom":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final Unit of Measure code of the reading.",
                                "example":"KWH"
                            },
                            "finalTou":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final Time of Use code of the reading.",
                                "example":"ON"
                            },
                            "finalSqi":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final Service Quantity Identifier for the quantity."
                            },
                            "isEstimate":{
                                "type":"boolean",
                                "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
                                "example":"true"
                            },
                            "multiplier":{
                                "type":"number",
                                "maximum":"1000000000000",
                                "minimum":"-1000000000000",
                                "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                                "example":"1.000000"
                            },
                            "readType":{
                                "type":"string",
                                "enum":[
                                    "20  ",
                                    "30  ",
                                    "35  ",
                                    "40  ",
                                    "45  ",
                                    "50  ",
                                    "60  ",
                                    "70  ",
                                    "80  "
                                ],
                                "description":"Read Type of the meter reading.\n* `20  ` - No Read,\n* `30  ` - System Estimate,\n* `35  ` - Service Provider Estimate,\n* `40  ` - Office Estimate,\n* `45  ` - System Prorate,\n* `50  ` - Customer Read,\n* `60  ` - Regular,\n* `70  ` - Verified,\n* `80  ` - Billing Force",
                                "example":"60"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SPReadDet"
    }
}

Nested Schema : billedReadings

Type: object

Show Source

billedReadingDetails: array billedReadingDetails

{
    "type":"object",
    "properties":{
        "billedReadingDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "billSegmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The system-assigned unique identifier of the bill segment."
                    },
                    "readSeq":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence",
                        "example":"1"
                    },
                    "endReadDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"End Read Date/Time is the date and time of the end meter read.",
                        "example":"1998-09-30T00:00:00-04:00"
                    },
                    "endReading":{
                        "type":"number",
                        "maximum":0,
                        "minimum":0,
                        "description":"End Register Reading is the end register reading.",
                        "example":"11578.000000"
                    },
                    "quantity":{
                        "type":"number",
                        "maximum":"1000000000000",
                        "minimum":0,
                        "description":"Measured quantity since the previous reading.",
                        "example":"208.000000"
                    },
                    "usageIdentifier":{
                        "type":"string",
                        "maxLength":100,
                        "description":"An identifier for the usage value, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                        "example":"KWH-ON-"
                    },
                    "finalUom":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final Unit of Measure code of the reading.",
                        "example":"KWH"
                    },
                    "finalTou":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final Time of Use code of the reading.",
                        "example":"ON"
                    },
                    "finalSqi":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final Service Quantity Identifier for the quantity."
                    },
                    "isEstimate":{
                        "type":"boolean",
                        "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
                        "example":"true"
                    },
                    "multiplier":{
                        "type":"number",
                        "maximum":"1000000000000",
                        "minimum":"-1000000000000",
                        "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                        "example":"1.000000"
                    },
                    "readType":{
                        "type":"string",
                        "enum":[
                            "20  ",
                            "30  ",
                            "35  ",
                            "40  ",
                            "45  ",
                            "50  ",
                            "60  ",
                            "70  ",
                            "80  "
                        ],
                        "description":"Read Type of the meter reading.\n* `20  ` - No Read,\n* `30  ` - System Estimate,\n* `35  ` - Service Provider Estimate,\n* `40  ` - Office Estimate,\n* `45  ` - System Prorate,\n* `50  ` - Customer Read,\n* `60  ` - Regular,\n* `70  ` - Verified,\n* `80  ` - Billing Force",
                        "example":"60"
                    }
                }
            }
        }
    }
}

Nested Schema : billedReadingDetails

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "billSegmentId":{
                "type":"string",
                "maxLength":12,
                "description":"The system-assigned unique identifier of the bill segment."
            },
            "readSeq":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence",
                "example":"1"
            },
            "endReadDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"End Read Date/Time is the date and time of the end meter read.",
                "example":"1998-09-30T00:00:00-04:00"
            },
            "endReading":{
                "type":"number",
                "maximum":0,
                "minimum":0,
                "description":"End Register Reading is the end register reading.",
                "example":"11578.000000"
            },
            "quantity":{
                "type":"number",
                "maximum":"1000000000000",
                "minimum":0,
                "description":"Measured quantity since the previous reading.",
                "example":"208.000000"
            },
            "usageIdentifier":{
                "type":"string",
                "maxLength":100,
                "description":"An identifier for the usage value, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                "example":"KWH-ON-"
            },
            "finalUom":{
                "type":"string",
                "maxLength":30,
                "description":"Final Unit of Measure code of the reading.",
                "example":"KWH"
            },
            "finalTou":{
                "type":"string",
                "maxLength":30,
                "description":"Final Time of Use code of the reading.",
                "example":"ON"
            },
            "finalSqi":{
                "type":"string",
                "maxLength":30,
                "description":"Final Service Quantity Identifier for the quantity."
            },
            "isEstimate":{
                "type":"boolean",
                "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
                "example":"true"
            },
            "multiplier":{
                "type":"number",
                "maximum":"1000000000000",
                "minimum":"-1000000000000",
                "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                "example":"1.000000"
            },
            "readType":{
                "type":"string",
                "enum":[
                    "20  ",
                    "30  ",
                    "35  ",
                    "40  ",
                    "45  ",
                    "50  ",
                    "60  ",
                    "70  ",
                    "80  "
                ],
                "description":"Read Type of the meter reading.\n* `20  ` - No Read,\n* `30  ` - System Estimate,\n* `35  ` - Service Provider Estimate,\n* `40  ` - Office Estimate,\n* `45  ` - System Prorate,\n* `50  ` - Customer Read,\n* `60  ` - Regular,\n* `70  ` - Verified,\n* `80  ` - Billing Force",
                "example":"60"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

billSegmentId: string

Maximum Length: 12

The system-assigned unique identifier of the bill segment.
endReadDateTime: string (date-time)

End Read Date/Time is the date and time of the end meter read.

Example: 1998-09-30T00:00:00-04:00
endReading: number

Minimum Value: 0

Maximum Value: 0

End Register Reading is the end register reading.

Example: 11578.000000
finalSqi: string

Maximum Length: 30

Final Service Quantity Identifier for the quantity.
finalTou: string

Maximum Length: 30

Final Time of Use code of the reading.

Example: ON
finalUom: string

Maximum Length: 30

Final Unit of Measure code of the reading.

Example: KWH
isEstimate: boolean

If the Estimate switch is on, consumption on this bill segment has been estimated by the system.

Example: true
multiplier: number

Minimum Value: -1000000000000

Maximum Value: 1000000000000

Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.

Example: 1.000000
quantity: number

Minimum Value: 0

Maximum Value: 1000000000000

Measured quantity since the previous reading.

Example: 208.000000
readSeq: number

Minimum Value: -99999

Maximum Value: 99999

Sequence

Example: 1
readType: string

Allowed Values: [ "20 ", "30 ", "35 ", "40 ", "45 ", "50 ", "60 ", "70 ", "80 " ]

Read Type of the meter reading. * `20 ` - No Read, * `30 ` - System Estimate, * `35 ` - Service Provider Estimate, * `40 ` - Office Estimate, * `45 ` - System Prorate, * `50 ` - Customer Read, * `60 ` - Regular, * `70 ` - Verified, * `80 ` - Billing Force

Example: 60
usageIdentifier: string

Maximum Length: 100

An identifier for the usage value, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.

Example: KWH-ON-

{
    "type":"object",
    "properties":{
        "billSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"The system-assigned unique identifier of the bill segment."
        },
        "readSeq":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence",
            "example":"1"
        },
        "endReadDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End Read Date/Time is the date and time of the end meter read.",
            "example":"1998-09-30T00:00:00-04:00"
        },
        "endReading":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"End Register Reading is the end register reading.",
            "example":"11578.000000"
        },
        "quantity":{
            "type":"number",
            "maximum":"1000000000000",
            "minimum":0,
            "description":"Measured quantity since the previous reading.",
            "example":"208.000000"
        },
        "usageIdentifier":{
            "type":"string",
            "maxLength":100,
            "description":"An identifier for the usage value, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
            "example":"KWH-ON-"
        },
        "finalUom":{
            "type":"string",
            "maxLength":30,
            "description":"Final Unit of Measure code of the reading.",
            "example":"KWH"
        },
        "finalTou":{
            "type":"string",
            "maxLength":30,
            "description":"Final Time of Use code of the reading.",
            "example":"ON"
        },
        "finalSqi":{
            "type":"string",
            "maxLength":30,
            "description":"Final Service Quantity Identifier for the quantity."
        },
        "isEstimate":{
            "type":"boolean",
            "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
            "example":"true"
        },
        "multiplier":{
            "type":"number",
            "maximum":"1000000000000",
            "minimum":"-1000000000000",
            "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
            "example":"1.000000"
        },
        "readType":{
            "type":"string",
            "enum":[
                "20  ",
                "30  ",
                "35  ",
                "40  ",
                "45  ",
                "50  ",
                "60  ",
                "70  ",
                "80  "
            ],
            "description":"Read Type of the meter reading.\n* `20  ` - No Read,\n* `30  ` - System Estimate,\n* `35  ` - Service Provider Estimate,\n* `40  ` - Office Estimate,\n* `45  ` - System Prorate,\n* `50  ` - Customer Read,\n* `60  ` - Regular,\n* `70  ` - Verified,\n* `80  ` - Billing Force",
            "example":"60"
        }
    }
}

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