Jump to

• Request
• Response

Multi-Account Billing Statistics

post

/rest/apis/customer/financials/accountData/multiAccountStatistics

This operation accepts an input list of up to 20 accounts and provides summary calculations of total billing charges by service type.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accountList: array accountList
• endDate: string (date)
  End Date

  Example: 2001-08-01
• startDate: string (date)
  Start Date

  Example: 2001-01-01

{
    "type":"object",
    "properties":{
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date",
            "example":"2001-01-01"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date",
            "example":"2001-08-01"
        },
        "accountList":{
            "type":"array",
            "items":{
                "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":"1589800000"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1MAcBilStat"
    }
}

Nested Schema : accountList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "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":"1589800000"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

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

  Example: 1589800000

{
    "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":"1589800000"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountList: array accountList
• endDate: string (date)
  End Date

  Example: 2001-08-01
• startDate: string (date)
  Start Date

  Example: 2001-01-01

{
    "type":"object",
    "properties":{
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date",
            "example":"2001-01-01"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date",
            "example":"2001-08-01"
        },
        "accountList":{
            "type":"array",
            "items":{
                "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":"1589800000"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1MAcBilStat"
    }
}

Nested Schema : accountList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "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":"1589800000"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

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

  Example: 1589800000

{
    "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":"1589800000"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1MAcBilStat

Type: object

Show Source

• accounts: object accounts

{
    "type":"object",
    "properties":{
        "accounts":{
            "type":"object",
            "properties":{
                "accountBilling":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "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":"1589800000"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "currency":{
                                "type":"object",
                                "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                                "properties":{
                                    "currency":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                                        "example":"USD"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "earliestBillDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Earliest of the bill dates",
                                "example":"2001-01-01"
                            },
                            "latestBillDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Latest of the bill dates",
                                "example":"2001-07-01"
                            },
                            "currentBalance":{
                                "type":"number",
                                "description":"The current amount owed by the customer on the billing account (calculated value)",
                                "example":"-252.2"
                            },
                            "totalBalance":{
                                "type":"number",
                                "description":"The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)",
                                "example":"361.64"
                            },
                            "totalBilledAmount":{
                                "type":"number",
                                "description":"Total Billed Amount",
                                "example":"1562.02"
                            },
                            "serviceTypeAmounts":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "serviceType":{
                                            "type":"object",
                                            "description":"Service Type defines the type of service associated with the SA type.",
                                            "properties":{
                                                "serviceType":{
                                                    "type":"string",
                                                    "maxLength":80,
                                                    "description":"Service Type defines the type of service associated with the SA type."
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "totalBilledAmount":{
                                            "type":"number",
                                            "description":"Total Billed Amount",
                                            "example":"1562.02"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1MAcBilStat"
    }
}

Nested Schema : accounts

Type: object

Show Source

• accountBilling: array accountBilling

{
    "type":"object",
    "properties":{
        "accountBilling":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "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":"1589800000"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "currency":{
                        "type":"object",
                        "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                        "properties":{
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                                "example":"USD"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "earliestBillDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Earliest of the bill dates",
                        "example":"2001-01-01"
                    },
                    "latestBillDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Latest of the bill dates",
                        "example":"2001-07-01"
                    },
                    "currentBalance":{
                        "type":"number",
                        "description":"The current amount owed by the customer on the billing account (calculated value)",
                        "example":"-252.2"
                    },
                    "totalBalance":{
                        "type":"number",
                        "description":"The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)",
                        "example":"361.64"
                    },
                    "totalBilledAmount":{
                        "type":"number",
                        "description":"Total Billed Amount",
                        "example":"1562.02"
                    },
                    "serviceTypeAmounts":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceType":{
                                    "type":"object",
                                    "description":"Service Type defines the type of service associated with the SA type.",
                                    "properties":{
                                        "serviceType":{
                                            "type":"string",
                                            "maxLength":80,
                                            "description":"Service Type defines the type of service associated with the SA type."
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "totalBilledAmount":{
                                    "type":"number",
                                    "description":"Total Billed Amount",
                                    "example":"1562.02"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : accountBilling

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "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":"1589800000"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "currency":{
                "type":"object",
                "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                "properties":{
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                        "example":"USD"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "earliestBillDate":{
                "type":"string",
                "format":"date",
                "description":"Earliest of the bill dates",
                "example":"2001-01-01"
            },
            "latestBillDate":{
                "type":"string",
                "format":"date",
                "description":"Latest of the bill dates",
                "example":"2001-07-01"
            },
            "currentBalance":{
                "type":"number",
                "description":"The current amount owed by the customer on the billing account (calculated value)",
                "example":"-252.2"
            },
            "totalBalance":{
                "type":"number",
                "description":"The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)",
                "example":"361.64"
            },
            "totalBilledAmount":{
                "type":"number",
                "description":"Total Billed Amount",
                "example":"1562.02"
            },
            "serviceTypeAmounts":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "serviceType":{
                            "type":"object",
                            "description":"Service Type defines the type of service associated with the SA type.",
                            "properties":{
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":80,
                                    "description":"Service Type defines the type of service associated with the SA type."
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        },
                        "totalBilledAmount":{
                            "type":"number",
                            "description":"Total Billed Amount",
                            "example":"1562.02"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• account: object account
• currency: object currency
  Currency Code defines the currency in which the account's financial transactions are expressed.
• currentBalance: number
  The current amount owed by the customer on the billing account (calculated value)

  Example: -252.2
• earliestBillDate: string (date)
  Earliest of the bill dates

  Example: 2001-01-01
• latestBillDate: string (date)
  Latest of the bill dates

  Example: 2001-07-01
• serviceTypeAmounts: array serviceTypeAmounts
• totalBalance: number
  The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)

  Example: 361.64
• totalBilledAmount: number
  Total Billed Amount

  Example: 1562.02

{
    "type":"object",
    "properties":{
        "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":"1589800000"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "currency":{
            "type":"object",
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                    "example":"USD"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "earliestBillDate":{
            "type":"string",
            "format":"date",
            "description":"Earliest of the bill dates",
            "example":"2001-01-01"
        },
        "latestBillDate":{
            "type":"string",
            "format":"date",
            "description":"Latest of the bill dates",
            "example":"2001-07-01"
        },
        "currentBalance":{
            "type":"number",
            "description":"The current amount owed by the customer on the billing account (calculated value)",
            "example":"-252.2"
        },
        "totalBalance":{
            "type":"number",
            "description":"The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)",
            "example":"361.64"
        },
        "totalBilledAmount":{
            "type":"number",
            "description":"Total Billed Amount",
            "example":"1562.02"
        },
        "serviceTypeAmounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"object",
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "properties":{
                            "serviceType":{
                                "type":"string",
                                "maxLength":80,
                                "description":"Service Type defines the type of service associated with the SA type."
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "totalBilledAmount":{
                        "type":"number",
                        "description":"Total Billed Amount",
                        "example":"1562.02"
                    }
                }
            }
        }
    }
}

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: 1589800000

{
    "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":"1589800000"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : currency

Type: object

Currency Code defines the currency in which the account's financial transactions are expressed.

Show Source

• _link: string
  _link
• currency: string
  Maximum Length: 3

  Currency Code defines the currency in which the account's financial transactions are expressed.

  Example: USD

{
    "type":"object",
    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
    "properties":{
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "example":"USD"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceTypeAmounts

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"object",
                "description":"Service Type defines the type of service associated with the SA type.",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type."
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "totalBilledAmount":{
                "type":"number",
                "description":"Total Billed Amount",
                "example":"1562.02"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• serviceType: object serviceType
  Service Type defines the type of service associated with the SA type.
• totalBilledAmount: number
  Total Billed Amount

  Example: 1562.02

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"object",
            "description":"Service Type defines the type of service associated with the SA type.",
            "properties":{
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the SA type."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "totalBilledAmount":{
            "type":"number",
            "description":"Total Billed Amount",
            "example":"1562.02"
        }
    }
}

Nested Schema : serviceType

Type: object

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

Show Source

• _link: string
  _link
• serviceType: string
  Maximum Length: 80

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

{
    "type":"object",
    "description":"Service Type defines the type of service associated with the SA type.",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

400 Response

Bad Request

Body ()

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

Body ()

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

Back to Top