Jump to

• Request
• Response

Search Web User Accounts

get

https://server:port/spl/rest/apis/customer/service/webUserAccounts/{webUserId}

Request

Path Parameters

• webUserId(required): string

Query Parameters

• accountId: string
• addressLine: string
• city: string
• limit: number
• nickname: string
• offset: number
• postal: string
• state: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1-SrWbUsrAt

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID

  Example: 2241606344
• addressLine: string
  Maximum Length: 254

  Address
• city: string
  Maximum Length: 90

  City
• connectedAccounts: object connectedAccounts
• errorInformation: object errorInformation
• limit: number
  Minimum Value: -9.9999999999999E13

  Maximum Value: 9.9999999999999E13

  Number
• nickname: string
  Maximum Length: 254

  Web User Account Nickname

  Example: Main Account Test
• offset: number
  Minimum Value: -9.9999999999999E13

  Maximum Value: 9.9999999999999E13

  Number
• postal: string
  Maximum Length: 12

  Postal
• state: string
  Maximum Length: 6

  State
• totalRecords: number
  Minimum Value: -9.9999999999999E13

  Maximum Value: 9.9999999999999E13

  Number
• webUserId: string
  Maximum Length: 10

  Web User Id

  Example: 1213348966

{
    "type":"object",
    "properties":{
        "webUserId":{
            "type":"string",
            "maxLength":10,
            "description":"Web User Id",
            "example":"1213348966"
        },
        "addressLine":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"City"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"Postal"
        },
        "nickname":{
            "type":"string",
            "maxLength":254,
            "description":"Web User Account Nickname",
            "example":"Main Account Test"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID",
            "example":"2241606344"
        },
        "offset":{
            "type":"number",
            "maximum":9.9999999999999E13,
            "minimum":-9.9999999999999E13,
            "description":"Number"
        },
        "limit":{
            "type":"number",
            "maximum":9.9999999999999E13,
            "minimum":-9.9999999999999E13,
            "description":"Number"
        },
        "totalRecords":{
            "type":"number",
            "maximum":9.9999999999999E13,
            "minimum":-9.9999999999999E13,
            "description":"Number"
        },
        "connectedAccounts":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "account":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "accountId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Account ID"
                                    }
                                }
                            },
                            "webUserAccountRole":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Web User Account Role"
                            },
                            "person":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "personId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Person ID"
                                    }
                                }
                            },
                            "webUserAccountNickname":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Web User Account Nickname"
                            },
                            "multiplePremiseExist":{
                                "type":"boolean",
                                "description":"(multiplePremiseExist)"
                            },
                            "mainCustomerName":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Name"
                            },
                            "premise":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "premise":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "premiseId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Premise ID"
                                                }
                                            }
                                        },
                                        "country":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Country"
                                        },
                                        "addressLine1":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Address"
                                        },
                                        "addressLine2":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Address 2"
                                        },
                                        "addressLine3":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Address 3"
                                        },
                                        "addressLine4":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Address 4"
                                        },
                                        "houseType":{
                                            "type":"string",
                                            "enum":[
                                                "AB  ",
                                                "WW  "
                                            ],
                                            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                                        },
                                        "number1":{
                                            "type":"string",
                                            "maxLength":6,
                                            "description":"Number 1"
                                        },
                                        "number2":{
                                            "type":"string",
                                            "maxLength":4,
                                            "description":"Number 2"
                                        },
                                        "inCityLimit":{
                                            "type":"boolean",
                                            "description":"In City Limit"
                                        },
                                        "city":{
                                            "type":"string",
                                            "maxLength":90,
                                            "description":"City"
                                        },
                                        "geographic":{
                                            "type":"string",
                                            "maxLength":11,
                                            "description":"Geographical Code"
                                        },
                                        "county":{
                                            "type":"string",
                                            "maxLength":90,
                                            "description":"County"
                                        },
                                        "state":{
                                            "type":"string",
                                            "maxLength":6,
                                            "description":"State"
                                        },
                                        "postal":{
                                            "type":"string",
                                            "maxLength":12,
                                            "description":"Postal"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "errorInformation":{
            "type":"object",
            "properties":{
                "isInError":{
                    "type":"boolean",
                    "description":"Error"
                },
                "errorReference":{
                    "type":"object",
                    "properties":{
                        "category":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Category"
                        },
                        "number":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number"
                        }
                    }
                },
                "errorMessage":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    },
    "xml":{
        "name":"C1-SrWbUsrAt"
    }
}

