Search Web User Accounts
get
https://server:port/spl/rest/apis/customer/service/webUserAccounts/{webUserId}
Request
Path Parameters
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-SrWbUsrAt
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account IDExample: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 NicknameExample: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 IdExample:1213348966
Nested Schema : errorInformation
Type:
Show Source
object
-
errorMessage: string
Maximum Length:
254
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
errorReference: object
errorReference
-
isInError: boolean
Error
Nested Schema : items
Type:
Show Source
object
-
_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
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : person
Type:
Show Source
object
-
_link: string
_link
-
personId: string
Maximum Length:
10
Person ID
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseId: string
Maximum Length:
10
Premise ID
Nested Schema : errorReference
Type:
Show Source
object
-
category: number
Minimum Value:
-99999
Maximum Value:99999
Message Category -
number: number
Minimum Value:
-99999
Maximum Value:99999
Message Number
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.