Place Format

Description

The PlaceFormat operation allows building a Place string from parts in the Place aggregate

Version

2011-02-02

URI

REST URI [POST]:
 /v11.02/Place.svc/Format?SessionId={SessionId}

Content-Type: Application/xml

Example

Request POST
http://wsdev.onegreatfamily.com/v11.02/Place.svc/Format?SessionId=113434515134543151134
Request Headers
Content-Type: Application/xml
Request Payload 
<Place xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data" >
  <City>Shelley</City>
  <Country>United States</Country>
  <County>Bingham</County>
  <RequestedPlace> shelley,   bingham ,  id ,  usa  </RequestedPlace>
  <StandardizedPlace>Shelley, Bingham, Idaho, United States</StandardizedPlace>
  <State>Idaho</State>
</Place> 
Success Response Payload 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Shelley, Bingham, Idaho, United States</string>
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

POST Payload

Name Description Required
place

The Place aggregate.

Type: Place

Default: None

Constraints: Must be a valid Place aggregate.

Yes

Response Elements

Name Description

Place

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