Jump to

• Request
• Response

Multi-Account Usage Summary for a date range

post

/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)
  The end date for the service agreement.

  Example: 2022-12-20
• filters: object filters
• startDate: string (date)
  The start date for the service agreement.

  Example: 2022-12-20

{
    "type":"object",
    "properties":{
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The unique identifier of the account for the customer who is responsible for the bill.",
                        "example":"2335597500"
                    }
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The start date for the service agreement.",
            "example":"2022-12-20"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"The end date for the service agreement.",
            "example":"2022-12-20"
        },
        "filters":{
            "type":"object",
            "properties":{
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"The type of service associated with the service agreement.",
                    "example":"W"
                },
                "unitOfMeasure":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The unit of measure of the bill segments's usage value.",
                    "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":"The unique identifier of the account for the customer who is responsible for the bill.",
                "example":"2335597500"
            }
        }
    }
}

Nested Schema : filters

Type: object

Show Source

• serviceType: string
  Maximum Length: 80

  The type of service associated with the service agreement.

  Example: W
• unitOfMeasure: string
  Maximum Length: 30

  The unit of measure of the bill segments's usage value.

  Example: KWH

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"The type of service associated with the service agreement.",
            "example":"W"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The unit of measure of the bill segments's usage value.",
            "example":"KWH"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  The unique identifier of the account for the customer who is responsible for the bill.

  Example: 2335597500

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The unique identifier of the account for the customer who is responsible for the bill.",
            "example":"2335597500"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accounts: array accounts
• endDate: string (date)
  The end date for the service agreement.

  Example: 2022-12-20
• filters: object filters
• startDate: string (date)
  The start date for the service agreement.

  Example: 2022-12-20

{
    "type":"object",
    "properties":{
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The unique identifier of the account for the customer who is responsible for the bill.",
                        "example":"2335597500"
                    }
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The start date for the service agreement.",
            "example":"2022-12-20"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"The end date for the service agreement.",
            "example":"2022-12-20"
        },
        "filters":{
            "type":"object",
            "properties":{
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"The type of service associated with the service agreement.",
                    "example":"W"
                },
                "unitOfMeasure":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The unit of measure of the bill segments's usage value.",
                    "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":"The unique identifier of the account for the customer who is responsible for the bill.",
                "example":"2335597500"
            }
        }
    }
}

Nested Schema : filters

Type: object

Show Source

• serviceType: string
  Maximum Length: 80

  The type of service associated with the service agreement.

  Example: W
• unitOfMeasure: string
  Maximum Length: 30

  The unit of measure of the bill segments's usage value.

  Example: KWH

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"The type of service associated with the service agreement.",
            "example":"W"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The unit of measure of the bill segments's usage value.",
            "example":"KWH"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  The unique identifier of the account for the customer who is responsible for the bill.

  Example: 2335597500

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The unique identifier of the account for the customer who is responsible for the bill.",
            "example":"2335597500"
        }
    }
}

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

