Name Parse

Description

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

Version

2011-02-02

URI

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

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Name.svc/Parse?name=Sarah+queen+of+England+%22Wheezer%22+/Lee/+VII&SessionId=113434515134543151134
Success Response Payload 
<Name xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
  <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>
</Name>
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

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

 Yes

Response Elements

Name Description

Name

This operation returns a  Name aggregate 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 aggregate. Retrieve the RestFault from the Webexception response property.