Jump to

• Request
• Response

Search Account Premises

post

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

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

• accountId: string
  Maximum Length: 10

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

  Example: 0119532152
• filters: object filters
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Limit

  Example: 25
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Offset

  Example: 0
• personId: string
  Maximum Length: 10

  Person ID is the system-assigned number for other persons related to the account.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"0119532152"
        },
        "personId":{
            "type":"string",
            "maxLength":"10",
            "description":"Person ID is the system-assigned number for other persons related to the account."
        },
        "filters":{
            "type":"object",
            "properties":{
                "searchText":{
                    "type":"string",
                    "maxLength":"200",
                    "description":"Search Text"
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Limit",
            "example":"25"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Offset",
            "example":"0"
        }
    },
    "xml":{
        "name":"C1GetPremAcc"
    }
}

Nested Schema : filters

Type: object

Show Source

• searchText: string
  Maximum Length: 200

  Search Text

{
    "type":"object",
    "properties":{
        "searchText":{
            "type":"string",
            "maxLength":"200",
            "description":"Search Text"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

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

  Example: 0119532152
• filters: object filters
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Limit

  Example: 25
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Offset

  Example: 0
• personId: string
  Maximum Length: 10

  Person ID is the system-assigned number for other persons related to the account.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"0119532152"
        },
        "personId":{
            "type":"string",
            "maxLength":"10",
            "description":"Person ID is the system-assigned number for other persons related to the account."
        },
        "filters":{
            "type":"object",
            "properties":{
                "searchText":{
                    "type":"string",
                    "maxLength":"200",
                    "description":"Search Text"
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Limit",
            "example":"25"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Offset",
            "example":"0"
        }
    },
    "xml":{
        "name":"C1GetPremAcc"
    }
}

Nested Schema : filters

Type: object

Show Source

• searchText: string
  Maximum Length: 200

  Search Text

{
    "type":"object",
    "properties":{
        "searchText":{
            "type":"string",
            "maxLength":"200",
            "description":"Search Text"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1GetPremAcc

Type: object

Show Source

• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Limit

  Example: 25
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Offset

  Example: 0
• premiseList: array premiseList
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

  Example: 2

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Limit",
            "example":"25"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Offset",
            "example":"0"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Total Number Of Records",
            "example":"2"
        },
        "premiseList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":"10",
                        "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                        "example":"3836403369"
                    },
                    "premiseType":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"Premise Type indicates the type of premise.",
                        "example":"HOME    (Single family home)"
                    },
                    "premiseTypeDescription":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Description for Premise Type"
                    },
                    "cisDivision":{
                        "type":"string",
                        "maxLength":"5",
                        "description":"CIS Division"
                    },
                    "lifeSupportSensitiveLoadIndicator":{
                        "type":"boolean",
                        "description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.",
                        "example":"true"
                    },
                    "lifeSupportSensitiveLoadNote":{
                        "type":"string",
                        "maxLength":"1000",
                        "description":"Life Support / Sensitive Load Description defines the type of equipment applicable to the life support or sensitive load distinction."
                    },
                    "formattedAddress":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Premise Information",
                        "example":"129 Sutter St, San Francisco, CA, 94104"
                    },
                    "address":{
                        "type":"object",
                        "properties":{
                            "country":{
                                "type":"string",
                                "maxLength":"3",
                                "description":"Country defaults from the installation options. The address constituents may differ depending on the Country.",
                                "example":"USA"
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"The postal code of the address.",
                                "example":"07960"
                            },
                            "address1":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Address"
                            },
                            "address2":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"The second line of the address."
                            },
                            "address3":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"The third line of the address."
                            },
                            "address4":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"The fourth line of the address."
                            },
                            "city":{
                                "type":"string",
                                "maxLength":"90",
                                "description":"The city of the address.",
                                "example":"Morristown"
                            },
                            "county":{
                                "type":"string",
                                "maxLength":"90",
                                "description":"The county of the address.",
                                "example":"San Francisco"
                            },
                            "houseType":{
                                "type":"string",
                                "enum":[
                                    "AB  ",
                                    "WW  "
                                ],
                                "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                            },
                            "geographic":{
                                "type":"string",
                                "maxLength":"11",
                                "description":"Geographic code used to apply proper taxation rules to the physical address location."
                            },
                            "inCityLimit":{
                                "type":"boolean",
                                "description":"In City Limit is defined as true if the address is considered within the physical city limits.",
                                "example":"false"
                            },
                            "state":{
                                "type":"string",
                                "maxLength":"6",
                                "description":"The state of the address.",
                                "example":"CA"
                            }
                        }
                    },
                    "servicePointSummary":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":"80",
                                    "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
                                    "example":"G"
                                },
                                "numberOfServicePoints":{
                                    "type":"number",
                                    "maximum":"9999999999",
                                    "minimum":"0",
                                    "description":"Number Of active service points at a premise",
                                    "example":"1"
                                },
                                "numberOfMeteredServicePoints":{
                                    "type":"number",
                                    "maximum":"9999999999",
                                    "minimum":"0",
                                    "description":"Number Of metered service points at a premise",
                                    "example":"1"
                                },
                                "disconnectedServiceIndicator":{
                                    "type":"boolean",
                                    "description":"Indicator to show if count of metered SP's is same as count of connected metered SP's not not.",
                                    "example":"true"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1GetPremAcc"
    }
}

