Alternate Surnames Get

Description

Returns a list of alternate spellings for the requested surname

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Name.svc/SurnameAlternate/{surname}?SessionId={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Name.svc/SurnameAlternate/smith?SessionId=gl4q23cwofpshi55sg1dvc3o
Success Response Payload
<ArrayOfstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
	<string>Smyth</string> 
	<string>Smythe</string> 
	<string>Schmidt</string> 
	<string>Schmid</string> 
	<string>smith</string> 
</ArrayOfstring>
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 Parameter

Name Description Required

SessionId

The current session Id

Type: string

Default: None

Yes

Request Parameters

Name Description Required
Surname

The surname requested.

Type: String

Default: None

Constraints: Must be a valid surname.

Yes

Response Elements

Name Description

Collection of Strings

Returns a collection of alternate surnames

Type: Collection of Strings

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.