Person Search
post
https://server:port/spl/rest/apis/customer/v-model/persons/search
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : filters
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID filter to return all persons linked to Account regardless of relationship.Example:0757774590
-
emailSearch: string
Maximum Length:
254
Email search filter to return all emails on the Person and return value that matchedExample:pat.dowd@oracle.com
-
identifierType: string
Maximum Length:
8
ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).Example:DL
-
identifierValue: string
Maximum Length:
100
The unique Identification Number assigned to an individual person or business by a government agency or any other authority.Example:*****560
-
nameSearch: string
Maximum Length:
254
Name
Nested Schema : filters
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID filter to return all persons linked to Account regardless of relationship.Example:0757774590
-
emailSearch: string
Maximum Length:
254
Email search filter to return all emails on the Person and return value that matchedExample:pat.dowd@oracle.com
-
identifierType: string
Maximum Length:
8
ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).Example:DL
-
identifierValue: string
Maximum Length:
100
The unique Identification Number assigned to an individual person or business by a government agency or any other authority.Example:*****560
-
nameSearch: string
Maximum Length:
254
Name
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1PerSearch
Type:
Show Source
object
-
persons: array
persons
-
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of RecordsExample:10
Nested Schema : items
Type:
Show Source
object
-
email: string
Maximum Length:
254
Email search filter to return all emails on the Person and return value that matchedExample:pat.dowd@oracle.com
-
identifier: string
Maximum Length:
100
The unique Identification Number assigned to an individual person or business by a government agency or any other authority.Example:*****560
-
identifierType: string
Maximum Length:
8
ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).Example:DL
-
identifierTypeDescription: string
Maximum Length:
30
Description for ID Type.Example:Social Security Number
-
mainCustomer: boolean
Main Customer is defined as true if the person is the main customer on the account. Only one person on an account can be designated as the main customer.Example:
false
-
name: string
Maximum Length:
254
Name -
personId: string
Maximum Length:
10
Person ID is a system-assigned random number that stays with a person for the life of the system.Example:5775933103
-
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Person/Business indicates if the entity is a person or a business. This value controls how the person's primary name is validated. * `B ` - Business, * `P ` - Person
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.