Jump to

• Request
• Response

Person Search

post

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

This operation is used by the CX4U Customer List agent page to find person or business records based on specific filters. The response includes the list of active accounts and premises associated with each matching record.

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 or person records associated with the specified account.

  By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
  Only active accounts are considered or premises that are not associated with any active account.

  By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
  Only active accounts are considered or premises that are not associated with any active account.

  By Person Identifier. Finds person or business records associated with a specific type of person identifier.
  This option requires the type of ID to be specified as the filter's class.

  By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
  Only active accounts are considered.

  By Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.

• 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<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1AS",
                            "C1BN",
                            "C1GE",
                            "C1ID",
                            "C1LA"
                        ],
                        "description":"The Person search operation supports a single filter only of the following types: \n<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1BN` - Badge Number,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier,\n* `C1LA` - Legacy Account Number",
                        "example":"C1ID"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value , legacy Account Number and Personal Identifier.",
                        "example":"222-33-6668"
                    },
                    "class":{
                        "type":"string",
                        "maxLength":60,
                        "description":"A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.",
                        "example":"SSN"
                    }
                }
            }
        },
        "restrictedIds":{
            "type":"array",
            "description":"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\".",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID",
                        "example":"0023939882"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External ID"
                    }
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Limit",
            "example":"3"
        }
    },
    "xml":{
        "name":"C1PersonSrch"
    }
}

Nested Schema : filters

Type: array

The search operation supports a single filter only of the following types:

By Account ID. Finds business or person records associated with the specified account.

By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
Only active accounts are considered or premises that are not associated with any active account.

By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
Only active accounts are considered or premises that are not associated with any active account.

By Person Identifier. Finds person or business records associated with a specific type of person identifier.
This option requires the type of ID to be specified as the filter's class.

By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
Only active accounts are considered.

By Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The search operation supports a single filter only of the following types: \n<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1AS",
                    "C1BN",
                    "C1GE",
                    "C1ID",
                    "C1LA"
                ],
                "description":"The Person search operation supports a single filter only of the following types: \n<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1BN` - Badge Number,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier,\n* `C1LA` - Legacy Account Number",
                "example":"C1ID"
            },
            "value":{
                "type":"string",
                "maxLength":4,
                "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value , legacy Account Number and Personal Identifier.",
                "example":"222-33-6668"
            },
            "class":{
                "type":"string",
                "maxLength":60,
                "description":"A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.",
                "example":"SSN"
            }
        }
    }
}

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. Each 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":"0023939882"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• class: string
  Maximum Length: 60

  A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.

  Example: SSN
• name: string
  Allowed Values: [ "C1AC", "C1AS", "C1BN", "C1GE", "C1ID", "C1LA" ]

  The Person search operation supports a single filter only of the following types:

  By Account ID. Finds business or person records associated with the specified account.

  By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
  Only active accounts are considered or premises that are not associated with any active account.

  By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
  Only active accounts are considered or premises that are not associated with any active account.

  By Person Identifier. Finds person or business records associated with a specific type of person identifier.
  This option requires the type of ID to be specified as the filter's class.

  By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
  Only active accounts are considered.

  By Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number. * `C1AC` - Account, * `C1AS` - Service Address, * `C1BN` - Badge Number, * `C1GE` - Geographic Value, * `C1ID` - Personal Identifier, * `C1LA` - Legacy Account Number

  Example: C1ID
• value: string
  Maximum Length: 4

  Value for Person Search filter type i.e. Account, Service Address, Geographic Value , legacy Account Number and Personal Identifier.

  Example: 222-33-6668

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1AS",
                "C1BN",
                "C1GE",
                "C1ID",
                "C1LA"
            ],
            "description":"The Person search operation supports a single filter only of the following types: \n<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1BN` - Badge Number,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier,\n* `C1LA` - Legacy Account Number",
            "example":"C1ID"
        },
        "value":{
            "type":"string",
            "maxLength":4,
            "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value , legacy Account Number and Personal Identifier.",
            "example":"222-33-6668"
        },
        "class":{
            "type":"string",
            "maxLength":60,
            "description":"A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.",
            "example":"SSN"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External ID
• personId: string
  Maximum Length: 10

  Person ID

  Example: 0023939882

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"0023939882"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID"
        }
    }
}

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 or person records associated with the specified account.

  By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
  Only active accounts are considered or premises that are not associated with any active account.

  By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
  Only active accounts are considered or premises that are not associated with any active account.

  By Person Identifier. Finds person or business records associated with a specific type of person identifier.
  This option requires the type of ID to be specified as the filter's class.

  By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
  Only active accounts are considered.

  By Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.