{
    "type":"object",
    "properties":{
        "accountHeader":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "account":{
                        "type":"object",
                        "properties":{
                            "accountId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"The unique identifier of the account for the customer who is responsible for the bill.",
                                "example":"2335597500"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "firstBillDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The date of the earliest bill found in the requested timeframe.",
                        "example":"2000-09-01"
                    },
                    "lastBillDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The date of the latest bill found in the requested timeframe.",
                        "example":"2000-01-01"
                    },
                    "usageFound":{
                        "type":"boolean",
                        "description":"The Usage found flag indicates that usage data was available in the requested timeframe.",
                        "example":"Y"
                    },
                    "usageDetails":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceType":{
                                    "type":"object",
                                    "description":"The type of service associated with the service agreement.",
                                    "properties":{
                                        "serviceType":{
                                            "type":"string",
                                            "maxLength":80,
                                            "description":"The type of service associated with the service agreement.",
                                            "example":"W"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "unitOfMeasure":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"The unit of measure of the bill segments's usage value.",
                                    "example":"KWH"
                                },
                                "peakIndicator":{
                                    "type":"string",
                                    "maxLength":1,
                                    "description":"Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.",
                                    "example":"false"
                                },
                                "usage":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "usageIdentifier":{
                                                "type":"string",
                                                "maxLength":100,
                                                "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                                                "example":"KWH--(UOM-TOU-SQI)"
                                            },
                                            "usageValue":{
                                                "type":"number",
                                                "maximum":9999.999999,
                                                "minimum":0,
                                                "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                                                "example":"31743.8"
                                            },
                                            "timeOfUse":{
                                                "type":"string",
                                                "maxLength":30,
                                                "description":"The time-of-use classification of the bill segment's service quantity.",
                                                "example":"OFF"
                                            },
                                            "serviceQuantityIdentifer":{
                                                "type":"string",
                                                "maxLength":30,
                                                "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                                                "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":"The unique identifier of the account for the customer who is responsible for the bill.",
                        "example":"2335597500"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "firstBillDate":{
                "type":"string",
                "format":"date",
                "description":"The date of the earliest bill found in the requested timeframe.",
                "example":"2000-09-01"
            },
            "lastBillDate":{
                "type":"string",
                "format":"date",
                "description":"The date of the latest bill found in the requested timeframe.",
                "example":"2000-01-01"
            },
            "usageFound":{
                "type":"boolean",
                "description":"The Usage found flag indicates that usage data was available in the requested timeframe.",
                "example":"Y"
            },
            "usageDetails":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "serviceType":{
                            "type":"object",
                            "description":"The type of service associated with the service agreement.",
                            "properties":{
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":80,
                                    "description":"The type of service associated with the service agreement.",
                                    "example":"W"
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        },
                        "unitOfMeasure":{
                            "type":"string",
                            "maxLength":30,
                            "description":"The unit of measure of the bill segments's usage value.",
                            "example":"KWH"
                        },
                        "peakIndicator":{
                            "type":"string",
                            "maxLength":1,
                            "description":"Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.",
                            "example":"false"
                        },
                        "usage":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "usageIdentifier":{
                                        "type":"string",
                                        "maxLength":100,
                                        "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                                        "example":"KWH--(UOM-TOU-SQI)"
                                    },
                                    "usageValue":{
                                        "type":"number",
                                        "maximum":9999.999999,
                                        "minimum":0,
                                        "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                                        "example":"31743.8"
                                    },
                                    "timeOfUse":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"The time-of-use classification of the bill segment's service quantity.",
                                        "example":"OFF"
                                    },
                                    "serviceQuantityIdentifer":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                                        "example":"DAMT (Daily Amount)"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• account: object account
• firstBillDate: string (date)
  The date of the earliest bill found in the requested timeframe.

  Example: 2000-09-01
• lastBillDate: string (date)
  The date of the latest bill found in the requested timeframe.

  Example: 2000-01-01
• usageDetails: array usageDetails
• usageFound: boolean
  The Usage found flag indicates that usage data was available in the requested timeframe.

  Example: Y

{
    "type":"object",
    "properties":{
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The unique identifier of the account for the customer who is responsible for the bill.",
                    "example":"2335597500"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "firstBillDate":{
            "type":"string",
            "format":"date",
            "description":"The date of the earliest bill found in the requested timeframe.",
            "example":"2000-09-01"
        },
        "lastBillDate":{
            "type":"string",
            "format":"date",
            "description":"The date of the latest bill found in the requested timeframe.",
            "example":"2000-01-01"
        },
        "usageFound":{
            "type":"boolean",
            "description":"The Usage found flag indicates that usage data was available in the requested timeframe.",
            "example":"Y"
        },
        "usageDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"object",
                        "description":"The type of service associated with the service agreement.",
                        "properties":{
                            "serviceType":{
                                "type":"string",
                                "maxLength":80,
                                "description":"The type of service associated with the service agreement.",
                                "example":"W"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The unit of measure of the bill segments's usage value.",
                        "example":"KWH"
                    },
                    "peakIndicator":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.",
                        "example":"false"
                    },
                    "usage":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "usageIdentifier":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                                    "example":"KWH--(UOM-TOU-SQI)"
                                },
                                "usageValue":{
                                    "type":"number",
                                    "maximum":9999.999999,
                                    "minimum":0,
                                    "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                                    "example":"31743.8"
                                },
                                "timeOfUse":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"The time-of-use classification of the bill segment's service quantity.",
                                    "example":"OFF"
                                },
                                "serviceQuantityIdentifer":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                                    "example":"DAMT (Daily Amount)"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : account

Type: object

Show Source

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

  The unique identifier of the account for the customer who is responsible for the bill.

  Example: 2335597500

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The unique identifier of the account for 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":"The type of service associated with the service agreement.",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"The type of service associated with the service agreement.",
                        "example":"W"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"The unit of measure of the bill segments's usage value.",
                "example":"KWH"
            },
            "peakIndicator":{
                "type":"string",
                "maxLength":1,
                "description":"Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.",
                "example":"false"
            },
            "usage":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "usageIdentifier":{
                            "type":"string",
                            "maxLength":100,
                            "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                            "example":"KWH--(UOM-TOU-SQI)"
                        },
                        "usageValue":{
                            "type":"number",
                            "maximum":9999.999999,
                            "minimum":0,
                            "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                            "example":"31743.8"
                        },
                        "timeOfUse":{
                            "type":"string",
                            "maxLength":30,
                            "description":"The time-of-use classification of the bill segment's service quantity.",
                            "example":"OFF"
                        },
                        "serviceQuantityIdentifer":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                            "example":"DAMT (Daily Amount)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• peakIndicator: string
  Maximum Length: 1

  Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.

  Example: false
• serviceType: object serviceType
  The type of service associated with the service agreement.
• unitOfMeasure: string
  Maximum Length: 30

  The unit of measure of the bill segments's usage value.

  Example: KWH
• usage: array usage

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"object",
            "description":"The type of service associated with the service agreement.",
            "properties":{
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"The type of service associated with the service agreement.",
                    "example":"W"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The unit of measure of the bill segments's usage value.",
            "example":"KWH"
        },
        "peakIndicator":{
            "type":"string",
            "maxLength":1,
            "description":"Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.",
            "example":"false"
        },
        "usage":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "usageIdentifier":{
                        "type":"string",
                        "maxLength":100,
                        "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                        "example":"KWH--(UOM-TOU-SQI)"
                    },
                    "usageValue":{
                        "type":"number",
                        "maximum":9999.999999,
                        "minimum":0,
                        "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                        "example":"31743.8"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The time-of-use classification of the bill segment's service quantity.",
                        "example":"OFF"
                    },
                    "serviceQuantityIdentifer":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                        "example":"DAMT (Daily Amount)"
                    }
                }
            }
        }
    }
}

