Name Search

Description

The SearchByName operation allows for simple searching of the OneGreatFamily system by using only the given and surname as search criteria.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Search.svc/SearchByName?given={given name}&surname={surname}&startindex={startindex}&maxrows={maxrows}&summaryonly=[true|false]&SessionId={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Search.svc/SearchByName?given=John&surname=smith&startindex=0&maxrows=25&surnameonly=false&SessionId=gl4q23cwofpshi55sg1dvc3o
Success Response Payload 
<SearchResults xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<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>
</SearchResults>
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

Name Description Required

Given

The given names of the individual you want to search for.

Type: String

Default: None

Constraints: Must be a valid String

Yes

Surname

The surname of the individual you want to search for.

Type: String

Default: None

Constraints: Must be a valid String

Yes

Startindex

The starting index of the rows to return

Type: Unsigned Integer

Default: None

Constraints: Must be a valid Unsigned Integer

Yes

RowMax

The maximum number of rows to return

Type: Unsigned Integer

Default: None

Constraints: Must be a valid Unsigned Integer

Yes

Summaryonly

True if you want to retrieve only summary data

Type: Bool

Default: None

Constraints: Must be a true or false

Yes

Response Elements

Name Description

SearchResults

This operation returns a SearchResult aggregate upon success. Otherwise an error is returned.

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 aggregate. Retrieve the RestFault from the Webexception response property.