Jump to

• Request
• Response

Multi-Account Usage Summary for a date range

post

https://server:port/spl/rest/apis/customer/usage/usageData/multiAccountSummary

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

• accounts: array accounts
• endDate: string (date)
  SA end date
• filters: array filters
• httpMethod: string
  Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

  HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

  Example: GET
• startDate: string (date)
  SA start date

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID identifies the customer who is responsible for the bill.",
                        "example":"2335597500"
                    }
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"SA start date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"SA end date"
        },
        "filters":{
            "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":"W"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                        "example":"KWH"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1MlAcUsgSum"
    }
}

Nested Schema : accounts

Type: array

Show Source

• Array of: object items

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

Nested Schema : filters

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":"W"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                "example":"KWH"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

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

  Example: 2335597500

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

Nested Schema : items

Type: object

Show Source

• serviceType: string
  Maximum Length: 80

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

  Example: W
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure is the unit of measure of the bill segments's service quantity.

  Example: KWH

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"W"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
            "example":"KWH"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accounts: array accounts
• endDate: string (date)
  SA end date
• filters: array filters
• httpMethod: string
  Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

  HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

  Example: GET
• startDate: string (date)
  SA start date

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID identifies the customer who is responsible for the bill.",
                        "example":"2335597500"
                    }
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"SA start date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"SA end date"
        },
        "filters":{
            "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":"W"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                        "example":"KWH"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1MlAcUsgSum"
    }
}

Nested Schema : accounts

Type: array

Show Source

• Array of: object items

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

Nested Schema : filters

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":"W"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                "example":"KWH"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

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

  Example: 2335597500

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

Nested Schema : items

Type: object

Show Source

• serviceType: string
  Maximum Length: 80

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

  Example: W
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure is the unit of measure of the bill segments's service quantity.

  Example: KWH

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"W"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
            "example":"KWH"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1MlAcUsgSum

Type: object

Show Source

• accountHeader: array accountHeader
• httpMethod: string
  Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

  HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

  Example: GET

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "accountHeader":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "account":{
                        "type":"object",
                        "properties":{
                            "accountId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Account ID identifies the customer who is responsible for the bill.",
                                "example":"2335597500"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "firstBillDate":{
                        "type":"string",
                        "format":"date",
                        "description":"First bill date",
                        "example":"2000-09-01"
                    },
                    "lastBillDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Last bill date",
                        "example":"2000-01-01"
                    },
                    "usageFound":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Usage found flag",
                        "example":"Y"
                    },
                    "usageDetails":{
                        "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.",
                                            "example":"W"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "unitOfMeasure":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                                    "example":"KWH"
                                },
                                "peakIndicator":{
                                    "type":"string",
                                    "maxLength":1,
                                    "description":"Measures Peak Qty indicates if the unit of measure is one that measures peak consumption.",
                                    "example":"N"
                                },
                                "usage":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "usageIdentifier":{
                                                "type":"string",
                                                "maxLength":12,
                                                "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                                                "example":"KWH/-/-"
                                            },
                                            "usageValue":{
                                                "type":"number",
                                                "maximum":999999,
                                                "minimum":0,
                                                "description":"Usage Value",
                                                "example":"31743.8"
                                            },
                                            "timeOfUse":{
                                                "type":"string",
                                                "maxLength":30,
                                                "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                                                "example":"OFF"
                                            },
                                            "serviceQuantityIdentifer":{
                                                "type":"string",
                                                "maxLength":30,
                                                "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                                                "example":"DAMT (Daily Amount)"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1MlAcUsgSum"
    }
}

Nested Schema : accountHeader

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "account":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID identifies the customer who is responsible for the bill.",
                        "example":"2335597500"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "firstBillDate":{
                "type":"string",
                "format":"date",
                "description":"First bill date",
                "example":"2000-09-01"
            },
            "lastBillDate":{
                "type":"string",
                "format":"date",
                "description":"Last bill date",
                "example":"2000-01-01"
            },
            "usageFound":{
                "type":"string",
                "maxLength":1,
                "description":"Usage found flag",
                "example":"Y"
            },
            "usageDetails":{
                "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.",
                                    "example":"W"
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        },
                        "unitOfMeasure":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                            "example":"KWH"
                        },
                        "peakIndicator":{
                            "type":"string",
                            "maxLength":1,
                            "description":"Measures Peak Qty indicates if the unit of measure is one that measures peak consumption.",
                            "example":"N"
                        },
                        "usage":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "usageIdentifier":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                                        "example":"KWH/-/-"
                                    },
                                    "usageValue":{
                                        "type":"number",
                                        "maximum":999999,
                                        "minimum":0,
                                        "description":"Usage Value",
                                        "example":"31743.8"
                                    },
                                    "timeOfUse":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                                        "example":"OFF"
                                    },
                                    "serviceQuantityIdentifer":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                                        "example":"DAMT (Daily Amount)"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• account: object account
• firstBillDate: string (date)
  First bill date

  Example: 2000-09-01
