The SearchByName operation allows for simple searching of the
OneGreatFamily system by using only the given and surname as search criteria.
2008-08-19
Initial version without URL versioning
2009-02-04 Version URL's implemented
/FamilyTree/2009-02-04/Search.svc
2009-03-18 Seperate SOAP and REST URL's
SOAP URI: /Service/2009-03-18
REST URI [GET]: /FamilyTree/2009-03-18/Search.svc/SearchByName?given={given name}&surname={surname}&startindex={startindex}&maxrows={maxrows}&summaryonly={Summaryonly}
| Name | Description | Required |
|---|---|---|
|
|
The given names of the individual you want to search for. Type: String Default: None Constraints: Must be a valid String |
Yes |
|
|
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 |
|
|
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 |
The only thing returned is the aggregate below:
| Name | Description |
|---|---|
|
|
This operation returns a Type: SearchResultWS |