Individual Read

Description

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

URI

REST URI [GET]:
/v11.02/Individual.svc/Read?SessionId={sessionId}&IndiOgfn={indiOgfn}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Individual.svc/Read?SessionId=ll3f3mdpag0yv2myypky2ocx&IndiOgfn=123456789

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="Indi">
		<BirthDate>1 Jan 1950</BirthDate>
		<BirthPlace>Springfield, UT, UT, USA</BirthPlace>
		<BurialDate>20 Jan 1976<BurialDate>
		<BurialPlace>Springfield, UT, UT, USA</BurialPlace>
		<ChildFamilyOgfn>0</ChildFamilyOgfn>
		<ChristeningDate>5 September 1950</ChristeningDate>
		<ChristeningPlace>Springfield, UT, UT, USA</ChristeningPlace>
		<ConflictsExist>false</ConflictsExist>
		<DeathDate>10 Jan 1976</DeathDate>
		<DeathPlace>Springfield, UT, UT, USA</DeathPlace>
		<Email>support@onegreatfamily.com</Email>
		<Gender>Male</Gender>
		<GroupOgfn>1101645</GroupOgfn>
		<HintsExist>false</HintsExist>
		<MergesExist>false</MergesExist>
		<Name>Bill /Smith/</Name>
		<Ogfn>123456789</Ogfn>
		<SpouseFamilyOgfns />
		<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
IndiOgfn	The OneGreatFamily ID for the individual to retrieve Type: UInt64 Default: None Constraints: Must be a valid individual ID.	Yes
SessionId	The current session Id Type: string Default: None	Yes

Name

Description

Required

IndiOgfn

The OneGreatFamily ID for the individual to retrieve

Type: UInt64

Default: None

Constraints: Must be a valid individual ID.

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

The only thing returned is the entity below:

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be an Indi Entity Type: Indi
`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.