Jump to

• Request
• Response

Business Search

post

https://server:port/spl/rest/apis/customer/v-model/businessSearch/

This operation is used to find business person records based on specific filters i.e. Account ID and Service Address.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• 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 Limit

  Example: 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".

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"array",
            "description":"The search operation supports a single filter only of the following types:\n\nBy Account ID. Finds business records associated with the specified account.  <p>\nBy 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. <p>\n\nOnly active accounts are considered.",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1AS"
                        ],
                        "description":"The Business Search operation supports a single filter of following types:\n\nBy Account ID. Finds business records associated with the specified account.\n\nBy 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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address",
                        "example":"C1AC"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Value for Business Search filter type i.e. Account and Service Address.",
                        "example":"8365153700"
                    }
                }
            }
        },
        "restrictedIds":{
            "type":"array",
            "description":"The search may be restricted to a specific list of business records. \n\nEach record is identified either by its internal key or by an external identifier, i.e. Fusion's \"Party Number\".",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID",
                        "example":"4002221188"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Fusion's \"Party Number\" for the business record."
                    }
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Limit",
            "example":"3"
        }
    },
    "xml":{
        "name":"C1BusinSrch"
    }
}

Nested Schema : filters

Type: array

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.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The search operation supports a single filter only of the following types:\n\nBy Account ID. Finds business records associated with the specified account.  <p>\nBy 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. <p>\n\nOnly active accounts are considered.",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1AS"
                ],
                "description":"The Business Search operation supports a single filter of following types:\n\nBy Account ID. Finds business records associated with the specified account.\n\nBy 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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address",
                "example":"C1AC"
            },
            "value":{
                "type":"string",
                "maxLength":4,
                "description":"Value for Business Search filter type i.e. Account and Service Address.",
                "example":"8365153700"
            }
        }
    }
}

Nested Schema : restrictedIds

Type: array

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".

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The search may be restricted to a specific list of business records. \n\nEach record is identified either by its internal key or by an external identifier, i.e. Fusion's \"Party Number\".",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID",
                "example":"4002221188"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"Fusion's \"Party Number\" for the business record."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 Address

  Example: C1AC
• value: string
  Maximum Length: 4

  Value for Business Search filter type i.e. Account and Service Address.

  Example: 8365153700

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1AS"
            ],
            "description":"The Business Search operation supports a single filter of following types:\n\nBy Account ID. Finds business records associated with the specified account.\n\nBy 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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address",
            "example":"C1AC"
        },
        "value":{
            "type":"string",
            "maxLength":4,
            "description":"Value for Business Search filter type i.e. Account and Service Address.",
            "example":"8365153700"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  Fusion's "Party Number" for the business record.
• personId: string
  Maximum Length: 10

  Person ID

  Example: 4002221188

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"4002221188"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Fusion's \"Party Number\" for the business record."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 Limit

  Example: 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".

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"array",
            "description":"The search operation supports a single filter only of the following types:\n\nBy Account ID. Finds business records associated with the specified account.  <p>\nBy 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. <p>\n\nOnly active accounts are considered.",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1AS"
                        ],
                        "description":"The Business Search operation supports a single filter of following types:\n\nBy Account ID. Finds business records associated with the specified account.\n\nBy 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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address",
                        "example":"C1AC"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Value for Business Search filter type i.e. Account and Service Address.",
                        "example":"8365153700"
                    }
                }
            }
        },
        "restrictedIds":{
            "type":"array",
            "description":"The search may be restricted to a specific list of business records. \n\nEach record is identified either by its internal key or by an external identifier, i.e. Fusion's \"Party Number\".",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID",
                        "example":"4002221188"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Fusion's \"Party Number\" for the business record."
                    }
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Limit",
            "example":"3"
        }
    },
    "xml":{
        "name":"C1BusinSrch"
    }
}

Nested Schema : filters

Type: array

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.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The search operation supports a single filter only of the following types:\n\nBy Account ID. Finds business records associated with the specified account.  <p>\nBy 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. <p>\n\nOnly active accounts are considered.",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1AS"
                ],
                "description":"The Business Search operation supports a single filter of following types:\n\nBy Account ID. Finds business records associated with the specified account.\n\nBy 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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address",
                "example":"C1AC"
            },
            "value":{
                "type":"string",
                "maxLength":4,
                "description":"Value for Business Search filter type i.e. Account and Service Address.",
                "example":"8365153700"
            }
        }
    }
}

Nested Schema : restrictedIds

Type: array

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".

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The search may be restricted to a specific list of business records. \n\nEach record is identified either by its internal key or by an external identifier, i.e. Fusion's \"Party Number\".",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID",
                "example":"4002221188"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"Fusion's \"Party Number\" for the business record."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 Address

  Example: C1AC
• value: string
  Maximum Length: 4

  Value for Business Search filter type i.e. Account and Service Address.

  Example: 8365153700

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1AS"
            ],
            "description":"The Business Search operation supports a single filter of following types:\n\nBy Account ID. Finds business records associated with the specified account.\n\nBy 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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address",
            "example":"C1AC"
        },
        "value":{
            "type":"string",
            "maxLength":4,
            "description":"Value for Business Search filter type i.e. Account and Service Address.",
            "example":"8365153700"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  Fusion's "Party Number" for the business record.
• personId: string
  Maximum Length: 10

  Person ID

  Example: 4002221188

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"4002221188"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Fusion's \"Party Number\" for the business record."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1BusinSrch

Type: object

Show Source

• customers: array customers

{
    "type":"object",
    "properties":{
        "customers":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID",
                        "example":"4002221188"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Fusion's \"Party Number\" for the business record."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1BusinSrch"
    }
}

Nested Schema : customers

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID",
                "example":"4002221188"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"Fusion's \"Party Number\" for the business record."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  Fusion's "Party Number" for the business record.
• personId: string
  Maximum Length: 10

  Person ID

  Example: 4002221188

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"4002221188"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Fusion's \"Party Number\" for the business record."
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top