Nested Schema : connectedAccounts

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "account":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "accountId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Account ID"
                            }
                        }
                    },
                    "webUserAccountRole":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Web User Account Role"
                    },
                    "person":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person ID"
                            }
                        }
                    },
                    "webUserAccountNickname":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Web User Account Nickname"
                    },
                    "multiplePremiseExist":{
                        "type":"boolean",
                        "description":"(multiplePremiseExist)"
                    },
                    "mainCustomerName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Name"
                    },
                    "premise":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "premise":{
                                    "type":"object",
                                    "properties":{
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        },
                                        "premiseId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Premise ID"
                                        }
                                    }
                                },
                                "country":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Country"
                                },
                                "addressLine1":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Address"
                                },
                                "addressLine2":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Address 2"
                                },
                                "addressLine3":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Address 3"
                                },
                                "addressLine4":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Address 4"
                                },
                                "houseType":{
                                    "type":"string",
                                    "enum":[
                                        "AB  ",
                                        "WW  "
                                    ],
                                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                                },
                                "number1":{
                                    "type":"string",
                                    "maxLength":6,
                                    "description":"Number 1"
                                },
                                "number2":{
                                    "type":"string",
                                    "maxLength":4,
                                    "description":"Number 2"
                                },
                                "inCityLimit":{
                                    "type":"boolean",
                                    "description":"In City Limit"
                                },
                                "city":{
                                    "type":"string",
                                    "maxLength":90,
                                    "description":"City"
                                },
                                "geographic":{
                                    "type":"string",
                                    "maxLength":11,
                                    "description":"Geographical Code"
                                },
                                "county":{
                                    "type":"string",
                                    "maxLength":90,
                                    "description":"County"
                                },
                                "state":{
                                    "type":"string",
                                    "maxLength":6,
                                    "description":"State"
                                },
                                "postal":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"Postal"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : errorInformation

Type: object

Show Source

• errorMessage: string
  Maximum Length: 254

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• errorReference: object errorReference
• isInError: boolean
  Error

{
    "type":"object",
    "properties":{
        "isInError":{
            "type":"boolean",
            "description":"Error"
        },
        "errorReference":{
            "type":"object",
            "properties":{
                "category":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Category"
                },
                "number":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number"
                }
            }
        },
        "errorMessage":{
            "type":"string",
            "maxLength":254,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "_link":{
                "type":"string",
                "description":"_link"
            },
            "account":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID"
                    }
                }
            },
            "webUserAccountRole":{
                "type":"string",
                "maxLength":254,
                "description":"Web User Account Role"
            },
            "person":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID"
                    }
                }
            },
            "webUserAccountNickname":{
                "type":"string",
                "maxLength":254,
                "description":"Web User Account Nickname"
            },
            "multiplePremiseExist":{
                "type":"boolean",
                "description":"(multiplePremiseExist)"
            },
            "mainCustomerName":{
                "type":"string",
                "maxLength":254,
                "description":"Name"
            },
            "premise":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "premise":{
                            "type":"object",
                            "properties":{
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                },
                                "premiseId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Premise ID"
                                }
                            }
                        },
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country"
                        },
                        "addressLine1":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Address"
                        },
                        "addressLine2":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Address 2"
                        },
                        "addressLine3":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Address 3"
                        },
                        "addressLine4":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Address 4"
                        },
                        "houseType":{
                            "type":"string",
                            "enum":[
                                "AB  ",
                                "WW  "
                            ],
                            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                        },
                        "number1":{
                            "type":"string",
                            "maxLength":6,
                            "description":"Number 1"
                        },
                        "number2":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Number 2"
                        },
                        "inCityLimit":{
                            "type":"boolean",
                            "description":"In City Limit"
                        },
                        "city":{
                            "type":"string",
                            "maxLength":90,
                            "description":"City"
                        },
                        "geographic":{
                            "type":"string",
                            "maxLength":11,
                            "description":"Geographical Code"
                        },
                        "county":{
                            "type":"string",
                            "maxLength":90,
                            "description":"County"
                        },
                        "state":{
                            "type":"string",
                            "maxLength":6,
                            "description":"State"
                        },
                        "postal":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Postal"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _link: string
  _link
• account: object account
• mainCustomerName: string
  Maximum Length: 254

  Name
