Get Web User Account
get
https://server:port/spl/rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}
This operation handles the Integration Suite API to Get Web User Account
Request
Path 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-CxWbUsrAt
Type:
Show Source
object
-
_self: string
_self
-
accountId: string
Maximum Length:
10
Account IDExample:2241606344
-
accountVerification: object
accountVerification
-
businessLine: string
Maximum Length:
30
Line of BusinessExample:RESIDENTIAL
-
errorInformation: object
errorInformation
-
person: object
person
-
status: string
Maximum Length:
12
status -
version: number
Minimum Value:
-99999
Maximum Value:99999
versionExample:1
-
webUserAccountNickname: string
Maximum Length:
254
Web User Account NicknameExample:Main Account Test
-
webUserAccountRole: string
Maximum Length:
254
Web User Account RoleExample:CXAH
-
webUserAccountStatus: string
Allowed Values:
[ "C1AC", "C1IN" ]
Web User Account Status * `C1AC` - Active, * `C1IN` - inactiveExample:C1IN
-
webUserId: string
Maximum Length:
10
Web User IdExample:1213348966
Nested Schema : accountVerification
Type:
Show Source
object
-
group: array
group
-
isVerified: boolean
Is VerifiedExample:
false
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 : person
Type:
Show Source
object
-
_link: string
_link
-
personId: string
Maximum Length:
10
Person IDExample:1343682500
Nested Schema : items
Type:
Show Source
object
-
fields: array
fields
-
name: string
Maximum Length:
30
Group NameExample:IDENTIFIERS
Nested Schema : items
Type:
Show Source
object
-
fieldType: string
Allowed Values:
[ "C1AP", "C1PC", "WXAP", "WXID", "WXPH", "ZZBN", "ZZMA", "ZZPC" ]
Field Type * `C1AP` - Match Any Person Contact Phone, * `C1PC` - Match Person Contact Type, * `WXAP` - Match Any Phone, * `WXID` - Match Identifier, * `WXPH` - Match Phone Type, * `ZZBN` - Match Meter Number (zz), * `ZZMA` - Match Street Address (zz), * `ZZPC` - Match Postal Code (zz)Example:WXID
-
identifierType: string
(identifierType)
-
value: string
Maximum Length:
254
valueExample:123-45-6789
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.