Premise Statistics
post
/rest/apis/customer/v-model/premises/premiseStatistics
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
endDate: string
(date)
End Date
-
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
Nested Schema : items
Type:
Show Source
object
-
averageCostPerMonth: number
Average Cost Per Month
-
currency: string
Maximum Length:
60
Currency Description -
multiPremiseBilling: boolean
Is Multi Premise Billing
-
numberMonthsBilled: number
Minimum Value:
0
Maximum Value:0
Number Of Months Billed -
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the SA typeExample:E
-
serviceTypeDescription: string
Maximum Length:
60
Description -
totalBilledAmount: number
Total Billed Amount
Root Schema : schema
Type:
Show Source
object
-
endDate: string
(date)
End Date
-
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
Nested Schema : items
Type:
Show Source
object
-
averageCostPerMonth: number
Average Cost Per Month
-
currency: string
Maximum Length:
60
Currency Description -
multiPremiseBilling: boolean
Is Multi Premise Billing
-
numberMonthsBilled: number
Minimum Value:
0
Maximum Value:0
Number Of Months Billed -
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the SA typeExample:E
-
serviceTypeDescription: string
Maximum Length:
60
Description -
totalBilledAmount: number
Total Billed Amount
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : items
Type:
Show Source
object
-
averageCostPerMonth: number
Average Cost Per Month
-
currency: string
Maximum Length:
60
Currency Description -
multiPremiseBilling: boolean
Is Multi Premise Billing
-
numberMonthsBilled: number
Minimum Value:
0
Maximum Value:0
Number Of Months Billed -
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the SA typeExample:E
-
serviceTypeDescription: string
Maximum Length:
60
Description -
totalBilledAmount: number
Total Billed Amount
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.