Nested Schema : premiseList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseId":{
                "type":"string",
                "maxLength":"10",
                "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                "example":"3836403369"
            },
            "premiseType":{
                "type":"string",
                "maxLength":"8",
                "description":"Premise Type indicates the type of premise.",
                "example":"HOME    (Single family home)"
            },
            "premiseTypeDescription":{
                "type":"string",
                "maxLength":"60",
                "description":"Description for Premise Type"
            },
            "cisDivision":{
                "type":"string",
                "maxLength":"5",
                "description":"CIS Division"
            },
            "lifeSupportSensitiveLoadIndicator":{
                "type":"boolean",
                "description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.",
                "example":"true"
            },
            "lifeSupportSensitiveLoadNote":{
                "type":"string",
                "maxLength":"1000",
                "description":"Life Support / Sensitive Load Description defines the type of equipment applicable to the life support or sensitive load distinction."
            },
            "formattedAddress":{
                "type":"string",
                "maxLength":"254",
                "description":"Premise Information",
                "example":"129 Sutter St, San Francisco, CA, 94104"
            },
            "address":{
                "type":"object",
                "properties":{
                    "country":{
                        "type":"string",
                        "maxLength":"3",
                        "description":"Country defaults from the installation options. The address constituents may differ depending on the Country.",
                        "example":"USA"
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"The postal code of the address.",
                        "example":"07960"
                    },
                    "address1":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Address"
                    },
                    "address2":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"The second line of the address."
                    },
                    "address3":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"The third line of the address."
                    },
                    "address4":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"The fourth line of the address."
                    },
                    "city":{
                        "type":"string",
                        "maxLength":"90",
                        "description":"The city of the address.",
                        "example":"Morristown"
                    },
                    "county":{
                        "type":"string",
                        "maxLength":"90",
                        "description":"The county of the address.",
                        "example":"San Francisco"
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "geographic":{
                        "type":"string",
                        "maxLength":"11",
                        "description":"Geographic code used to apply proper taxation rules to the physical address location."
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"In City Limit is defined as true if the address is considered within the physical city limits.",
                        "example":"false"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":"6",
                        "description":"The state of the address.",
                        "example":"CA"
                    }
                }
            },
            "servicePointSummary":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "serviceType":{
                            "type":"string",
                            "maxLength":"80",
                            "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
                            "example":"G"
                        },
                        "numberOfServicePoints":{
                            "type":"number",
                            "maximum":"9999999999",
                            "minimum":"0",
                            "description":"Number Of active service points at a premise",
                            "example":"1"
                        },
                        "numberOfMeteredServicePoints":{
                            "type":"number",
                            "maximum":"9999999999",
                            "minimum":"0",
                            "description":"Number Of metered service points at a premise",
                            "example":"1"
                        },
                        "disconnectedServiceIndicator":{
                            "type":"boolean",
                            "description":"Indicator to show if count of metered SP's is same as count of connected metered SP's not not.",
                            "example":"true"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address: object address
• cisDivision: string
  Maximum Length: 5

  CIS Division
• formattedAddress: string
  Maximum Length: 254

  Premise Information

  Example: 129 Sutter St, San Francisco, CA, 94104
• lifeSupportSensitiveLoadIndicator: boolean
  Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.

  Example: true
• lifeSupportSensitiveLoadNote: string
  Maximum Length: 1000

  Life Support / Sensitive Load Description defines the type of equipment applicable to the life support or sensitive load distinction.
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

  Example: 3836403369
• premiseType: string
  Maximum Length: 8

  Premise Type indicates the type of premise.

  Example: HOME (Single family home)
• premiseTypeDescription: string
  Maximum Length: 60

  Description for Premise Type
• servicePointSummary: array servicePointSummary

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":"10",
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"3836403369"
        },
        "premiseType":{
            "type":"string",
            "maxLength":"8",
            "description":"Premise Type indicates the type of premise.",
            "example":"HOME    (Single family home)"
        },
        "premiseTypeDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"Description for Premise Type"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":"5",
            "description":"CIS Division"
        },
        "lifeSupportSensitiveLoadIndicator":{
            "type":"boolean",
            "description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.",
            "example":"true"
        },
        "lifeSupportSensitiveLoadNote":{
            "type":"string",
            "maxLength":"1000",
            "description":"Life Support / Sensitive Load Description defines the type of equipment applicable to the life support or sensitive load distinction."
        },
        "formattedAddress":{
            "type":"string",
            "maxLength":"254",
            "description":"Premise Information",
            "example":"129 Sutter St, San Francisco, CA, 94104"
        },
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Country defaults from the installation options. The address constituents may differ depending on the Country.",
                    "example":"USA"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"The postal code of the address.",
                    "example":"07960"
                },
                "address1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address"
                },
                "address2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The second line of the address."
                },
                "address3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The third line of the address."
                },
                "address4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The fourth line of the address."
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The city of the address.",
                    "example":"Morristown"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The county of the address.",
                    "example":"San Francisco"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":"11",
                    "description":"Geographic code used to apply proper taxation rules to the physical address location."
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit is defined as true if the address is considered within the physical city limits.",
                    "example":"false"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"The state of the address.",
                    "example":"CA"
                }
            }
        },
        "servicePointSummary":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":"80",
                        "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
                        "example":"G"
                    },
                    "numberOfServicePoints":{
                        "type":"number",
                        "maximum":"9999999999",
                        "minimum":"0",
                        "description":"Number Of active service points at a premise",
                        "example":"1"
                    },
                    "numberOfMeteredServicePoints":{
                        "type":"number",
                        "maximum":"9999999999",
                        "minimum":"0",
                        "description":"Number Of metered service points at a premise",
                        "example":"1"
                    },
                    "disconnectedServiceIndicator":{
                        "type":"boolean",
                        "description":"Indicator to show if count of metered SP's is same as count of connected metered SP's not not.",
                        "example":"true"
                    }
                }
            }
        }
    }
}

