Search

Description

The Search operation allows for advanced searching of the OneGreatFamily system. Search request details are specified in a SearchRequest structure.

URI

REST URI [GET]:
/v11.02/Search.svc/Search?SessionId={sessionId}&Surname={surname}&GivenNames={givenNames}&DelimitedFullName={delimitedFullName}&Gender={gender}&BirthDateStart={birthDateStart}&BirthDateEnd={birthDateEnd}&DeathDateStart={deathDateStart}&DeathDateEnd={deathDateEnd}&BirthPlace={birthPlace}&DeathPlace={deathPlace}&RowIndexStart={rowIndexStart}&MaxRows={maxRows}&IncludeDetails={includeDetails}&IncludeSummary={includeSummary}&IncludeBornCounts={includeBornCounts}&IncludeFamilyTreeNames={includeFamilyTreeNames}&IncludeSSDINames={includeSSDINames}&IncludeCensusCounts={includeCensusCounts}&IncludeSurnameAlternates={includeSurnameAlternates}&IncludeFirstNameAlternates={includeFirstNameAlternates}

REST URI [POST]:
/v11.02/Search.svc/Search?SessionId={sessionId}

Content-Type: Application/xml

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Search.svc/Search?Sessionid=f11kgk5olvzoupjjkxex3xed&Surname=Smith&GivenNames=john&DelimitedFullName=John William /Smith/&Gender=Male&BirthDateStart=1 Jan 1865&BirthDateEnd=1 Jan 1965&DeathDateStart=1 Jan 1905&DeathDateEnd=1 Jan 1995&BirthPlace=usa&DeathPlace=usa&StartIndex=0&MaxRows=3&IncludeSummary=true&
IncludeDetails=true&IncludeFamilyTreeNames=true&IncludeBornCounts=true&IncludeSSDINames=false&IncludeFirstNameAlternates=false&
IncludeSurnameAlternates=false

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="SearchResults">
		<AlternateDetails i:nil="true"/>
		<AlternateNames i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
		<OGFDetails>
			<SearchResultEntry>
				<BirthDateString>1 MAR 1887</BirthDateString>
				<BirthPlaceString>Logan,Cache,Utah,United States</BirthPlaceString>
				<DeathDateString>13 JAN 1964</DeathDateString>
				<DeathPlaceString>Montpelier,Bear Lake,Idaho,United States</DeathPlaceString>
				<Gender>Male</Gender>
				<Name>Smith, John William</Name>
				<Ogfn>143097631</Ogfn>
			</SearchResultEntry>
			<SearchResultEntry>
				<BirthDateString>1 MAR 1887</BirthDateString>
				<BirthPlaceString>Logan,Cache,Utah,United States</BirthPlaceString>
				<DeathDateString>13 JAN 1964</DeathDateString>
				<DeathPlaceString>Montpelier,Bear Lake,Idaho,United States</DeathPlaceString>
				<Gender>Male</Gender>
				<Name>Smith, John William</Name>
				<Ogfn>145286750</Ogfn>
			</SearchResultEntry>
			<SearchResultEntry>
				<BirthDateString>1 MAR 1887</BirthDateString>
				<BirthPlaceString>Logan,Cache,Utah,United States</BirthPlaceString>
				<DeathDateString>13 JAN 1964</DeathDateString>
				<DeathPlaceString>Montpelier,Bear Lake,Idaho,United States</DeathPlaceString>
				<Gender>Male</Gender>
				<Name>Smith, John William</Name>
				<Ogfn>145598767</Ogfn>
			</SearchResultEntry>
		</OGFDetails>
		<SSDIDetails i:nil="true"/>
		<Summary>
			<Born1500>5726</Born1500>
			<Born1600>23589</Born1600>
			<Born1700>65490</Born1700>
			<Born1800>247379</Born1800>
			<Born1900>168779</Born1900>
			<BornBefore1500>3612</BornBefore1500>
			<BornUnknown>388682</BornUnknown>
			<Census1990ApproxCount>0</Census1990ApproxCount>
			<OGFCountApprox>41</OGFCountApprox>
			<SSDICount>0</SSDICount>
		</Summary>
	</Value>
</Result>

Request POST

http://wsdev.onegreatfamily.com/v11.02/Search.svc/Search?SessionId=gl4q23cwofpshi55sg1dvc3o

Request POST Headers

Content-Type: Application/xml

Request POST Payload

<SearchRequest xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<FirstName>John</FirstName> 
	<Surname>Smith</Surname> 
	<FirstNameAlternatesInclude>true</FirstNameAlternatesInclude> 
	<SurnameAlternatesInclude>true</SurnameAlternatesInclude> 
	<BirthPlace>San Fransisco, CA, USA</BirthPlace> 
	<BornCountsInclude>true</BornCountsInclude> 
	<CensusCountsInclude>true</CensusCountsInclude> 
	<DateStart>1 Jan 1910</DateStart> 
	<DateEnd>1 Dec 1910</DateEnd> 
	<DeathDateStart>1 Jan 1990</DeathDateStart> 
	<DeathDateEnd>1 Dec 1990</DeathDateEnd> 
	<DeathPlace></DeathPlace> 
	<DetailsInclude>true</DetailsInclude> 
	<FamilyTreeNamesInclude>true</FamilyTreeNamesInclude> 
	<Gender>male</Gender> 
	<RowIndexStart>0</RowIndexStart> 
	<MaxRows>3</MaxRows> 
	<SSDINamesInclude>true</SSDINamesInclude> 
	<SummaryInclude>true</SummaryInclude> 
