Place Format

Description

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

URI

REST URI [GET]:
/v11.02/Place.svc/Format?SessionId={sessionId}&Country={country}&RequestedPlace={requestedPlace}&StandardizedPlace={standardizedPlace}&City={city}&County={county}&State={state}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Place.svc/Format?SessionId=usjydtahdg2afmvcebaion0u&Country=United+States&City=Shelley&County=Bingham&RequestedPlace=shelley,+bingham,+id,+usa
&StandardizedPlace=Shelley,+Bingham,+Idaho,+United+States&State=Idaho

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">Shelley, Bingham, Idaho, United States</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
`Country`	The country Type: City Constraints: valid string	yes
`RequestedPlace`	The Place (not standardized) Type: String Constraints: Valid string representing a place	No
`StandardizedPlace`	The Place in standard format Type: String Constraints: None	No
`City`	The city Type: String Constraints: valid string	No
`County`	The county Type: City Constraints: valid string	No
`State`	The State Type: City Constraints: valid string	No

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a formatted place string on success 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.