• 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<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1AS",
                            "C1BN",
                            "C1GE",
                            "C1ID",
                            "C1LA"
                        ],
                        "description":"The Person search operation supports a single filter only of the following types: \n<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1BN` - Badge Number,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier,\n* `C1LA` - Legacy Account Number",
                        "example":"C1ID"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value , legacy Account Number and Personal Identifier.",
                        "example":"222-33-6668"
                    },
                    "class":{
                        "type":"string",
                        "maxLength":60,
                        "description":"A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.",
                        "example":"SSN"
                    }
                }
            }
        },
        "restrictedIds":{
            "type":"array",
            "description":"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\".",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID",
                        "example":"0023939882"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External ID"
                    }
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Page Limit",
            "example":"3"
        }
    },
    "xml":{
        "name":"C1PersonSrch"
    }
}

Nested Schema : filters

Type: array

The search operation supports a single filter only of the following types:

By Account ID. Finds business or person records associated with the specified account.

By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
Only active accounts are considered or premises that are not associated with any active account.

By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
Only active accounts are considered or premises that are not associated with any active account.

By Person Identifier. Finds person or business records associated with a specific type of person identifier.
This option requires the type of ID to be specified as the filter's class.

By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
Only active accounts are considered.

By Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The search operation supports a single filter only of the following types: \n<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1AS",
                    "C1BN",
                    "C1GE",
                    "C1ID",
                    "C1LA"
                ],
                "description":"The Person search operation supports a single filter only of the following types: \n<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1BN` - Badge Number,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier,\n* `C1LA` - Legacy Account Number",
                "example":"C1ID"
            },
            "value":{
                "type":"string",
                "maxLength":4,
                "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value , legacy Account Number and Personal Identifier.",
                "example":"222-33-6668"
            },
            "class":{
                "type":"string",
                "maxLength":60,
                "description":"A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.",
                "example":"SSN"
            }
        }
    }
}

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. Each 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":"0023939882"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• class: string
  Maximum Length: 60

  A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.

  Example: SSN
• name: string
  Allowed Values: [ "C1AC", "C1AS", "C1BN", "C1GE", "C1ID", "C1LA" ]

  The Person search operation supports a single filter only of the following types:

  By Account ID. Finds business or person records associated with the specified account.

  By Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified.
  Only active accounts are considered or premises that are not associated with any active account.

  By Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location.
  Only active accounts are considered or premises that are not associated with any active account.

  By Person Identifier. Finds person or business records associated with a specific type of person identifier.
  This option requires the type of ID to be specified as the filter's class.

  By Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.
  Only active accounts are considered.

  By Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number. * `C1AC` - Account, * `C1AS` - Service Address, * `C1BN` - Badge Number, * `C1GE` - Geographic Value, * `C1ID` - Personal Identifier, * `C1LA` - Legacy Account Number

  Example: C1ID