• multiplePremiseExist: boolean
  (multiplePremiseExist)
• person: object person
• premise: array premise
• webUserAccountNickname: string
  Maximum Length: 254

  Web User Account Nickname
• webUserAccountRole: string
  Maximum Length: 254

  Web User Account Role

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                }
            }
        },
        "webUserAccountRole":{
            "type":"string",
            "maxLength":254,
            "description":"Web User Account Role"
        },
        "person":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID"
                }
            }
        },
        "webUserAccountNickname":{
            "type":"string",
            "maxLength":254,
            "description":"Web User Account Nickname"
        },
        "multiplePremiseExist":{
            "type":"boolean",
            "description":"(multiplePremiseExist)"
        },
        "mainCustomerName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        },
        "premise":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premise":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID"
                            }
                        }
                    },
                    "country":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Country"
                    },
                    "addressLine1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address"
                    },
                    "addressLine2":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 2"
                    },
                    "addressLine3":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 3"
                    },
                    "addressLine4":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 4"
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "number1":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Number 1"
                    },
                    "number2":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Number 2"
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"In City Limit"
                    },
                    "city":{
                        "type":"string",
                        "maxLength":90,
                        "description":"City"
                    },
                    "geographic":{
                        "type":"string",
                        "maxLength":11,
                        "description":"Geographical Code"
                    },
                    "county":{
                        "type":"string",
                        "maxLength":90,
                        "description":"County"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":6,
                        "description":"State"
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Postal"
                    }
                }
            }
        }
    }
}

Nested Schema : account

Type: object

Show Source

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

  Account ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

Nested Schema : person

Type: object

Show Source

• _link: string
  _link
• personId: string
  Maximum Length: 10

  Person ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID"
        }
    }
}

Nested Schema : premise

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premise":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID"
                    }
                }
            },
            "country":{
                "type":"string",
                "maxLength":3,
                "description":"Country"
            },
            "addressLine1":{
                "type":"string",
                "maxLength":254,
                "description":"Address"
            },
            "addressLine2":{
                "type":"string",
                "maxLength":254,
                "description":"Address 2"
            },
            "addressLine3":{
                "type":"string",
                "maxLength":254,
                "description":"Address 3"
            },
            "addressLine4":{
                "type":"string",
                "maxLength":254,
                "description":"Address 4"
            },
            "houseType":{
                "type":"string",
                "enum":[
                    "AB  ",
                    "WW  "
                ],
                "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
            },
            "number1":{
                "type":"string",
                "maxLength":6,
                "description":"Number 1"
            },
            "number2":{
                "type":"string",
                "maxLength":4,
                "description":"Number 2"
            },
            "inCityLimit":{
                "type":"boolean",
                "description":"In City Limit"
            },
            "city":{
                "type":"string",
                "maxLength":90,
                "description":"City"
            },
            "geographic":{
                "type":"string",
                "maxLength":11,
                "description":"Geographical Code"
            },
            "county":{
                "type":"string",
                "maxLength":90,
                "description":"County"
            },
            "state":{
                "type":"string",
                "maxLength":6,
                "description":"State"
            },
            "postal":{
                "type":"string",
                "maxLength":12,
                "description":"Postal"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• addressLine1: string
  Maximum Length: 254

  Address
• addressLine2: string
  Maximum Length: 254

  Address 2
• addressLine3: string
  Maximum Length: 254

  Address 3
• addressLine4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• number1: string
  Maximum Length: 6

  Number 1
• number2: string
  Maximum Length: 4

  Number 2
• postal: string
  Maximum Length: 12

  Postal
• premise: object premise
• state: string
  Maximum Length: 6

  State

{
    "type":"object",
    "properties":{
        "premise":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID"
                }
            }
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        },
        "addressLine1":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "addressLine2":{
            "type":"string",
            "maxLength":254,
            "description":"Address 2"
        },
        "addressLine3":{
            "type":"string",
            "maxLength":254,
            "description":"Address 3"
        },
        "addressLine4":{
            "type":"string",
            "maxLength":254,
            "description":"Address 4"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Number 2"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"City"
        },
        "geographic":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"County"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"Postal"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• premiseId: string
  Maximum Length: 10

  Premise ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        }
    }
}

Nested Schema : errorReference

Type: object

Show Source

• category: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category
• number: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number

{
    "type":"object",
    "properties":{
        "category":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Category"
        },
        "number":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number"
        }
    }
}

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