Individual Tree Read

Description

Returns the tree specified by the user for a particular person. Ogfn of the starting Indi to perform the action on.  AnceGens is the number of ancestry generations.  DescGens is the number of descendant generations. Width is the Ancestry gens to climb for retrieving all posterity (i.e. 2 means get all the descendants for all the grandparents which in turn delivers that many cousins, their spouses, etc.--2nd cousins)

URI

REST URI [GET]:
Individual.svc/TreeRead?SessionId={sessionId}&IndiOgfn={indiOgfn}&AnceGens={anceGens}&DescGens={descGens}&Width={width}

Content-Type: Application/xml

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Individual.svc/TreeRead?SessionId=gl4q23cwofpshi55sg1dvc3o&IndiOgfn=123456&AnceGens=2&DescGens=1&Width=0

Success Response Payload
<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="a:ArrayOfanyType">
         <a:anyType i:type="Indi">
          <BirthDatei:nil="true"/>
          <BirthPlacei:nil="true"/>
          <BurialDatei:nil="true"/>
          <BurialPlacei:nil="true"/>
          <ChildFamilyOgfn>0</ChildFamilyOgfn>
          <ChristeningDatei:nil="true"/>
          <ChristeningPlacei:nil="true"/>
          <ConflictsExist>false</ConflictsExist>
          <DeathDatei:nil="true"/>
          <DeathPlacei:nil="true"/>
          <Emaili:nil="true"/>
          <FamousCategoryi:nil="true"/>
          <Gender>Male</Gender>
          <GroupOgfn>1245479</GroupOgfn>
          <HintsExist>false</HintsExist>
          <LinkIdi:nil="true"/>
          <LinkTypei:nil="true"/>
          <MergesExist>false</MergesExist>
          <Name>Tester /Bob/</Name>
          <Ogfn>280126177</Ogfn>
          <SpouseFamilyOgfns/>
          <lockId>0</lockId>
         </a:anyType>
       </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>7009</ErrorCode>
	<FaultMessage>The record could not be found</FaultMessage>
</RestFault>

Query String Parameters

Name Description Required

SessionId

The current session Id

Type: string

Default: None

Yes

IndiOgfn

OneGreatFamily ID for the individual to get tree for

Type: UInt64

Constraints: None

Yes

AnceGens

The number of ancestry generations.

Type: int

Default: None

Yes

DescGens

The number of descendant genrations

Type: int

Default: 0

No

Width

The ancestry gens to climb for retrieving all posterity

Type: int

Default: 0

No

Response Elements

Name Description

Result

This operation returns a Result Entity

Type: Result

Result.Value

Result.Value will be a List<Object> on success

Type: List<Object>

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.