</SearchRequest>

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="SearchResults">
		<AlternateDetails>
			<SearchResultEntry>
				<Ogfn>123456</Ogfn>
				<Name>Smith, John</Name>
				<BirthDateString>1 Jan 1910</BirthDateString>
				<BirthPlaceString>Manhatten, New York County, NY, USA</BirthPlaceString>
				<DeathDateString>1 Jan 1980</DeathDateString>
				<DeathPlaceString>Manhatten, New York County, NY, USA</DeathPlaceString>
				<Gender>Male</Gender>
			</SearchResultEntry>
		</AlternateDetails>
		<AlternateNames xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
			<a:string>John Smythe</a:string>
			<a:string>Jon Smith</a:string>
		</AlternateNames>
		<OGFDetails>
			<SearchResultEntry>
				<Ogfn>123456</Ogfn>
				<Name>Smith, John</Name>
				<BirthDateString>1 Jan 1910</BirthDateString>
				<BirthPlaceString>Manhatten, New York County, NY, USA</BirthPlaceString>
				<DeathDateString>1 Jan 1980</DeathDateString>
				<DeathPlaceString>Manhatten, New York County, NY, USA</DeathPlaceString>
				<Gender>Male</Gender>
			</SearchResultEntry>
		</OGFDetails>
		<SSDIDetails>
			<SearchResultEntry>
				<Ogfn>123456</Ogfn>
				<Name>Smith, John</Name>
				<BirthDateString>1 Jan 1910</BirthDateString>
				<BirthPlaceString>Manhatten, New York County, NY, USA</BirthPlaceString>
				<DeathDateString>1 Jan 1980</DeathDateString>
				<DeathPlaceString>Manhatten, New York County, NY, USA</DeathPlaceString>
				<Gender>Male</Gender>
			</SearchResultEntry>
		</SSDIDetails>
		<Summary>
			<Born1500>100</Born1500>
			<Born1600>125</Born1600>
			<Born1700>150</Born1700>
			<Born1800>175</Born1800>
			<Born1900>25</Born1900>
			<BornBefore1500>1000</BornBefore1500>
			<BornUnknown>20</BornUnknown>
			<Census1990ApproxCount>5000</Census1990ApproxCount>
			<OGFCountApprox>10000</OGFCountApprox>
			<SSDICount>6000</SSDICount>
		</Summary>
	</Value>
</Result>

Failed Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>27001</Code>
	<Message>Your developer Id does not have permissions to make this call</Message>
</Result>

Fault Response Payload

<RestFault xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<ErrorCode>551</ErrorCode>
	<FaultMessage>An unhandled exception has occurred</FaultMessage>
</RestFault>

Query String Parameters [GET]

Name	Description	Required
`Surname`	The `Surname` to search for Type: string Default: None Constraints: None	Yes
`GivenNames`	Given names to search for Type: String Constraints: None	No
`DelimitedFullName`	DelimitedFullName this is a full name with the parts of the names delimited. Type: String Constraints: None	No
`Gender`	Gender of individual to search for Type: String Constraints: Must be "male", "female". Not specifying a value will match all.	No
`BirthDateStart`	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
`BirthDateEnd`	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
`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
`RowIndexStart`	Starting index of search results to return Type: int Constraints: None	No
`MaxRows`	Number of results to return Type: int Constraints: None	Yes
`IncludeDetails`	Determines whether to get the detailed (not just summary) results Type: bool Constraints: Must be "true" or"false"	No
`IncludeSummary`	Determines whether to get the summary results Type: bool Constraints: Must be "true" or"false"	No
`IncludeBornCounts`	Determines whether to return the counts for birth dates returned by century Type: bool Constraints: Must be "true" or"false"	No
`IncludeFamilyTreeNames`	Determines whether to return detailed results from the OneGreatFamily genealogy data Type: bool Constraints: Must be "true" or"false"	No
`IncludeSSDINames`	Determines whether to return detailed results from the Social Security Death Index Type: bool Constraints: Must be "true" or"false"	No
`IncludeCensusCounts`	Determines whether to return detailed results from the 1990 Census Type: bool Constraints: Must be "true" or"false"	No
`IncludeSurnameAlternates`	Determines whether to use alternate first names as part of the search Type: bool Constraints: Must be "true" or"false"	No
`IncludeFirstNameAlternates`	Determines whether to use alternate last names as part of the search Type: bool Constraints: Must be "true" or"false"	No
SessionId	The current session Id Type: string Default: None	Yes

Query String Parameters [POST]

Name	Description	Required
SessionId	The current session Id Type: string Default: None	Yes

Name

Description

Required

SessionId

The current session Id

Type: string

Default: None

Yes

Post Payload

Name Description Required

Name	Description	Required
`SearchRequest`	The search request entity. Type: SearchRequest Default: None Constraints: Must be a valid SearchRequest entity.	Yes

SearchRequest

The search request entity.

Type: SearchRequest

Default: None

Constraints: Must be a valid SearchRequest entity.

Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a `SearchResult` entity upon success. Type: SearchResult
`HTTP Status Code`	The Web Server returns a status code which indicates if the operation was successful. Anything other than 200 should be regarded as a failure.
`HTTP Status Code` of 417	The Web Server threw an exception and contains a `RestFault` entity. Retrieve the RestFault from the Webexception response property.