Name Parse

Description

The NameParse operation allows building a Name structure by parsing a Name string

URI

REST URI [GET]:
/v11.02/Name.svc/Parse?SessionId={SessionId}&Name={name}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Name.svc/Parse?SessionId=113434515134543151134&Name=Sarah+queen+of+England+%22Wheezer%22+/Lee/+VII

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="Name">
		<GivenName>Sarah</GivenName>
		<MiddleNames/>
		<Nickname>Wheezer</Nickname>
		<Prefix/>
		<RequestedName>Sarah queen of England "Wheezer" /Lee/ VII</RequestedName>
		<StandardizedName>Sarah "Wheezer" /Lee/ VII; Queen of England</StandardizedName>
		<Suffixes>VII</Suffixes>
		<Surname>Lee</Surname>
		<SurnamePrefix/>
		<Titles>Queen of England</Titles>
	</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

Name Description Required

Name	Description	Required
`Name`	The name string to parse Type: : String Default: None Constraints: Must be a valid name string. Only correctly formatted names can be used	Yes
SessionId	The current session Id Type: string Default: None	Yes

Name

The name string to parse

Type: : String

Default: None

Constraints: Must be a valid name string. Only correctly formatted names can be used

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a Name entity upon success. Otherwise an error is returned. Type: Name
`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.