SearchRequest

Description

The SearchRequest aggregate is used to specify the request details for the Search request.

Aggregate Elements

Required
Name Description Required

Surname

Last name to search for

Type: String

Constraints: None

Yes

FirstName

First name to search for

Type: String

Constraints: None

No

DetailsInclude

Determines whether to get the detailed (not just summary) results

Type: bool

Constraints: None

No

SummaryInclude

Determines whether to get the summary results

Type: bool

Constraints: None

No

FirstNameAlternatesInclude

Determines whether to use alternate first names as part of the search

Type: bool

Constraints: None

No

SurnameAlternatesInclude

Determines whether to use alternate last names as part of the search

Type: bool

Constraints: None

No

BornCountsInclude

Determines whether to return the counts for birth dates returned by century

Type: bool

Constraints: None

No

FamilyTreeNamesInclude

Determines whether to return detailed resultes from the OneGreatFamily genealogy data

Type: bool

Constraints: None

No

SSDINamesInclude

Determines whether to return detailed resultes from the Social Security Death Index

Type: bool

Constraints: None

No

CensusCountsInclude

Determines whether to return detailed resultes from the 1990 Census

Type: bool

Constraints: None

No

DateStart

Beginning birth date of range to use in the search

Type: String

Constraints: date must contain a year. If only the begin date is specified an exact date is used for the search.

The Preferred date format is Day Month Year. Example 1 January 1945

No

DateEnd

Ending birth date of range to filter results on

Type: String

Constraints: date must contain a year. If an end date is passed in, a begin date must also be passed in or an error will result.

The Preferred date format is Day Month Year. Example 1 January 1945

No

RowIndexStart

Starting index of search results to return

Type: int

Constraints: None

No

RowsMaximum

Number of results to return

Type: int

Constraints: None

No

MiddleName

Last name to search for

Type: String

Constraints: None

No
Gender

Gender of person to search for

Type: String

Constraints: Must be "male", "female" or "unknown"

No
DeathDateStart

Beginning death date of range to use in the search

Type: String

Constraints: date must contain a year. If only the begin date is specified an exact date is used for the search.

The Preferred date format is Day Month Year. Example 1 January 1945

No
DeathDateEnd

Ending of date range to use in the search

Type: String

Constraints: date must contain a year. If an end date is passed in, a begin date must also be passed in or an error will result.

The Preferred date format is Day Month Year. Example 1 January 1945

No
BirthPlace

Place  of birth to use in the search

Type: String

Constraints: format is of the form city,county,state,country

No
DeathPlace

Place  of death to use in the search

Type: String

Constraints: format is of the form city,county,state,country

No