Jump to

• Request
• Response

Person Search

post

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

This operation is used to find person or business records based on specific filters i.e. Account ID, Service Address, Person Identifier and Geographic Value.

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.

  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.
  This option requires the type of geographic attribute to be specified as the filter's class.

  Only active accounts are considered.

• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Page Limit

  Example: 3
• restrictedIds: array restrictedIds
  The search may be restricted to a specific list of business records. Each record is identified either by its internal key or by an external identifier, i.e. Fusion's "Party Number".

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"array",
            "description":"The search operation supports a single filter only of the following types: \n\nBy Account ID. Finds business or person records associated with the specified account. <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. <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.<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>\nThis option requires the type of geographic attribute to be specified as the filter's class.<p>\n\nOnly active accounts are considered.",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1AS",
                            "C1GE",
                            "C1ID"
                        ],
                        "description":"The Person search operation supports a single filter of following types:\n\nBy Account ID. Finds business or person records associated with the specified account.\n\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.\n\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier.\n\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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier",
                        "example":"C1ID"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value 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":"Fusion's \"Party Number\" for the person record."
                    }
                }
            }
        },
        "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.

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.
This option requires the type of geographic attribute to be specified as the filter's class.

Only active accounts are considered.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The search operation supports a single filter only of the following types: \n\nBy Account ID. Finds business or person records associated with the specified account. <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. <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.<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>\nThis option requires the type of geographic attribute to be specified as the filter's class.<p>\n\nOnly active accounts are considered.",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1AS",
                    "C1GE",
                    "C1ID"
                ],
                "description":"The Person search operation supports a single filter of following types:\n\nBy Account ID. Finds business or person records associated with the specified account.\n\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.\n\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier.\n\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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier",
                "example":"C1ID"
            },
            "value":{
                "type":"string",
                "maxLength":4,
                "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value 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":"Fusion's \"Party Number\" for the person record."
            }
        }
    }
}

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", "C1GE", "C1ID" ]

  The Person search operation supports a single filter of 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. By Person Identifier. Finds person or business records associated with a specific type of person identifier. 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. * `C1AC` - Account, * `C1AS` - Service Address, * `C1GE` - Geographic Value, * `C1ID` - Personal Identifier

  Example: C1ID
• value: string
  Maximum Length: 4

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

  Example: 222-33-6668

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

  Fusion's "Party Number" for the person record.
• 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":"Fusion's \"Party Number\" for the person record."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filters: array filters
  The search operation supports a single filter only of the following types: By Account ID. Finds business 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.

  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.
  This option requires the type of geographic attribute to be specified as the filter's class.

  Only active accounts are considered.

• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Page Limit

  Example: 3
• restrictedIds: array restrictedIds
  The search may be restricted to a specific list of business records. Each record is identified either by its internal key or by an external identifier, i.e. Fusion's "Party Number".

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"array",
            "description":"The search operation supports a single filter only of the following types: \n\nBy Account ID. Finds business or person records associated with the specified account. <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. <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.<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>\nThis option requires the type of geographic attribute to be specified as the filter's class.<p>\n\nOnly active accounts are considered.",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1AS",
                            "C1GE",
                            "C1ID"
                        ],
                        "description":"The Person search operation supports a single filter of following types:\n\nBy Account ID. Finds business or person records associated with the specified account.\n\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.\n\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier.\n\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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier",
                        "example":"C1ID"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value 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":"Fusion's \"Party Number\" for the person record."
                    }
                }
            }
        },
        "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.

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.
This option requires the type of geographic attribute to be specified as the filter's class.

Only active accounts are considered.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The search operation supports a single filter only of the following types: \n\nBy Account ID. Finds business or person records associated with the specified account. <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. <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.<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>\nThis option requires the type of geographic attribute to be specified as the filter's class.<p>\n\nOnly active accounts are considered.",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1AS",
                    "C1GE",
                    "C1ID"
                ],
                "description":"The Person search operation supports a single filter of following types:\n\nBy Account ID. Finds business or person records associated with the specified account.\n\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.\n\nBy Person Identifier. Finds person or business records associated with a specific type of person identifier.\n\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.\n\nOnly active accounts are considered.\n* `C1AC` - Account,\n* `C1AS` - Service Address,\n* `C1GE` - Geographic Value,\n* `C1ID` - Personal Identifier",
                "example":"C1ID"
            },
            "value":{
                "type":"string",
                "maxLength":4,
                "description":"Value for Person Search filter type i.e. Account, Service Address, Geographic Value 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":"Fusion's \"Party Number\" for the person record."
            }
        }
    }
}

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", "C1GE", "C1ID" ]

  The Person search operation supports a single filter of 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. By Person Identifier. Finds person or business records associated with a specific type of person identifier. 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. * `C1AC` - Account, * `C1AS` - Service Address, * `C1GE` - Geographic Value, * `C1ID` - Personal Identifier

  Example: C1ID
• value: string
  Maximum Length: 4

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

  Example: 222-33-6668

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

  Fusion's "Party Number" for the person record.
