Oracle Utilities REST API for Metering and Customer Information

Get Account Credit Rating History

get

/rest/apis/customer/v-model/accounts/{accountId}/creditRatingHistory

This operation retrieves the credit rating history for an account.

Request

Path Parameters

accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.
Example:
```
1589809032
```

Query Parameters

includeHistory: boolean
Include old dates records
Example:
```
true
```
limit: number
Page Limit
Example:
```
25
```
offset: number
Offset
Example:
```
0
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1CxAccCrdHs

Type: object

Show Source

_self: string

_self
account: object account
creditRatingHistory: object creditRatingHistory
currentRatingPoints: number

Minimum Value: -99999

Maximum Value: 99999

Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.

Example: 100
hasMore: boolean

Has More
limit: number

Minimum Value: 0

Maximum Value: 999999999.999999

Page Limit

Example: 25
offset: number

Minimum Value: 0

Maximum Value: 999999999.999999

Offset

Example: 0
totalNumberOfRecords: number

Minimum Value: 0

Maximum Value: 99999

Total Number Of Records

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                    "example":"1589809032"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Offset",
            "example":"0"
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Limit",
            "example":"25"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Has More"
        },
        "currentRatingPoints":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.",
            "example":"100"
        },
        "creditRatingHistory":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "creditRatingHistoryId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"The Credit Rating History contains one entry for each credit rating history record associated with the account.",
                                "example":"1589809596"
                            },
                            "user":{
                                "type":"object",
                                "properties":{
                                    "user":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"User"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "collectionProcess":{
                                "type":"object",
                                "properties":{
                                    "collectionProcessId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Collection Process ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date indicates the date on which the alert starts showing for the account.",
                                "example":"2001-01-01"
                            },
                            "severanceProcessId":{
                                "type":"object",
                                "properties":{
                                    "severanceProcessId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Severance Process ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date indicates the date on which the alert stops showing for the account.",
                                "example":"2001-01-01"
                            },
                            "affectCreditRatingBy":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.",
                                "example":"100"
                            },
                            "cashOnlyPoints":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.",
                                "example":"100"
                            },
                            "createDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Creation Date"
                            },
                            "creditRatingCreatedBy":{
                                "type":"string",
                                "enum":[
                                    "COLL",
                                    "CUTP",
                                    "MN  ",
                                    "NSF ",
                                    "ODP ",
                                    "OT  ",
                                    "PP  ",
                                    "SEV ",
                                    "WO  "
                                ],
                                "description":"The credit rating transaction includes a Created By flag that is customizable using the Lookup table.\n* `COLL` - Collection Process,\n* `CUTP` - Cut Process,\n* `MN  ` - Manual,\n* `NSF ` - NSF Assessment,\n* `ODP ` - Overdue Process,\n* `OT  ` - Other,\n* `PP  ` - Pay Plan,\n* `SEV ` - Severance Process,\n* `WO  ` - Write Off",
                                "example":"PP"
                            },
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"A sequence is used to define the order of the credit rating event records.",
                                "example":"0"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The version number is used for internal concurrency checks.",
                                "example":"2"
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Comments can describe anything interesting / unusual about the automatic payment request."
                            },
                            "payPlanId":{
                                "type":"object",
                                "properties":{
                                    "payPlanId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Pay Plan ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "writeOffProcess":{
                                "type":"object",
                                "properties":{
                                    "writeOffProcess":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Write Off Process ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1CxAccCrdHs"
    }
}

Nested Schema : account

Type: object

Show Source

_link: string

_link
accountId: string

Maximum Length: 10

The Account ID is a system-assigned random number that stays with an account for life.

Example: 1589809032

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1589809032"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : creditRatingHistory

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "creditRatingHistoryId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The Credit Rating History contains one entry for each credit rating history record associated with the account.",
                        "example":"1589809596"
                    },
                    "user":{
                        "type":"object",
                        "properties":{
                            "user":{
                                "type":"string",
                                "maxLength":8,
                                "description":"User"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "collectionProcess":{
                        "type":"object",
                        "properties":{
                            "collectionProcessId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Collection Process ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date indicates the date on which the alert starts showing for the account.",
                        "example":"2001-01-01"
                    },
                    "severanceProcessId":{
                        "type":"object",
                        "properties":{
                            "severanceProcessId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Severance Process ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date indicates the date on which the alert stops showing for the account.",
                        "example":"2001-01-01"
                    },
                    "affectCreditRatingBy":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.",
                        "example":"100"
                    },
                    "cashOnlyPoints":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.",
                        "example":"100"
                    },
                    "createDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Creation Date"
                    },
                    "creditRatingCreatedBy":{
                        "type":"string",
                        "enum":[
                            "COLL",
                            "CUTP",
                            "MN  ",
                            "NSF ",
                            "ODP ",
                            "OT  ",
                            "PP  ",
                            "SEV ",
                            "WO  "
                        ],
                        "description":"The credit rating transaction includes a Created By flag that is customizable using the Lookup table.\n* `COLL` - Collection Process,\n* `CUTP` - Cut Process,\n* `MN  ` - Manual,\n* `NSF ` - NSF Assessment,\n* `ODP ` - Overdue Process,\n* `OT  ` - Other,\n* `PP  ` - Pay Plan,\n* `SEV ` - Severance Process,\n* `WO  ` - Write Off",
                        "example":"PP"
                    },
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"A sequence is used to define the order of the credit rating event records.",
                        "example":"0"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The version number is used for internal concurrency checks.",
                        "example":"2"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Comments can describe anything interesting / unusual about the automatic payment request."
                    },
                    "payPlanId":{
                        "type":"object",
                        "properties":{
                            "payPlanId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Pay Plan ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "writeOffProcess":{
                        "type":"object",
                        "properties":{
                            "writeOffProcess":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Write Off Process ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "creditRatingHistoryId":{
                "type":"string",
                "maxLength":10,
                "description":"The Credit Rating History contains one entry for each credit rating history record associated with the account.",
                "example":"1589809596"
            },
            "user":{
                "type":"object",
                "properties":{
                    "user":{
                        "type":"string",
                        "maxLength":8,
                        "description":"User"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "collectionProcess":{
                "type":"object",
                "properties":{
                    "collectionProcessId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Collection Process ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date indicates the date on which the alert starts showing for the account.",
                "example":"2001-01-01"
            },
            "severanceProcessId":{
                "type":"object",
                "properties":{
                    "severanceProcessId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Severance Process ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date indicates the date on which the alert stops showing for the account.",
                "example":"2001-01-01"
            },
            "affectCreditRatingBy":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.",
                "example":"100"
            },
            "cashOnlyPoints":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.",
                "example":"100"
            },
            "createDate":{
                "type":"string",
                "format":"date",
                "description":"Creation Date"
            },
            "creditRatingCreatedBy":{
                "type":"string",
                "enum":[
                    "COLL",
                    "CUTP",
                    "MN  ",
                    "NSF ",
                    "ODP ",
                    "OT  ",
                    "PP  ",
                    "SEV ",
                    "WO  "
                ],
                "description":"The credit rating transaction includes a Created By flag that is customizable using the Lookup table.\n* `COLL` - Collection Process,\n* `CUTP` - Cut Process,\n* `MN  ` - Manual,\n* `NSF ` - NSF Assessment,\n* `ODP ` - Overdue Process,\n* `OT  ` - Other,\n* `PP  ` - Pay Plan,\n* `SEV ` - Severance Process,\n* `WO  ` - Write Off",
                "example":"PP"
            },
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"A sequence is used to define the order of the credit rating event records.",
                "example":"0"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The version number is used for internal concurrency checks.",
                "example":"2"
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Comments can describe anything interesting / unusual about the automatic payment request."
            },
            "payPlanId":{
                "type":"object",
                "properties":{
                    "payPlanId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Pay Plan ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "writeOffProcess":{
                "type":"object",
                "properties":{
                    "writeOffProcess":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Write Off Process ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

affectCreditRatingBy: number

Minimum Value: -99999

Maximum Value: 99999

Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.

Example: 100
cashOnlyPoints: number

Minimum Value: -99999

Maximum Value: 99999

Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.

Example: 100
collectionProcess: object collectionProcess
comments: string

Maximum Length: 254

Comments can describe anything interesting / unusual about the automatic payment request.
createDate: string (date)

Creation Date
creditRatingCreatedBy: string

Allowed Values: [ "COLL", "CUTP", "MN ", "NSF ", "ODP ", "OT ", "PP ", "SEV ", "WO " ]

The credit rating transaction includes a Created By flag that is customizable using the Lookup table. * `COLL` - Collection Process, * `CUTP` - Cut Process, * `MN ` - Manual, * `NSF ` - NSF Assessment, * `ODP ` - Overdue Process, * `OT ` - Other, * `PP ` - Pay Plan, * `SEV ` - Severance Process, * `WO ` - Write Off

Example: PP
creditRatingHistoryId: string

Maximum Length: 10

The Credit Rating History contains one entry for each credit rating history record associated with the account.

Example: 1589809596
endDate: string (date)

End Date indicates the date on which the alert stops showing for the account.

Example: 2001-01-01
eventSequence: number

Minimum Value: -999

Maximum Value: 999

A sequence is used to define the order of the credit rating event records.

Example: 0
payPlanId: object payPlanId
severanceProcessId: object severanceProcessId
startDate: string (date)

Start Date indicates the date on which the alert starts showing for the account.

Example: 2001-01-01
user: object user
version: number

Minimum Value: -99999

Maximum Value: 99999

The version number is used for internal concurrency checks.

Example: 2
writeOffProcess: object writeOffProcess

{
    "type":"object",
    "properties":{
        "creditRatingHistoryId":{
            "type":"string",
            "maxLength":10,
            "description":"The Credit Rating History contains one entry for each credit rating history record associated with the account.",
            "example":"1589809596"
        },
        "user":{
            "type":"object",
            "properties":{
                "user":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "collectionProcess":{
            "type":"object",
            "properties":{
                "collectionProcessId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Collection Process ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date indicates the date on which the alert starts showing for the account.",
            "example":"2001-01-01"
        },
        "severanceProcessId":{
            "type":"object",
            "properties":{
                "severanceProcessId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Severance Process ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date indicates the date on which the alert stops showing for the account.",
            "example":"2001-01-01"
        },
        "affectCreditRatingBy":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.",
            "example":"100"
        },
        "cashOnlyPoints":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.",
            "example":"100"
        },
        "createDate":{
            "type":"string",
            "format":"date",
            "description":"Creation Date"
        },
        "creditRatingCreatedBy":{
            "type":"string",
            "enum":[
                "COLL",
                "CUTP",
                "MN  ",
                "NSF ",
                "ODP ",
                "OT  ",
                "PP  ",
                "SEV ",
                "WO  "
            ],
            "description":"The credit rating transaction includes a Created By flag that is customizable using the Lookup table.\n* `COLL` - Collection Process,\n* `CUTP` - Cut Process,\n* `MN  ` - Manual,\n* `NSF ` - NSF Assessment,\n* `ODP ` - Overdue Process,\n* `OT  ` - Other,\n* `PP  ` - Pay Plan,\n* `SEV ` - Severance Process,\n* `WO  ` - Write Off",
            "example":"PP"
        },
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"A sequence is used to define the order of the credit rating event records.",
            "example":"0"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The version number is used for internal concurrency checks.",
            "example":"2"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments can describe anything interesting / unusual about the automatic payment request."
        },
        "payPlanId":{
            "type":"object",
            "properties":{
                "payPlanId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Pay Plan ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "writeOffProcess":{
            "type":"object",
            "properties":{
                "writeOffProcess":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Write Off Process ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        }
    }
}

Nested Schema : collectionProcess

Type: object

Show Source

_link: string

_link
collectionProcessId: string

Maximum Length: 10

Collection Process ID

{
    "type":"object",
    "properties":{
        "collectionProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Collection Process ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : payPlanId

Type: object

Show Source

_link: string

_link
payPlanId: string

Maximum Length: 10

Pay Plan ID

{
    "type":"object",
    "properties":{
        "payPlanId":{
            "type":"string",
            "maxLength":10,
            "description":"Pay Plan ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : severanceProcessId

Type: object

Show Source

_link: string

_link
severanceProcessId: string

Maximum Length: 10

Severance Process ID

{
    "type":"object",
    "properties":{
        "severanceProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Severance Process ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : user

Type: object

Show Source

_link: string

_link
user: string

Maximum Length: 8

User

{
    "type":"object",
    "properties":{
        "user":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : writeOffProcess

Type: object

Show Source

_link: string

_link
writeOffProcess: string

Maximum Length: 10

Write Off Process ID

{
    "type":"object",
    "properties":{
        "writeOffProcess":{
            "type":"string",
            "maxLength":10,
            "description":"Write Off Process ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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