Business Search
/rest/apis/customer/v-model/businessSearch/
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 records associated with the specified account.
By Service Address. Finds business 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.
-
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 Service Address. Finds business 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.
array
object
-
name: string
Allowed Values:
[ "C1AC", "C1AS" ]
The Business Search operation supports a single filter of following types: By Account ID. Finds business records associated with the specified account. By Service Address. Finds business 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. * `C1AC` - Account, * `C1AS` - Service AddressExample:C1AC
-
value: string
Maximum Length:
4
Value for Business Search filter type i.e. Account and Service Address.Example:8365153700
object
-
externalId: string
Maximum Length:
60
Fusion's "Party Number" for the business record. -
personId: string
Maximum Length:
10
Person IDExample:4002221188
object
-
filters: array
filters
The search operation supports a single filter only of the following types: By Account ID. Finds business records associated with the specified account.
By Service Address. Finds business 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.
-
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 Service Address. Finds business 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.
array
object
-
name: string
Allowed Values:
[ "C1AC", "C1AS" ]
The Business Search operation supports a single filter of following types: By Account ID. Finds business records associated with the specified account. By Service Address. Finds business 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. * `C1AC` - Account, * `C1AS` - Service AddressExample:C1AC
-
value: string
Maximum Length:
4
Value for Business Search filter type i.e. Account and Service Address.Example:8365153700
object
-
externalId: string
Maximum Length:
60
Fusion's "Party Number" for the business record. -
personId: string
Maximum Length:
10
Person IDExample:4002221188
Response
- application/xml
- application/json
200 Response
object
-
externalId: string
Maximum Length:
60
Fusion's "Party Number" for the business record. -
personId: string
Maximum Length:
10
Person IDExample:4002221188
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.