• value: string
  Maximum Length: 4

  Value for Person Search filter type i.e. Account, Service Address, Geographic Value , legacy Account Number and Personal Identifier.

  Example: 222-33-6668

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1AS",
                "C1BN",
                "C1GE",
                "C1ID",
                "C1LA"
            ],
            "description":"The Person search operation supports a single filter only of the following types: \n<p>\nBy Account ID. Finds business or person records associated with the specified account. \n<p>\nBy Service Address. Finds business or person records associated with a service location's address, either via premise address or alternate premise address. The filter value allows for partial address text to be specified. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Badge Number. Finds business or person records associated with the badge number of a device currently installed at a service location. <br>\nOnly active accounts are considered or premises that are not associated with any active account.\n<p>\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier. <br>\nThis option requires the type of ID to be specified as the filter's class.\n<p>\nBy Geographic Value. Finds person or business records associated with a specific type of a geographic attribute associated with the service location's premise or service points.<br>\nOnly active accounts are considered.\n<p>\nBy Legacy Account Number. Finds all accounts and persons associated with the service agreement stamped with the specified legacy account number.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1BN` - Badge Number,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier,\n* `C1LA` - Legacy Account Number",
            "example":"C1ID"
        },
        "value":{
            "type":"string",
            "maxLength":4,
            "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value , legacy Account Number and Personal Identifier.",
            "example":"222-33-6668"
        },
        "class":{
            "type":"string",
            "maxLength":60,
            "description":"A specific class of a filter name. For example, when filtering by a personal identification document then the class is a specific ID type.",
            "example":"SSN"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External ID
• personId: string
  Maximum Length: 10

  Person ID

  Example: 0023939882

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"0023939882"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1PersonSrch

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":"0023939882"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External ID"
                    },
                    "personOrBusiness":{
                        "type":"string",
                        "enum":[
                            "B   ",
                            "P   "
                        ],
                        "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                        "example":"P"
                    },
                    "primaryIdentifierType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Primary Identifier Type for a person or business.",
                        "example":"SSN"
                    },
                    "primaryIdentifierTypeDescription":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Description for Primary Identifier Type for a person or business.",
                        "example":"Social Security Number"
                    },
                    "primaryIdentifier":{
                        "type":"string",
                        "maxLength":100,
                        "description":"The value for the Primary Identifier Type that identifies a person or business.",
                        "example":"***-**-1844"
                    },
                    "recordType":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Record Type"
                    },
                    "accounts":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "accountId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Account ID identifies the customer who is responsible for the bill.",
                                    "example":"0119532152"
                                },
                                "cisDivision":{
                                    "type":"string",
                                    "maxLength":5,
                                    "description":"CIS Division defines the jurisdiction that governs an account.",
                                    "example":"CA"
                                },
                                "cisDivisionDescription":{
                                    "type":"string",
                                    "maxLength":1,
                                    "description":"Descriptive information for the division label.",
                                    "example":"California"
                                },
                                "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"
                                },
                                "accountRelationshipType":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Relationship Type defines the relationship between the person and the account.",
                                    "example":"MAIN"
                                },
                                "accountRelationshipTypeDescription":{
                                    "type":"string",
                                    "maxLength":1,
                                    "description":"Display string for relationship the input person has with the Billing Account.",
                                    "example":"Main customer"
                                },
                                "premises":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "premiseId":{
                                                "type":"string",
                                                "maxLength":10,
                                                "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                                                "example":"3836403369"
                                            },
                                            "formattedAddress":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"The mailing address for the primary premise associated with the service agreement.",
                                                "example":"129 Sutter St, San Francisco, CA, 94104"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "premises":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "premiseId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                                    "example":"3836403369"
                                },
                                "formattedAddress":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The mailing address for the primary premise associated with the service agreement.",
                                    "example":"129 Sutter St, San Francisco, CA, 94104"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PersonSrch"
    }
}

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":"0023939882"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External ID"
            },
            "personOrBusiness":{
                "type":"string",
                "enum":[
                    "B   ",
                    "P   "
                ],
                "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                "example":"P"
            },
            "primaryIdentifierType":{
                "type":"string",
                "maxLength":8,
                "description":"Primary Identifier Type for a person or business.",
                "example":"SSN"
            },
            "primaryIdentifierTypeDescription":{
                "type":"string",
                "maxLength":1,
                "description":"Description for Primary Identifier Type for a person or business.",
                "example":"Social Security Number"
            },
            "primaryIdentifier":{
                "type":"string",
                "maxLength":100,
                "description":"The value for the Primary Identifier Type that identifies a person or business.",
                "example":"***-**-1844"
            },
            "recordType":{
                "type":"string",
                "maxLength":1,
                "description":"Record Type"
            },
            "accounts":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "accountId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Account ID identifies the customer who is responsible for the bill.",
                            "example":"0119532152"
                        },
                        "cisDivision":{
                            "type":"string",
                            "maxLength":5,
                            "description":"CIS Division defines the jurisdiction that governs an account.",
                            "example":"CA"
                        },
                        "cisDivisionDescription":{
                            "type":"string",
                            "maxLength":1,
                            "description":"Descriptive information for the division label.",
                            "example":"California"
                        },
                        "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"
                        },
                        "accountRelationshipType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Relationship Type defines the relationship between the person and the account.",
                            "example":"MAIN"
                        },
                        "accountRelationshipTypeDescription":{
                            "type":"string",
                            "maxLength":1,
                            "description":"Display string for relationship the input person has with the Billing Account.",
                            "example":"Main customer"
                        },
                        "premises":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "premiseId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                                        "example":"3836403369"
                                    },
                                    "formattedAddress":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"The mailing address for the primary premise associated with the service agreement.",
                                        "example":"129 Sutter St, San Francisco, CA, 94104"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "premises":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "premiseId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                            "example":"3836403369"
                        },
                        "formattedAddress":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The mailing address for the primary premise associated with the service agreement.",
                            "example":"129 Sutter St, San Francisco, CA, 94104"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accounts: array accounts