• lastBillDate: string (date)
  Last bill date

  Example: 2000-01-01
• usageDetails: array usageDetails
• usageFound: string
  Maximum Length: 1

  Usage found flag

  Example: Y

{
    "type":"object",
    "properties":{
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID identifies the customer who is responsible for the bill.",
                    "example":"2335597500"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "firstBillDate":{
            "type":"string",
            "format":"date",
            "description":"First bill date",
            "example":"2000-09-01"
        },
        "lastBillDate":{
            "type":"string",
            "format":"date",
            "description":"Last bill date",
            "example":"2000-01-01"
        },
        "usageFound":{
            "type":"string",
            "maxLength":1,
            "description":"Usage found flag",
            "example":"Y"
        },
        "usageDetails":{
            "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.",
                                "example":"W"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                        "example":"KWH"
                    },
                    "peakIndicator":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Measures Peak Qty indicates if the unit of measure is one that measures peak consumption.",
                        "example":"N"
                    },
                    "usage":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "usageIdentifier":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                                    "example":"KWH/-/-"
                                },
                                "usageValue":{
                                    "type":"number",
                                    "maximum":999999,
                                    "minimum":0,
                                    "description":"Usage Value",
                                    "example":"31743.8"
                                },
                                "timeOfUse":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                                    "example":"OFF"
                                },
                                "serviceQuantityIdentifer":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                                    "example":"DAMT (Daily Amount)"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : account

Type: object

Show Source

• _link: string
  _link
• accountId: string
  Maximum Length: 10

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

  Example: 2335597500

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

Nested Schema : usageDetails

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.",
                        "example":"W"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                "example":"KWH"
            },
            "peakIndicator":{
                "type":"string",
                "maxLength":1,
                "description":"Measures Peak Qty indicates if the unit of measure is one that measures peak consumption.",
                "example":"N"
            },
            "usage":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "usageIdentifier":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                            "example":"KWH/-/-"
                        },
                        "usageValue":{
                            "type":"number",
                            "maximum":999999,
                            "minimum":0,
                            "description":"Usage Value",
                            "example":"31743.8"
                        },
                        "timeOfUse":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                            "example":"OFF"
                        },
                        "serviceQuantityIdentifer":{
                            "type":"string",
                            "maxLength":30,
                            "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                            "example":"DAMT (Daily Amount)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• peakIndicator: string
  Maximum Length: 1

  Measures Peak Qty indicates if the unit of measure is one that measures peak consumption.

  Example: N
• serviceType: object serviceType
  Service Type defines the type of service associated with the SA type.
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure is the unit of measure of the bill segments's service quantity.

  Example: KWH
• usage: array usage

{
    "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.",
                    "example":"W"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
            "example":"KWH"
        },
        "peakIndicator":{
            "type":"string",
            "maxLength":1,
            "description":"Measures Peak Qty indicates if the unit of measure is one that measures peak consumption.",
            "example":"N"
        },
        "usage":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "usageIdentifier":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                        "example":"KWH/-/-"
                    },
                    "usageValue":{
                        "type":"number",
                        "maximum":999999,
                        "minimum":0,
                        "description":"Usage Value",
                        "example":"31743.8"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                        "example":"OFF"
                    },
                    "serviceQuantityIdentifer":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                        "example":"DAMT (Daily Amount)"
                    }
                }
            }
        }
    }
}

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.

  Example: W

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

Nested Schema : usage

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "usageIdentifier":{
                "type":"string",
                "maxLength":12,
                "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                "example":"KWH/-/-"
            },
            "usageValue":{
                "type":"number",
                "maximum":999999,
                "minimum":0,
                "description":"Usage Value",
                "example":"31743.8"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                "example":"OFF"
            },
            "serviceQuantityIdentifer":{
                "type":"string",
                "maxLength":30,
                "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                "example":"DAMT (Daily Amount)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• serviceQuantityIdentifer: string
  Maximum Length: 30

  SQI is the service quantity identifier of the bill segments's service quantity.

  Example: DAMT (Daily Amount)
• timeOfUse: string
  Maximum Length: 30

  Time of Use is the time-of-use of the bill segment's service quantity.

  Example: OFF
• usageIdentifier: string
  Maximum Length: 12

  Usage Identifier (combination of UOM/TOU/SQI)

  Example: KWH/-/-
• usageValue: number
  Minimum Value: 0

  Maximum Value: 999999

  Usage Value

  Example: 31743.8

{
    "type":"object",
    "properties":{
        "usageIdentifier":{
            "type":"string",
            "maxLength":12,
            "description":"Usage Identifier (combination of UOM/TOU/SQI)",
            "example":"KWH/-/-"
        },
        "usageValue":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"Usage Value",
            "example":"31743.8"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
            "example":"OFF"
        },
        "serviceQuantityIdentifer":{
            "type":"string",
            "maxLength":30,
            "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
            "example":"DAMT (Daily Amount)"
        }
    }
}

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