Oracle Utilities REST API for Metering and Customer Information

Get Billing Account Context

get

/spl/rest/apis/customer/v-model/billingContext/accountContext/{accountId}

Request

Path Parameters

accountId(required): string

Query Parameters

premiseId: string

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1BlAccCtxt

Type: object

Show Source

account: object account
accountInformation: object accountInformation
accountPersons: object accountPersons
customerClass: object customerClass
division: object division
premiseCount: number

Minimum Value: 0

Maximum Value: 99999

The count of premises defined for an account

Example: 2
premiseInformation: object premiseInformation

{
    "type":"object",
    "properties":{
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID identifies the customer who is responsible for the bill.",
                    "example":"0119532152"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "customerClass":{
            "type":"object",
            "properties":{
                "customerClass":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Customer Class controls financial parameters related to billing and collections and is required on an account.",
                    "example":"R"
                },
                "description":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                }
            }
        },
        "division":{
            "type":"object",
            "properties":{
                "division":{
                    "type":"string",
                    "maxLength":5,
                    "description":"CIS Division"
                },
                "description":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                }
            }
        },
        "accountInformation":{
            "type":"object",
            "properties":{
                "info":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Account Info displays information associated with an Account.",
                    "example":"Brazil,Mark, Residential, $19,247.81"
                },
                "primaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Primary text for Person Information"
                },
                "secondaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Secondary text for Person Information"
                },
                "tertiaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Tertiary text for Person Information"
                },
                "accountName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Name"
                }
            }
        },
        "premiseInformation":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                    "example":"3836403369"
                },
                "info":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Premise Information",
                    "example":"129 Sutter St, San Francisco, CA, 94104"
                },
                "primaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Primary text for Person Information"
                },
                "secondaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Secondary text for Person Information"
                },
                "tertiaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Tertiary text for Person Information"
                }
            }
        },
        "premiseCount":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"The count of premises defined for an account",
            "example":"2"
        },
        "accountPersons":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "person":{
                                "type":"object",
                                "properties":{
                                    "personId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Person ID is the system-assigned number for other persons related to the account."
                                    }
                                }
                            },
                            "personInformation":{
                                "type":"object",
                                "properties":{
                                    "info":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Person Info"
                                    },
                                    "primaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Primary text for Person Information"
                                    },
                                    "secondaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Secondary text for Person Information"
                                    },
                                    "tertiaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Tertiary text for Person Information"
                                    },
                                    "personOrBusiness":{
                                        "type":"string",
                                        "enum":[
                                            "B   ",
                                            "P   "
                                        ],
                                        "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                                        "example":"P"
                                    }
                                }
                            },
                            "primaryName":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Name"
                            },
                            "accountRelationshipType":{
                                "type":"object",
                                "properties":{
                                    "accountRelationshipType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Account Relationship Type"
                                    },
                                    "description":{
                                        "type":"string",
                                        "maxLength":60,
                                        "description":"Description"
                                    }
                                }
                            },
                            "isMainCustomer":{
                                "type":"boolean",
                                "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                                "example":"false"
                            },
                            "isFinanciallyResponsible":{
                                "type":"boolean",
                                "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                                "example":"true"
                            },
                            "receivesCopyOfBill":{
                                "type":"boolean",
                                "description":"Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.",
                                "example":"true"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1BlAccCtxt"
    }
}

Nested Schema : account

Type: object

Show Source

_link: string

_link
accountId: string

Maximum Length: 10

Account ID identifies the customer who is responsible for the bill.

Example: 0119532152

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"0119532152"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : accountInformation

Type: object

Show Source

accountName: string

Maximum Length: 254

Name
info: string

Maximum Length: 254

Account Info displays information associated with an Account.

Example: Brazil,Mark, Residential, $19,247.81
primaryText: string

Maximum Length: 1000

Primary text for Person Information
secondaryText: string

Maximum Length: 1000

Secondary text for Person Information
tertiaryText: string

Maximum Length: 1000

Tertiary text for Person Information

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "maxLength":254,
            "description":"Account Info displays information associated with an Account.",
            "example":"Brazil,Mark, Residential, $19,247.81"
        },
        "primaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Primary text for Person Information"
        },
        "secondaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Secondary text for Person Information"
        },
        "tertiaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Tertiary text for Person Information"
        },
        "accountName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        }
    }
}

Nested Schema : accountPersons

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "person":{
                        "type":"object",
                        "properties":{
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person ID is the system-assigned number for other persons related to the account."
                            }
                        }
                    },
                    "personInformation":{
                        "type":"object",
                        "properties":{
                            "info":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Person Info"
                            },
                            "primaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Primary text for Person Information"
                            },
                            "secondaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Secondary text for Person Information"
                            },
                            "tertiaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Tertiary text for Person Information"
                            },
                            "personOrBusiness":{
                                "type":"string",
                                "enum":[
                                    "B   ",
                                    "P   "
                                ],
                                "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                                "example":"P"
                            }
                        }
                    },
                    "primaryName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Name"
                    },
                    "accountRelationshipType":{
                        "type":"object",
                        "properties":{
                            "accountRelationshipType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Account Relationship Type"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            }
                        }
                    },
                    "isMainCustomer":{
                        "type":"boolean",
                        "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                        "example":"false"
                    },
                    "isFinanciallyResponsible":{
                        "type":"boolean",
                        "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                        "example":"true"
                    },
                    "receivesCopyOfBill":{
                        "type":"boolean",
                        "description":"Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.",
                        "example":"true"
                    }
                }
            }
        }
    }
}

