Jump to

• Request
• Response

Business Person Search

post

https://server:port/spl/rest/apis/cross/v-model/businessPersonQueries/personSearch

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

• filter: object filter
• persons: array persons

{
    "type":"object",
    "properties":{
        "filter":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                },
                "premiseAddress":{
                    "type":"string",
                    "maxLength":150,
                    "description":"Address"
                },
                "restrictToPersons":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "externalId":{
                                "type":"string",
                                "maxLength":60,
                                "description":"External Party ID in a CX/CRM application",
                                "example":"CDRM_952287"
                            },
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                                "example":"7713248626"
                            }
                        }
                    }
                }
            }
        },
        "persons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"7713248626"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External Party ID in a CX/CRM application",
                        "example":"CDRM_952287"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1BUSPERSRCH"
    }
}

Nested Schema : filter

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• premiseAddress: string
  Maximum Length: 150

  Address
• restrictToPersons: array restrictToPersons

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "premiseAddress":{
            "type":"string",
            "maxLength":150,
            "description":"Address"
        },
        "restrictToPersons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External Party ID in a CX/CRM application",
                        "example":"CDRM_952287"
                    },
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"7713248626"
                    }
                }
            }
        }
    }
}

Nested Schema : persons

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"7713248626"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External Party ID in a CX/CRM application",
                "example":"CDRM_952287"
            }
        }
    }
}

Nested Schema : restrictToPersons

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External Party ID in a CX/CRM application",
                "example":"CDRM_952287"
            },
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"7713248626"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External Party ID in a CX/CRM application

  Example: CDRM_952287
• 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: 7713248626

{
    "type":"object",
    "properties":{
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External Party ID in a CX/CRM application",
            "example":"CDRM_952287"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"7713248626"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External Party ID in a CX/CRM application

  Example: CDRM_952287
• 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: 7713248626

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"7713248626"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External Party ID in a CX/CRM application",
            "example":"CDRM_952287"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filter: object filter
• persons: array persons

{
    "type":"object",
    "properties":{
        "filter":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                },
                "premiseAddress":{
                    "type":"string",
                    "maxLength":150,
                    "description":"Address"
                },
                "restrictToPersons":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "externalId":{
                                "type":"string",
                                "maxLength":60,
                                "description":"External Party ID in a CX/CRM application",
                                "example":"CDRM_952287"
                            },
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                                "example":"7713248626"
                            }
                        }
                    }
                }
            }
        },
        "persons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"7713248626"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External Party ID in a CX/CRM application",
                        "example":"CDRM_952287"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1BUSPERSRCH"
    }
}

Nested Schema : filter

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• premiseAddress: string
  Maximum Length: 150

  Address
• restrictToPersons: array restrictToPersons

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "premiseAddress":{
            "type":"string",
            "maxLength":150,
            "description":"Address"
        },
        "restrictToPersons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External Party ID in a CX/CRM application",
                        "example":"CDRM_952287"
                    },
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"7713248626"
                    }
                }
            }
        }
    }
}

Nested Schema : persons

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"7713248626"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External Party ID in a CX/CRM application",
                "example":"CDRM_952287"
            }
        }
    }
}

Nested Schema : restrictToPersons

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External Party ID in a CX/CRM application",
                "example":"CDRM_952287"
            },
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"7713248626"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External Party ID in a CX/CRM application

  Example: CDRM_952287
• 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: 7713248626

{
    "type":"object",
    "properties":{
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External Party ID in a CX/CRM application",
            "example":"CDRM_952287"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"7713248626"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External Party ID in a CX/CRM application

  Example: CDRM_952287
• 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: 7713248626

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"7713248626"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External Party ID in a CX/CRM application",
            "example":"CDRM_952287"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1BUSPERSRCH

Type: object

Show Source

• filter: object filter
• persons: array persons

{
    "type":"object",
    "properties":{
        "filter":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                },
                "premiseAddress":{
                    "type":"string",
                    "maxLength":150,
                    "description":"Address"
                },
                "restrictToPersons":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "externalId":{
                                "type":"string",
                                "maxLength":60,
                                "description":"External Party ID in a CX/CRM application",
                                "example":"CDRM_952287"
                            },
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                                "example":"7713248626"
                            }
                        }
                    }
                }
            }
        },
        "persons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"7713248626"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External Party ID in a CX/CRM application",
                        "example":"CDRM_952287"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1BUSPERSRCH"
    }
}

Nested Schema : filter

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• premiseAddress: string
  Maximum Length: 150

  Address
• restrictToPersons: array restrictToPersons

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "premiseAddress":{
            "type":"string",
            "maxLength":150,
            "description":"Address"
        },
        "restrictToPersons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External Party ID in a CX/CRM application",
                        "example":"CDRM_952287"
                    },
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"7713248626"
                    }
                }
            }
        }
    }
}

Nested Schema : persons

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"7713248626"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External Party ID in a CX/CRM application",
                "example":"CDRM_952287"
            }
        }
    }
}

Nested Schema : restrictToPersons

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External Party ID in a CX/CRM application",
                "example":"CDRM_952287"
            },
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"7713248626"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External Party ID in a CX/CRM application

  Example: CDRM_952287
• 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: 7713248626

{
    "type":"object",
    "properties":{
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External Party ID in a CX/CRM application",
            "example":"CDRM_952287"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"7713248626"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External Party ID in a CX/CRM application

  Example: CDRM_952287
• 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: 7713248626

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"7713248626"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External Party ID in a CX/CRM application",
            "example":"CDRM_952287"
        }
    }
}

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