Alternate Given Names Get

Description

Returns a list of alternate spellings for the requested given name

URI

REST URI [GET]:
/v11.02/Name.svc/AlternateGivenNamesGet?SessionId={sessionId}&GivenName={givenname}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Name.svc/AlternateGivenNamesGet?SessionId=usjydtahdg2afmvcebaion0u&GivenName=john

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="a:ArrayOfstring" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
		<a:string>Jon</a:string>
		<a:string>Jhon</a:string>
		<a:string>john</a:string>
	</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 Parameter

Name	Description	Required
SessionId	The current session Id Type: string Default: None	Yes
GivenName	The given name requested. Type: String Default: None Constraints: Must be a valid name string.	Yes

Name

Description

Required

SessionId

The current session Id

Type: string

Default: None

Yes

GivenName

The given name requested.

Type: String

Default: None

Constraints: Must be a valid name string.

Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a collection of alternate given names on success 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` entity. Retrieve the RestFault from the Webexception response property.