Person Search
/rest/apis/customer/v-model/personSearch/
Request
There are no request parameters for this operation.
- application/xml
- application/json
object
-
filters: array
filters
The search operation supports a single filter only of the following types:
By Account ID. Finds business or person records associated with the specified account.
By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
Only active accounts are considered or premises that are not associated with any active account.By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
Only active accounts are considered or premises that are not associated with any active account.By Person Identifier. Finds person or business records associated with a specific type of person identifier.
This option requires the type of ID to be specified as the filter's class.By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
This option requires the type of geographic attribute to be specified as the filter's class.
Only active accounts are considered or premises that are not associated with any active account. -
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page LimitExample:3
-
restrictedIds: array
restrictedIds
The search may be restricted to a specific list of business records. Each record is identified either by its internal key or by an external identifier, i.e. Fusion's "Party Number".
array
By Account ID. Finds business or person records associated with the specified account.
By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
Only active accounts are considered or premises that are not associated with any active account.
By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
Only active accounts are considered or premises that are not associated with any active account.
By Person Identifier. Finds person or business records associated with a specific type of person identifier.
This option requires the type of ID to be specified as the filter's class.
By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
This option requires the type of geographic attribute to be specified as the filter's class.
Only active accounts are considered or premises that are not associated with any active account.
array
object
-
class: string
Maximum Length:
60
A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.Example:SSN
-
name: string
Allowed Values:
[ "C1AC", "C1AS", "C1BN", "C1GE", "C1ID", "C1LA" ]
The Person search operation supports a single filter of following types: By Account ID. Finds business or person records associated with the specified account. By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. By Person Identifier. Finds person or business records associated with a specific type of person identifier. By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points. By Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number. Only active accounts are considered. * `C1AC` - Account, * `C1AS` - Service Address, * `C1BN` - Badge Number, * `C1GE` - Geographic Value, * `C1ID` - Personal Identifier, * `C1LA` - Legacy Account NumberExample:C1ID
-
value: string
Maximum Length:
4
Value for Person Search filter type, such as, Account, Service Address, Geographic Value, Legacy Account Number and Personal Identifier.Example:222-33-6668
object
-
externalId: string
Maximum Length:
60
External ID -
personId: string
Maximum Length:
10
Person IDExample:0023939882
object
-
filters: array
filters
The search operation supports a single filter only of the following types:
By Account ID. Finds business or person records associated with the specified account.
By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
Only active accounts are considered or premises that are not associated with any active account.By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
Only active accounts are considered or premises that are not associated with any active account.By Person Identifier. Finds person or business records associated with a specific type of person identifier.
This option requires the type of ID to be specified as the filter's class.By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
This option requires the type of geographic attribute to be specified as the filter's class.
Only active accounts are considered or premises that are not associated with any active account. -
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page LimitExample:3
-
restrictedIds: array
restrictedIds
The search may be restricted to a specific list of business records. Each record is identified either by its internal key or by an external identifier, i.e. Fusion's "Party Number".
array
By Account ID. Finds business or person records associated with the specified account.
By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
Only active accounts are considered or premises that are not associated with any active account.
By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
Only active accounts are considered or premises that are not associated with any active account.
By Person Identifier. Finds person or business records associated with a specific type of person identifier.
This option requires the type of ID to be specified as the filter's class.
By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
This option requires the type of geographic attribute to be specified as the filter's class.
Only active accounts are considered or premises that are not associated with any active account.
array
object
-
class: string
Maximum Length:
60
A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.Example:SSN
-
name: string
Allowed Values:
[ "C1AC", "C1AS", "C1BN", "C1GE", "C1ID", "C1LA" ]
The Person search operation supports a single filter of following types: By Account ID. Finds business or person records associated with the specified account. By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. By Person Identifier. Finds person or business records associated with a specific type of person identifier. By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points. By Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number. Only active accounts are considered. * `C1AC` - Account, * `C1AS` - Service Address, * `C1BN` - Badge Number, * `C1GE` - Geographic Value, * `C1ID` - Personal Identifier, * `C1LA` - Legacy Account NumberExample:C1ID
-
value: string
Maximum Length:
4
Value for Person Search filter type, such as, Account, Service Address, Geographic Value, Legacy Account Number and Personal Identifier.Example:222-33-6668
object
-
externalId: string
Maximum Length:
60
External ID -
personId: string
Maximum Length:
10
Person IDExample:0023939882
Response
- application/xml
- application/json
200 Response
object
-
accounts: array
accounts
-
externalId: string
Maximum Length:
60
External ID -
personId: string
Maximum Length:
10
Person IDExample:0023939882
-
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Defines the person entity as a person or business, which controls validation of the person entity's primary name. * `B ` - Business, * `P ` - PersonExample:P
-
premises: array
premises
-
primaryIdentifier: string
Maximum Length:
100
The value for the Primary Identifier Type that identifies a person or business.Example:***-**-1844
-
primaryIdentifierType: string
Maximum Length:
8
Primary Identifier Type for a person.Example:SSN
-
primaryIdentifierTypeDescription: string
Maximum Length:
1
Description for Primary Identifier Type for a person.Example:Social Security Number
-
recordType: string
Maximum Length:
1
Record Type
object
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:0119532152
-
accountRelationshipType: string
Maximum Length:
8
Relationship Type defines the relationship between the person and the account.Example:MAIN
-
accountRelationshipTypeDescription: string
Maximum Length:
1
Display string for relationship the input person has with the Billing Account.Example:Main customer
-
cisDivision: string
Maximum Length:
5
CIS Division defines the jurisdiction that governs an account.Example:CA
-
cisDivisionDescription: string
Maximum Length:
1
Descriptive information for the division label.Example:California
-
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
-
premises: array
premises
object
-
formattedAddress: string
Maximum Length:
254
The mailing address for the primary premise associated with the service agreement.Example:129 Sutter St, San Francisco, CA, 94104
-
premiseId: string
Maximum Length:
10
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.Example:3836403369
object
-
formattedAddress: string
Maximum Length:
254
The mailing address for the primary premise associated with the service agreement.Example:129 Sutter St, San Francisco, CA, 94104
-
premiseId: string
Maximum Length:
10
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.Example:3836403369
400 Response
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.
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
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.
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.