• externalId: string
  Maximum Length: 60

  External ID
• personId: string
  Maximum Length: 10

  Person ID

  Example: 0023939882
• personOrBusiness: string
  Allowed Values: [ "B ", "P " ]

  Defines the person entity as a person or business, which controls validation of the person entity's primary name. * `B ` - Business, * `P ` - Person

  Example: P
• premises: array premises
• primaryIdentifier: string
  Maximum Length: 100

  The value for the Primary Identifier Type that identifies a person or business.

  Example: ***-**-1844
• primaryIdentifierType: string
  Maximum Length: 8

  Primary Identifier Type for a person or business.

  Example: SSN
• primaryIdentifierTypeDescription: string
  Maximum Length: 1

  Description for Primary Identifier Type for a person or business.

  Example: Social Security Number
• recordType: string
  Maximum Length: 1

  Record Type

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"0023939882"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID"
        },
        "personOrBusiness":{
            "type":"string",
            "enum":[
                "B   ",
                "P   "
            ],
            "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
            "example":"P"
        },
        "primaryIdentifierType":{
            "type":"string",
            "maxLength":8,
            "description":"Primary Identifier Type for a person or business.",
            "example":"SSN"
        },
        "primaryIdentifierTypeDescription":{
            "type":"string",
            "maxLength":1,
            "description":"Description for Primary Identifier Type for a person or business.",
            "example":"Social Security Number"
        },
        "primaryIdentifier":{
            "type":"string",
            "maxLength":100,
            "description":"The value for the Primary Identifier Type that identifies a person or business.",
            "example":"***-**-1844"
        },
        "recordType":{
            "type":"string",
            "maxLength":1,
            "description":"Record Type"
        },
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID identifies the customer who is responsible for the bill.",
                        "example":"0119532152"
                    },
                    "cisDivision":{
                        "type":"string",
                        "maxLength":5,
                        "description":"CIS Division defines the jurisdiction that governs an account.",
                        "example":"CA"
                    },
                    "cisDivisionDescription":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Descriptive information for the division label.",
                        "example":"California"
                    },
                    "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"
                    },
                    "accountRelationshipType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Relationship Type defines the relationship between the person and the account.",
                        "example":"MAIN"
                    },
                    "accountRelationshipTypeDescription":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Display string for relationship the input person has with the Billing Account.",
                        "example":"Main customer"
                    },
                    "premises":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "premiseId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                                    "example":"3836403369"
                                },
                                "formattedAddress":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The mailing address for the primary premise associated with the service agreement.",
                                    "example":"129 Sutter St, San Francisco, CA, 94104"
                                }
                            }
                        }
                    }
                }
            }
        },
        "premises":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                        "example":"3836403369"
                    },
                    "formattedAddress":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The mailing address for the primary premise associated with the service agreement.",
                        "example":"129 Sutter St, San Francisco, CA, 94104"
                    }
                }
            }
        }
    }
}

