Family Read

Description

This operation retrieves a read-only family record that cannot be modified and updated.

URI

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

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Family.svc/Read?SessionId=24354354353451534514545&FamOgfn=12345
Success Response Payload
<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>27001</Code>
	<Message>You do not have permissions to make this call</Message>
	<Value i:type="Fam">
		<ChildrenOgfns xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
			<a:unsignedLong>1341234</a:unsignedLong>
		</ChildrenOgfns>
		<DivorceDate>1 Jan 2000</DivorceDate>
		<DivorcePlace>New york, New york, usa</DivorcePlace>
		<GroupOgfn>2345</GroupOgfn>
		<HusbandOgfn>24345</HusbandOgfn>
		<MarriageDate>1 Jan 1960</MarriageDate>
		<MarriagePlace>New york, New york, usa</MarriagePlace>
		<Ogfn>2542345</Ogfn>
		<WifeOgfn>3242435</WifeOgfn>
		<lockId>0</lockId>
	</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

FamOgfn

The OneGreatFamily ID for the family to retrieve

Type: UInt64

Default: None

Constraints: Must be a valid family ID.

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

Name Description

Result

This operation returns a Result Entity

Type: Result

Result.Value

Result.Value will be an Fam Entity

Type: Fam

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.