Place Parse

Description

The PlaceParse operation allows building a Place aggregate by parsing a Place string

Version

2011-02-02

URI

REST URI [GET]:
 /v11.02/Place.svc/Parse/{place}?SessionId={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Place.svc/Parse/Shelly,+Bingham,+Id,+usa?SessionId=113434515134543151134 
Success Response 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> 
 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
Place

The Place string to parse

Type: : String

Default: None

Constraints: Must be a valid Place string

 Yes

Response Elements

Name Description

Place

This operation returns a Place aggregate upon success. Otherwise an error is returned.

Type: Place

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.