Jump to

• Request
• Response

Get Premise Statistics

post

/rest/apis/customer/v-model/premises/premiseStatistics

This operation returns statistics for services billed for a premise.

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

• endDate: string (date)
  End date of requested premise statistics, by default will be the current date.

  Example: 2023-12-28
• premiseId: string
  Maximum Length: 10

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

  Example: 2242620736
• serviceTypes: array serviceTypes
• startDate: string (date)
  Start date of requested premise statistics, by default will be for last 1 year.

  Example: 2022-12-28

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"The Premise ID is a system assigned random number that stays with a premise for life.",
            "example":"2242620736"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start date of requested premise statistics, by default will be for last 1 year.",
            "example":"2022-12-28"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End date of requested premise statistics, by default will be the current date.",
            "example":"2023-12-28"
        },
        "serviceTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type",
                        "example":"E"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Service type",
                        "example":"Electric Service"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Currency of financial values in premise statistics",
                        "example":"USD"
                    },
                    "totalBilledAmount":{
                        "type":"number",
                        "description":"Total amount billed during the requested period",
                        "example":"2880.61"
                    },
                    "averageCostPerMonth":{
                        "type":"number",
                        "description":"Average bill segment amount for the service type during the statistics period",
                        "example":"261.87"
                    },
                    "numberMonthsBilled":{
                        "type":"number",
                        "maximum":"9999999999999.99",
                        "minimum":0,
                        "description":"Number of months billed during the requested period.",
                        "example":"11"
                    },
                    "multiPremiseBilling":{
                        "type":"boolean",
                        "description":"Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.",
                        "example":"false"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PremStats"
    }
}

Nested Schema : serviceTypes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type defines the type of service associated with the SA type",
                "example":"E"
            },
            "serviceTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Service type",
                "example":"Electric Service"
            },
            "currency":{
                "type":"string",
                "maxLength":60,
                "description":"Currency of financial values in premise statistics",
                "example":"USD"
            },
            "totalBilledAmount":{
                "type":"number",
                "description":"Total amount billed during the requested period",
                "example":"2880.61"
            },
            "averageCostPerMonth":{
                "type":"number",
                "description":"Average bill segment amount for the service type during the statistics period",
                "example":"261.87"
            },
            "numberMonthsBilled":{
                "type":"number",
                "maximum":"9999999999999.99",
                "minimum":0,
                "description":"Number of months billed during the requested period.",
                "example":"11"
            },
            "multiPremiseBilling":{
                "type":"boolean",
                "description":"Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.",
                "example":"false"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• averageCostPerMonth: number
  Average bill segment amount for the service type during the statistics period

  Example: 261.87
• currency: string
  Maximum Length: 60

  Currency of financial values in premise statistics

  Example: USD
• multiPremiseBilling: boolean
  Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.

  Example: false
• numberMonthsBilled: number
  Minimum Value: 0

  Maximum Value: 9999999999999.99

  Number of months billed during the requested period.

  Example: 11
• serviceType: string
  Maximum Length: 80

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

  Example: E
• serviceTypeDescription: string
  Maximum Length: 60

  Service type

  Example: Electric Service
• totalBilledAmount: number
  Total amount billed during the requested period

  Example: 2880.61

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type",
            "example":"E"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Service type",
            "example":"Electric Service"
        },
        "currency":{
            "type":"string",
            "maxLength":60,
            "description":"Currency of financial values in premise statistics",
            "example":"USD"
        },
        "totalBilledAmount":{
            "type":"number",
            "description":"Total amount billed during the requested period",
            "example":"2880.61"
        },
        "averageCostPerMonth":{
            "type":"number",
            "description":"Average bill segment amount for the service type during the statistics period",
            "example":"261.87"
        },
        "numberMonthsBilled":{
            "type":"number",
            "maximum":"9999999999999.99",
            "minimum":0,
            "description":"Number of months billed during the requested period.",
            "example":"11"
        },
        "multiPremiseBilling":{
            "type":"boolean",
            "description":"Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.",
            "example":"false"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• endDate: string (date)
  End date of requested premise statistics, by default will be the current date.

  Example: 2023-12-28
• premiseId: string
  Maximum Length: 10

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

  Example: 2242620736
• serviceTypes: array serviceTypes
• startDate: string (date)
  Start date of requested premise statistics, by default will be for last 1 year.

  Example: 2022-12-28

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"The Premise ID is a system assigned random number that stays with a premise for life.",
            "example":"2242620736"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start date of requested premise statistics, by default will be for last 1 year.",
            "example":"2022-12-28"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End date of requested premise statistics, by default will be the current date.",
            "example":"2023-12-28"
        },
        "serviceTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type",
                        "example":"E"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Service type",
                        "example":"Electric Service"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Currency of financial values in premise statistics",
                        "example":"USD"
                    },
                    "totalBilledAmount":{
                        "type":"number",
                        "description":"Total amount billed during the requested period",
                        "example":"2880.61"
                    },
                    "averageCostPerMonth":{
                        "type":"number",
                        "description":"Average bill segment amount for the service type during the statistics period",
                        "example":"261.87"
                    },
                    "numberMonthsBilled":{
                        "type":"number",
                        "maximum":"9999999999999.99",
                        "minimum":0,
                        "description":"Number of months billed during the requested period.",
                        "example":"11"
                    },
                    "multiPremiseBilling":{
                        "type":"boolean",
                        "description":"Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.",
                        "example":"false"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PremStats"
    }
}