Nested Schema : address

Type: object

Show Source

• address1: string
  Maximum Length: 254

  Address
• address2: string
  Maximum Length: 254

  The second line of the address.
• address3: string
  Maximum Length: 254

  The third line of the address.
• address4: string
  Maximum Length: 254

  The fourth line of the address.
• city: string
  Maximum Length: 90

  The city of the address.

  Example: Morristown
• country: string
  Maximum Length: 3

  Country defaults from the installation options. The address constituents may differ depending on the Country.

  Example: USA
• county: string
  Maximum Length: 90

  The county of the address.

  Example: San Francisco
• geographic: string
  Maximum Length: 11

  Geographic code used to apply proper taxation rules to the physical address location.
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit is defined as true if the address is considered within the physical city limits.

  Example: false
• postal: string
  Maximum Length: 12

  The postal code of the address.

  Example: 07960
• state: string
  Maximum Length: 6

  The state of the address.

  Example: CA

{
    "type":"object",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":"3",
            "description":"Country defaults from the installation options. The address constituents may differ depending on the Country.",
            "example":"USA"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"The postal code of the address.",
            "example":"07960"
        },
        "address1":{
            "type":"string",
            "maxLength":"254",
            "description":"Address"
        },
        "address2":{
            "type":"string",
            "maxLength":"254",
            "description":"The second line of the address."
        },
        "address3":{
            "type":"string",
            "maxLength":"254",
            "description":"The third line of the address."
        },
        "address4":{
            "type":"string",
            "maxLength":"254",
            "description":"The fourth line of the address."
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"The city of the address.",
            "example":"Morristown"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"The county of the address.",
            "example":"San Francisco"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographic":{
            "type":"string",
            "maxLength":"11",
            "description":"Geographic code used to apply proper taxation rules to the physical address location."
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit is defined as true if the address is considered within the physical city limits.",
            "example":"false"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"The state of the address.",
            "example":"CA"
        }
    }
}

Nested Schema : servicePointSummary

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 service agreement. For example, G defines the service type as Gas service.",
                "example":"G"
            },
            "numberOfServicePoints":{
                "type":"number",
                "maximum":"9999999999",
                "minimum":"0",
                "description":"Number Of active service points at a premise",
                "example":"1"
            },
            "numberOfMeteredServicePoints":{
                "type":"number",
                "maximum":"9999999999",
                "minimum":"0",
                "description":"Number Of metered service points at a premise",
                "example":"1"
            },
            "disconnectedServiceIndicator":{
                "type":"boolean",
                "description":"Indicator to show if count of metered SP's is same as count of connected metered SP's not not.",
                "example":"true"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• disconnectedServiceIndicator: boolean
  Indicator to show if count of metered SP's is same as count of connected metered SP's not not.

  Example: true
• numberOfMeteredServicePoints: number
  Minimum Value: 0

  Maximum Value: 9999999999

  Number Of metered service points at a premise

  Example: 1
• numberOfServicePoints: number
  Minimum Value: 0

  Maximum Value: 9999999999

  Number Of active service points at a premise

  Example: 1
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.

  Example: G

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":"80",
            "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
            "example":"G"
        },
        "numberOfServicePoints":{
            "type":"number",
            "maximum":"9999999999",
            "minimum":"0",
            "description":"Number Of active service points at a premise",
            "example":"1"
        },
        "numberOfMeteredServicePoints":{
            "type":"number",
            "maximum":"9999999999",
            "minimum":"0",
            "description":"Number Of metered service points at a premise",
            "example":"1"
        },
        "disconnectedServiceIndicator":{
            "type":"boolean",
            "description":"Indicator to show if count of metered SP's is same as count of connected metered SP's not not.",
            "example":"true"
        }
    }
}

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