Name Format

Description

The NameFormat operation allows building a Name string from parts in the Name structure

URI

REST URI [GET]:

/v11.02/Name.svc/Format?SessionId={sessionId}&RequestedName={requestedName}&StandardizedName={standardizedName}&Prefix={prefix}&Titles={titles}&GivenName={givenName}&MiddleNames={middleNames}&SurnamePrefix={surnamePrefix}&Surname={surname}&Suffixes={suffixes}&Nickname={nickname}

Content-Type: Application/xml

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Name.svc/Format?Sessionid=3kwqqcq3luq0yo2ky1ejf3ks&RequestedName=sarah+queen+of+England+%22Wheezer%22+%2flee%2f+VII&GivenName=sarah&MiddleNames=&Surname=Lee&Nickname=Wheezer&Prefix=
&StandardizedName=Sarah+%22Wheezer%22+%2fLee%2f+VII%3b+Queen+of+England&Suffixes=VII&SurnamePrefix=&Titles=Queen+of+England
Request Headers
Content-Type: Application/xml
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:string" xmlns:a="http://www.w3.org/2001/XMLSchema">Sarah "Wheezer" /Lee/ VII; Queen of England</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

SessionId

The current session Id

Type: string

Default: None

Yes

RequestedName

The name (not standardized)

Type: String

Constraints: None

Yes

StandardizedName

The name in standard format

Type: String

Constraints: None

No

Prefix

The name prefix

Type: String

Constraints: None

No

Titles

The name prefix

Type: String : String

Constraints: None

No

GivenName

The given name

Type: String

Constraints: None

No

MiddleNames

The middle name

Type: String

Constraints: None

no

SurnamePrefix

The surname prefix

Type: String

Constraints: None

No

Surname

The surname

Type: uint

Constraints: None

No

Suffixes

The name suffix

Type: String

Constraints: None

No

Nickname

The nickname

Type: String

Constraints: None

No

Response Elements

Name Description

Result

This operation returns a Result Entity

Type: Result

Result.Value

Result.Value will be a standardized name as a string

Type: string

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.