Nested Schema : accounts

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"Account ID identifies the customer who is responsible for the bill.",
                "example":"0119532152"
            },
            "cisDivision":{
                "type":"string",
                "maxLength":5,
                "description":"CIS Division defines the jurisdiction that governs an account.",
                "example":"CA"
            },
            "cisDivisionDescription":{
                "type":"string",
                "maxLength":1,
                "description":"Descriptive information for the division label.",
                "example":"California"
            },
            "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"
            },
            "accountRelationshipType":{
                "type":"string",
                "maxLength":8,
                "description":"Relationship Type defines the relationship between the person and the account.",
                "example":"MAIN"
            },
            "accountRelationshipTypeDescription":{
                "type":"string",
                "maxLength":1,
                "description":"Display string for relationship the input person has with the Billing Account.",
                "example":"Main customer"
            },
            "premises":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "premiseId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                            "example":"3836403369"
                        },
                        "formattedAddress":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The mailing address for the primary premise associated with the service agreement.",
                            "example":"129 Sutter St, San Francisco, CA, 94104"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : premises

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                "example":"3836403369"
            },
            "formattedAddress":{
                "type":"string",
                "maxLength":254,
                "description":"The mailing address for the primary premise associated with the service agreement.",
                "example":"129 Sutter St, San Francisco, CA, 94104"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID identifies the customer who is responsible for the bill.

  Example: 0119532152
• accountRelationshipType: string
  Maximum Length: 8

  Relationship Type defines the relationship between the person and the account.

  Example: MAIN
• accountRelationshipTypeDescription: string
  Maximum Length: 1

  Display string for relationship the input person has with the Billing Account.

  Example: Main customer
• cisDivision: string
  Maximum Length: 5

  CIS Division defines the jurisdiction that governs an account.

  Example: CA
• cisDivisionDescription: string
  Maximum Length: 1

  Descriptive information for the division label.

  Example: California
• mainCustomer: boolean
  Main Customer is defined as true if the person is the main customer on the account. Only one person on an account can be designated as the main customer.

  Example: false
• premises: array premises

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"0119532152"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":5,
            "description":"CIS Division defines the jurisdiction that governs an account.",
            "example":"CA"
        },
        "cisDivisionDescription":{
            "type":"string",
            "maxLength":1,
            "description":"Descriptive information for the division label.",
            "example":"California"
        },
        "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"
        },
        "accountRelationshipType":{
            "type":"string",
            "maxLength":8,
            "description":"Relationship Type defines the relationship between the person and the account.",
            "example":"MAIN"
        },
        "accountRelationshipTypeDescription":{
            "type":"string",
            "maxLength":1,
            "description":"Display string for relationship the input person has with the Billing Account.",
            "example":"Main customer"
        },
        "premises":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                        "example":"3836403369"
                    },
                    "formattedAddress":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The mailing address for the primary premise associated with the service agreement.",
                        "example":"129 Sutter St, San Francisco, CA, 94104"
                    }
                }
            }
        }
    }
}

Nested Schema : premises

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                "example":"3836403369"
            },
            "formattedAddress":{
                "type":"string",
                "maxLength":254,
                "description":"The mailing address for the primary premise associated with the service agreement.",
                "example":"129 Sutter St, San Francisco, CA, 94104"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• formattedAddress: string
  Maximum Length: 254

  The mailing address for the primary premise associated with the service agreement.

  Example: 129 Sutter St, San Francisco, CA, 94104
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

  Example: 3836403369

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"3836403369"
        },
        "formattedAddress":{
            "type":"string",
            "maxLength":254,
            "description":"The mailing address for the primary premise associated with the service agreement.",
            "example":"129 Sutter St, San Francisco, CA, 94104"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• formattedAddress: string
  Maximum Length: 254

  The mailing address for the primary premise associated with the service agreement.

  Example: 129 Sutter St, San Francisco, CA, 94104
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

  Example: 3836403369

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"3836403369"
        },
        "formattedAddress":{
            "type":"string",
            "maxLength":254,
            "description":"The mailing address for the primary premise associated with the service agreement.",
            "example":"129 Sutter St, San Francisco, CA, 94104"
        }
    }
}

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