• 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":"Fusion's \"Party Number\" for the person record."
        }
    }
}

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":"Fusion's \"Party Number\" for the person record."
                    },
                    "personOrBusiness":{
                        "type":"string",
                        "maxLength":2,
                        "description":"Person/Business"
                    },
                    "primaryIdentifierType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"ID Type"
                    },
                    "primaryIdentifierTypeDescription":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Primary Identifier Types"
                    },
                    "primaryIdentifier":{
                        "type":"string",
                        "maxLength":100,
                        "description":"ID Number"
                    },
                    "accounts":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "accountId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Account ID"
                                },
                                "cisDivision":{
                                    "type":"string",
                                    "maxLength":5,
                                    "description":"CIS Division"
                                },
                                "cisDivisionDescription":{
                                    "type":"string",
                                    "maxLength":1,
                                    "description":"CIS Division"
                                },
                                "accountRelationshipType":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Account Relationship Type"
                                },
                                "accountRelationshipTypeDescription":{
                                    "type":"string",
                                    "maxLength":1,
                                    "description":"Account Relationship Type Description"
                                },
                                "premises":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "premiseId":{
                                                "type":"string",
                                                "maxLength":10,
                                                "description":"Premise ID"
                                            },
                                            "formattedAddress":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"Premise Info"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "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":"Fusion's \"Party Number\" for the person record."
            },
            "personOrBusiness":{
                "type":"string",
                "maxLength":2,
                "description":"Person/Business"
            },
            "primaryIdentifierType":{
                "type":"string",
                "maxLength":8,
                "description":"ID Type"
            },
            "primaryIdentifierTypeDescription":{
                "type":"string",
                "maxLength":1,
                "description":"Primary Identifier Types"
            },
            "primaryIdentifier":{
                "type":"string",
                "maxLength":100,
                "description":"ID Number"
            },
            "accounts":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "accountId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Account ID"
                        },
                        "cisDivision":{
                            "type":"string",
                            "maxLength":5,
                            "description":"CIS Division"
                        },
                        "cisDivisionDescription":{
                            "type":"string",
                            "maxLength":1,
                            "description":"CIS Division"
                        },
                        "accountRelationshipType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Account Relationship Type"
                        },
                        "accountRelationshipTypeDescription":{
                            "type":"string",
                            "maxLength":1,
                            "description":"Account Relationship Type Description"
                        },
                        "premises":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "premiseId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Premise ID"
                                    },
                                    "formattedAddress":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Premise Info"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

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

  Person ID

  Example: 0023939882
• personOrBusiness: string
  Maximum Length: 2

  Person/Business
• primaryIdentifier: string
  Maximum Length: 100

  ID Number
• primaryIdentifierType: string
  Maximum Length: 8

  ID Type
• primaryIdentifierTypeDescription: string
  Maximum Length: 1

  Primary Identifier Types

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"0023939882"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Fusion's \"Party Number\" for the person record."
        },
        "personOrBusiness":{
            "type":"string",
            "maxLength":2,
            "description":"Person/Business"
        },
        "primaryIdentifierType":{
            "type":"string",
            "maxLength":8,
            "description":"ID Type"
        },
        "primaryIdentifierTypeDescription":{
            "type":"string",
            "maxLength":1,
            "description":"Primary Identifier Types"
        },
        "primaryIdentifier":{
            "type":"string",
            "maxLength":100,
            "description":"ID Number"
        },
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID"
                    },
                    "cisDivision":{
                        "type":"string",
                        "maxLength":5,
                        "description":"CIS Division"
                    },
                    "cisDivisionDescription":{
                        "type":"string",
                        "maxLength":1,
                        "description":"CIS Division"
                    },
                    "accountRelationshipType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Account Relationship Type"
                    },
                    "accountRelationshipTypeDescription":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Account Relationship Type Description"
                    },
                    "premises":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "premiseId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Premise ID"
                                },
                                "formattedAddress":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Premise Info"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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"
            },
            "cisDivision":{
                "type":"string",
                "maxLength":5,
                "description":"CIS Division"
            },
            "cisDivisionDescription":{
                "type":"string",
                "maxLength":1,
                "description":"CIS Division"
            },
            "accountRelationshipType":{
                "type":"string",
                "maxLength":8,
                "description":"Account Relationship Type"
            },
            "accountRelationshipTypeDescription":{
                "type":"string",
                "maxLength":1,
                "description":"Account Relationship Type Description"
            },
            "premises":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "premiseId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Premise ID"
                        },
                        "formattedAddress":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Premise Info"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• accountRelationshipType: string
  Maximum Length: 8

  Account Relationship Type
• accountRelationshipTypeDescription: string
  Maximum Length: 1

  Account Relationship Type Description
• cisDivision: string
  Maximum Length: 5

  CIS Division
• cisDivisionDescription: string
  Maximum Length: 1

  CIS Division
• premises: array premises

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":5,
            "description":"CIS Division"
        },
        "cisDivisionDescription":{
            "type":"string",
            "maxLength":1,
            "description":"CIS Division"
        },
        "accountRelationshipType":{
            "type":"string",
            "maxLength":8,
            "description":"Account Relationship Type"
        },
        "accountRelationshipTypeDescription":{
            "type":"string",
            "maxLength":1,
            "description":"Account Relationship Type Description"
        },
        "premises":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID"
                    },
                    "formattedAddress":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Premise Info"
                    }
                }
            }
        }
    }
}

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"
            },
            "formattedAddress":{
                "type":"string",
                "maxLength":254,
                "description":"Premise Info"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• formattedAddress: string
  Maximum Length: 254

  Premise Info
• premiseId: string
  Maximum Length: 10

  Premise ID

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "formattedAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Premise Info"
        }
    }
}

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