Get Person Context
get
https://server:port/spl/rest/apis/customer/v-model/personContext/{personId}
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
Nested Schema : person
Type:
Show Source
object
-
personId: string
Maximum Length:
10
Person ID is the system-assigned number for other persons related to the account.Example:4429925678
-
primaryName: string
Maximum Length:
254
A person's primary name is the addressee on the person's bill unless overridden by the Override Mailing Name.Example:Brazil,Mary
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
accountInformation: object
accountInformation
-
accountPersons: object
accountPersons
-
customerClass: object
customerClass
-
division: object
division
-
premiseCount: string
Maximum Length:
5
Premise Count for the Account -
premiseInformation: object
premiseInformation
Nested Schema : account
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:0279948222
Nested Schema : accountInformation
Type:
Show Source
object
-
info: string
Maximum Length:
254
Account Info displays information associated with an Account.Example:Brazil,Mark, Residential, $19,247.81
-
primaryText: string
(primaryText)
-
secondaryText: string
(secondaryText)
-
tertiaryText: string
(tertiaryText)
Nested Schema : customerClass
Type:
Show Source
object
-
customerClass: string
Customer Class controls financial parameters related to billing and collections and is required on an account.Example:
R
-
description: string
(description)
Nested Schema : division
Type:
Show Source
object
-
description: string
(description)
-
division: string
Maximum Length:
5
CIS Division
Nested Schema : premiseInformation
Type:
Show Source
object
-
info: string
Maximum Length:
254
Premise Info -
primaryText: string
(primaryText)
-
secondaryText: string
(secondaryText)
-
tertiaryText: string
(tertiaryText)
Nested Schema : items
Type:
Show Source
object
-
accountRelationshipType: object
accountRelationshipType
-
isFinanciallyResponsible: boolean
Financially Responsible switch is on if the person is financially responsible for the account's debt.Example:
true
-
isMainCustomer: boolean
Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.Example:
false
-
person: object
person
-
personInformation: object
personInformation
-
primaryName: string
Maximum Length:
254
A person's primary name is the addressee on the person's bill unless overridden by the Override Mailing Name.Example:Brazil,Mary
Nested Schema : accountRelationshipType
Type:
Show Source
object
-
accountRelationshipType: string
Maximum Length:
8
Account Relationship Type -
description: string
(description)
Nested Schema : person
Type:
Show Source
object
-
personId: string
Maximum Length:
10
Person ID is the system-assigned number for other persons related to the account.Example:4429925678
Nested Schema : personInformation
Type:
Show Source
object
-
info: string
Maximum Length:
254
Person Info -
primaryText: string
(primaryText)
-
secondaryText: string
(secondaryText)
-
tertiaryText: string
(tertiaryText)
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.