Nested Schema : customerClass

Type: object

Show Source

customerClass: string

Maximum Length: 8

Customer Class controls financial parameters related to billing and collections and is required on an account.

Example: R
description: string

Maximum Length: 60

Description

{
    "type":"object",
    "properties":{
        "customerClass":{
            "type":"string",
            "maxLength":8,
            "description":"Customer Class controls financial parameters related to billing and collections and is required on an account.",
            "example":"R"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        }
    }
}

Nested Schema : division

Type: object

Show Source

description: string

Maximum Length: 60

Description
division: string

Maximum Length: 5

CIS Division

{
    "type":"object",
    "properties":{
        "division":{
            "type":"string",
            "maxLength":5,
            "description":"CIS Division"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        }
    }
}

Nested Schema : premiseInformation

Type: object

Show Source

info: string

Maximum Length: 254

Premise Information

Example: 129 Sutter St, San Francisco, CA, 94104
premiseId: string

Maximum Length: 10

Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

Example: 3836403369
primaryText: string

Maximum Length: 1000

Primary text for Person Information
secondaryText: string

Maximum Length: 1000

Secondary text for Person Information
tertiaryText: string

Maximum Length: 1000

Tertiary text for Person Information

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"3836403369"
        },
        "info":{
            "type":"string",
            "maxLength":254,
            "description":"Premise Information",
            "example":"129 Sutter St, San Francisco, CA, 94104"
        },
        "primaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Primary text for Person Information"
        },
        "secondaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Secondary text for Person Information"
        },
        "tertiaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Tertiary text for Person Information"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "person":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is the system-assigned number for other persons related to the account."
                    }
                }
            },
            "personInformation":{
                "type":"object",
                "properties":{
                    "info":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Person Info"
                    },
                    "primaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Primary text for Person Information"
                    },
                    "secondaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Secondary text for Person Information"
                    },
                    "tertiaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Tertiary text for Person Information"
                    },
                    "personOrBusiness":{
                        "type":"string",
                        "enum":[
                            "B   ",
                            "P   "
                        ],
                        "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                        "example":"P"
                    }
                }
            },
            "primaryName":{
                "type":"string",
                "maxLength":254,
                "description":"Name"
            },
            "accountRelationshipType":{
                "type":"object",
                "properties":{
                    "accountRelationshipType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Account Relationship Type"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    }
                }
            },
            "isMainCustomer":{
                "type":"boolean",
                "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                "example":"false"
            },
            "isFinanciallyResponsible":{
                "type":"boolean",
                "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                "example":"true"
            },
            "receivesCopyOfBill":{
                "type":"boolean",
                "description":"Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.",
                "example":"true"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

accountRelationshipType: object accountRelationshipType
isFinanciallyResponsible: boolean

Financially Responsible switch is on if the person is financially responsible for the account's debt.

Example: true
isMainCustomer: boolean

Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.

Example: false
person: object person
personInformation: object personInformation
primaryName: string

Maximum Length: 254

Name
receivesCopyOfBill: boolean

Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.

Example: true

{
    "type":"object",
    "properties":{
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID is the system-assigned number for other persons related to the account."
                }
            }
        },
        "personInformation":{
            "type":"object",
            "properties":{
                "info":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Person Info"
                },
                "primaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Primary text for Person Information"
                },
                "secondaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Secondary text for Person Information"
                },
                "tertiaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Tertiary text for Person Information"
                },
                "personOrBusiness":{
                    "type":"string",
                    "enum":[
                        "B   ",
                        "P   "
                    ],
                    "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                    "example":"P"
                }
            }
        },
        "primaryName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        },
        "accountRelationshipType":{
            "type":"object",
            "properties":{
                "accountRelationshipType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Account Relationship Type"
                },
                "description":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                }
            }
        },
        "isMainCustomer":{
            "type":"boolean",
            "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
            "example":"false"
        },
        "isFinanciallyResponsible":{
            "type":"boolean",
            "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
            "example":"true"
        },
        "receivesCopyOfBill":{
            "type":"boolean",
            "description":"Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.",
            "example":"true"
        }
    }
}

Nested Schema : accountRelationshipType

Type: object

Show Source

accountRelationshipType: string

Maximum Length: 8

Account Relationship Type
description: string

Maximum Length: 60

Description

{
    "type":"object",
    "properties":{
        "accountRelationshipType":{
            "type":"string",
            "maxLength":8,
            "description":"Account Relationship Type"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        }
    }
}

Nested Schema : person

Type: object

Show Source

personId: string

Maximum Length: 10

Person ID is the system-assigned number for other persons related to the account.

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is the system-assigned number for other persons related to the account."
        }
    }
}

Nested Schema : personInformation

Type: object

Show Source

info: string

Maximum Length: 254

Person Info
personOrBusiness: string

Allowed Values: [ "B ", "P " ]

Defines the person entity as a person or business, which controls validation of the person entity's primary name. * `B ` - Business, * `P ` - Person

Example: P
primaryText: string

Maximum Length: 1000

Primary text for Person Information
secondaryText: string

Maximum Length: 1000

Secondary text for Person Information
tertiaryText: string

Maximum Length: 1000

Tertiary text for Person Information

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "maxLength":254,
            "description":"Person Info"
        },
        "primaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Primary text for Person Information"
        },
        "secondaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Secondary text for Person Information"
        },
        "tertiaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Tertiary text for Person Information"
        },
        "personOrBusiness":{
            "type":"string",
            "enum":[
                "B   ",
                "P   "
            ],
            "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
            "example":"P"
        }
    }
}

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