Nested Schema : serviceTypes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type defines the type of service associated with the SA type",
                "example":"E"
            },
            "serviceTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Service type",
                "example":"Electric Service"
            },
            "currency":{
                "type":"string",
                "maxLength":60,
                "description":"Currency of financial values in premise statistics",
                "example":"USD"
            },
            "totalBilledAmount":{
                "type":"number",
                "description":"Total amount billed during the requested period",
                "example":"2880.61"
            },
            "averageCostPerMonth":{
                "type":"number",
                "description":"Average bill segment amount for the service type during the statistics period",
                "example":"261.87"
            },
            "numberMonthsBilled":{
                "type":"number",
                "maximum":"9999999999999.99",
                "minimum":0,
                "description":"Number of months billed during the requested period.",
                "example":"11"
            },
            "multiPremiseBilling":{
                "type":"boolean",
                "description":"Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.",
                "example":"false"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• averageCostPerMonth: number
  Average bill segment amount for the service type during the statistics period

  Example: 261.87
• currency: string
  Maximum Length: 60

  Currency of financial values in premise statistics

  Example: USD
• multiPremiseBilling: boolean
  Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.

  Example: false
• numberMonthsBilled: number
  Minimum Value: 0

  Maximum Value: 9999999999999.99

  Number of months billed during the requested period.

  Example: 11
• serviceType: string
  Maximum Length: 80

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

  Example: E
• serviceTypeDescription: string
  Maximum Length: 60

  Service type

  Example: Electric Service
• totalBilledAmount: number
  Total amount billed during the requested period

  Example: 2880.61

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type",
            "example":"E"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Service type",
            "example":"Electric Service"
        },
        "currency":{
            "type":"string",
            "maxLength":60,
            "description":"Currency of financial values in premise statistics",
            "example":"USD"
        },
        "totalBilledAmount":{
            "type":"number",
            "description":"Total amount billed during the requested period",
            "example":"2880.61"
        },
        "averageCostPerMonth":{
            "type":"number",
            "description":"Average bill segment amount for the service type during the statistics period",
            "example":"261.87"
        },
        "numberMonthsBilled":{
            "type":"number",
            "maximum":"9999999999999.99",
            "minimum":0,
            "description":"Number of months billed during the requested period.",
            "example":"11"
        },
        "multiPremiseBilling":{
            "type":"boolean",
            "description":"Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.",
            "example":"false"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1PremStats

Type: object

Show Source

• serviceTypes: array serviceTypes

{
    "type":"object",
    "properties":{
        "serviceTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type",
                        "example":"E"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Service type",
                        "example":"Electric Service"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Currency of financial values in premise statistics",
                        "example":"USD"
                    },
                    "totalBilledAmount":{
                        "type":"number",
                        "description":"Total amount billed during the requested period",
                        "example":"2880.61"
                    },
                    "averageCostPerMonth":{
                        "type":"number",
                        "description":"Average bill segment amount for the service type during the statistics period",
                        "example":"261.87"
                    },
                    "numberMonthsBilled":{
                        "type":"number",
                        "maximum":"9999999999999.99",
                        "minimum":0,
                        "description":"Number of months billed during the requested period.",
                        "example":"11"
                    },
                    "multiPremiseBilling":{
                        "type":"boolean",
                        "description":"Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.",
                        "example":"false"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PremStats"
    }
}

Nested Schema : serviceTypes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type defines the type of service associated with the SA type",
                "example":"E"
            },
            "serviceTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Service type",
                "example":"Electric Service"
            },
            "currency":{
                "type":"string",
                "maxLength":60,
                "description":"Currency of financial values in premise statistics",
                "example":"USD"
            },
            "totalBilledAmount":{
                "type":"number",
                "description":"Total amount billed during the requested period",
                "example":"2880.61"
            },
            "averageCostPerMonth":{
                "type":"number",
                "description":"Average bill segment amount for the service type during the statistics period",
                "example":"261.87"
            },
            "numberMonthsBilled":{
                "type":"number",
                "maximum":"9999999999999.99",
                "minimum":0,
                "description":"Number of months billed during the requested period.",
                "example":"11"
            },
            "multiPremiseBilling":{
                "type":"boolean",
                "description":"Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.",
                "example":"false"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• averageCostPerMonth: number
  Average bill segment amount for the service type during the statistics period

  Example: 261.87
• currency: string
  Maximum Length: 60

  Currency of financial values in premise statistics

  Example: USD
• multiPremiseBilling: boolean
  Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.

  Example: false
• numberMonthsBilled: number
  Minimum Value: 0

  Maximum Value: 9999999999999.99

  Number of months billed during the requested period.

  Example: 11
• serviceType: string
  Maximum Length: 80

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

  Example: E
• serviceTypeDescription: string
  Maximum Length: 60

  Service type

  Example: Electric Service
• totalBilledAmount: number
  Total amount billed during the requested period

  Example: 2880.61

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type",
            "example":"E"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Service type",
            "example":"Electric Service"
        },
        "currency":{
            "type":"string",
            "maxLength":60,
            "description":"Currency of financial values in premise statistics",
            "example":"USD"
        },
        "totalBilledAmount":{
            "type":"number",
            "description":"Total amount billed during the requested period",
            "example":"2880.61"
        },
        "averageCostPerMonth":{
            "type":"number",
            "description":"Average bill segment amount for the service type during the statistics period",
            "example":"261.87"
        },
        "numberMonthsBilled":{
            "type":"number",
            "maximum":"9999999999999.99",
            "minimum":0,
            "description":"Number of months billed during the requested period.",
            "example":"11"
        },
        "multiPremiseBilling":{
            "type":"boolean",
            "description":"Indicates if any of the premise service points is linked to a service agreement that also has other service points linked from different premises.",
            "example":"false"
        }
    }
}

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