Family Hints Read

Description

Returns the hints for the given family

URI

REST URI [GET]:
Family.svc/HintsRead?SessionId={sessionId}&FamOgfn={famOgfn}

Content-Type: Application/xml

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Family.svc/HintsRead?SessionId=gl4q23cwofpshi55sg1dvc3o&FamOgfn=673627

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="ArrayOfHintResult"></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

Name	Description	Required
SessionId	The current session Id Type: string Default: None	Yes
`FamOgfn`	OneGreatFamily ID for the Family Type: UInt64 Constraints: None	Yes

SessionId

The current session Id

Type: string

Default: None

Yes

FamOgfn

OneGreatFamily ID for the Family

Type: UInt64

Constraints: None

Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be List<Hint> on Success Type: List<Hint>
`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.