Jump to

• Request
• Response

Person Search

post

/rest/apis/customer/v-model/persons/search

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: object filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"Account ID filter to return all persons linked to Account regardless of relationship.",
                    "example":"0757774590"
                },
                "nameSearch":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Name"
                },
                "identifierType":{
                    "type":"string",
                    "maxLength":"8",
                    "description":"ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).",
                    "example":"DL"
                },
                "identifierValue":{
                    "type":"string",
                    "maxLength":"100",
                    "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
                    "example":"*****560"
                },
                "emailSearch":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Email search filter to return all emails on the Person and return value that matched",
                    "example":"[e-mail]"
                }
            }
        }
    },
    "xml":{
        "name":"C1PerSearch"
    }
}

Nested Schema : filters

Type: object

Show Source

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

  Example: [e-mail]
• 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

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID filter to return all persons linked to Account regardless of relationship.",
            "example":"0757774590"
        },
        "nameSearch":{
            "type":"string",
            "maxLength":"254",
            "description":"Name"
        },
        "identifierType":{
            "type":"string",
            "maxLength":"8",
            "description":"ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).",
            "example":"DL"
        },
        "identifierValue":{
            "type":"string",
            "maxLength":"100",
            "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
            "example":"*****560"
        },
        "emailSearch":{
            "type":"string",
            "maxLength":"254",
            "description":"Email search filter to return all emails on the Person and return value that matched",
            "example":"[e-mail]"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filters: object filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"Account ID filter to return all persons linked to Account regardless of relationship.",
                    "example":"0757774590"
                },
                "nameSearch":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Name"
                },
                "identifierType":{
                    "type":"string",
                    "maxLength":"8",
                    "description":"ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).",
                    "example":"DL"
                },
                "identifierValue":{
                    "type":"string",
                    "maxLength":"100",
                    "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
                    "example":"*****560"
                },
                "emailSearch":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Email search filter to return all emails on the Person and return value that matched",
                    "example":"[e-mail]"
                }
            }
        }
    },
    "xml":{
        "name":"C1PerSearch"
    }
}

Nested Schema : filters

Type: object

Show Source

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

  Example: [e-mail]
• 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

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID filter to return all persons linked to Account regardless of relationship.",
            "example":"0757774590"
        },
        "nameSearch":{
            "type":"string",
            "maxLength":"254",
            "description":"Name"
        },
        "identifierType":{
            "type":"string",
            "maxLength":"8",
            "description":"ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).",
            "example":"DL"
        },
        "identifierValue":{
            "type":"string",
            "maxLength":"100",
            "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
            "example":"*****560"
        },
        "emailSearch":{
            "type":"string",
            "maxLength":"254",
            "description":"Email search filter to return all emails on the Person and return value that matched",
            "example":"[e-mail]"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1PerSearch

Type: object

Show Source

• persons: array persons
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

  Example: 10

{
    "type":"object",
    "properties":{
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Total Number Of Records",
            "example":"10"
        },
        "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":"5775933103"
                    },
                    "personOrBusiness":{
                        "type":"string",
                        "enum":[
                            "B   ",
                            "P   "
                        ],
                        "description":"Person/Business indicates if the entity is a person or a business. This value controls how the person's primary name is validated.\n* `B   ` - Business,\n* `P   ` - Person"
                    },
                    "name":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Name"
                    },
                    "identifierType":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).",
                        "example":"DL"
                    },
                    "identifierTypeDescription":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Description for ID Type.",
                        "example":"Social Security Number"
                    },
                    "identifier":{
                        "type":"string",
                        "maxLength":"100",
                        "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
                        "example":"*****560"
                    },
                    "email":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Email search filter to return all emails on the Person and return value that matched",
                        "example":"[e-mail]"
                    },
                    "mainCustomer":{
                        "type":"boolean",
                        "description":"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"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PerSearch"
    }
}

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":"5775933103"
            },
            "personOrBusiness":{
                "type":"string",
                "enum":[
                    "B   ",
                    "P   "
                ],
                "description":"Person/Business indicates if the entity is a person or a business. This value controls how the person's primary name is validated.\n* `B   ` - Business,\n* `P   ` - Person"
            },
            "name":{
                "type":"string",
                "maxLength":"254",
                "description":"Name"
            },
            "identifierType":{
                "type":"string",
                "maxLength":"8",
                "description":"ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).",
                "example":"DL"
            },
            "identifierTypeDescription":{
                "type":"string",
                "maxLength":"30",
                "description":"Description for ID Type.",
                "example":"Social Security Number"
            },
            "identifier":{
                "type":"string",
                "maxLength":"100",
                "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
                "example":"*****560"
            },
            "email":{
                "type":"string",
                "maxLength":"254",
                "description":"Email search filter to return all emails on the Person and return value that matched",
                "example":"[e-mail]"
            },
            "mainCustomer":{
                "type":"boolean",
                "description":"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"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• email: string
  Maximum Length: 254

  Email search filter to return all emails on the Person and return value that matched

  Example: [e-mail]
• 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

{
    "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":"5775933103"
        },
        "personOrBusiness":{
            "type":"string",
            "enum":[
                "B   ",
                "P   "
            ],
            "description":"Person/Business indicates if the entity is a person or a business. This value controls how the person's primary name is validated.\n* `B   ` - Business,\n* `P   ` - Person"
        },
        "name":{
            "type":"string",
            "maxLength":"254",
            "description":"Name"
        },
        "identifierType":{
            "type":"string",
            "maxLength":"8",
            "description":"ID Type indicates the type of identification and defaults from the Installation Record based on the Person Type (Person versus Business).",
            "example":"DL"
        },
        "identifierTypeDescription":{
            "type":"string",
            "maxLength":"30",
            "description":"Description for ID Type.",
            "example":"Social Security Number"
        },
        "identifier":{
            "type":"string",
            "maxLength":"100",
            "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
            "example":"*****560"
        },
        "email":{
            "type":"string",
            "maxLength":"254",
            "description":"Email search filter to return all emails on the Person and return value that matched",
            "example":"[e-mail]"
        },
        "mainCustomer":{
            "type":"boolean",
            "description":"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"
        }
    }
}

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