Nested Schema : serviceType

Type: object

The type of service associated with the service agreement.

Show Source

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

  The type of service associated with the service agreement.

  Example: W

{
    "type":"object",
    "description":"The type of service associated with the service agreement.",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"The type of service associated with the service agreement.",
            "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":100,
                "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                "example":"KWH--(UOM-TOU-SQI)"
            },
            "usageValue":{
                "type":"number",
                "maximum":9999.999999,
                "minimum":0,
                "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                "example":"31743.8"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"The time-of-use classification of the bill segment's service quantity.",
                "example":"OFF"
            },
            "serviceQuantityIdentifer":{
                "type":"string",
                "maxLength":30,
                "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                "example":"DAMT (Daily Amount)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• serviceQuantityIdentifer: string
  Maximum Length: 30

  Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.

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

  The time-of-use classification of the bill segment's service quantity.

  Example: OFF
• usageIdentifier: string
  Maximum Length: 100

  An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.

  Example: KWH--(UOM-TOU-SQI)
• usageValue: number
  Minimum Value: 0

  Maximum Value: 9999.999999

  The total usage value. Refer to the defined unit of measure for complete context of this value.

  Example: 31743.8

{
    "type":"object",
    "properties":{
        "usageIdentifier":{
            "type":"string",
            "maxLength":100,
            "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
            "example":"KWH--(UOM-TOU-SQI)"
        },
        "usageValue":{
            "type":"number",
            "maximum":9999.999999,
            "minimum":0,
            "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
            "example":"31743.8"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"The time-of-use classification of the bill segment's service quantity.",
            "example":"OFF"
        },
        "serviceQuantityIdentifer":{
            "type":"string",
            "maxLength":30,
            "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
            "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