Individual Lock for updates

Description

Locks an individual record so it can be modified and updated. When a record is locked, only you can make modifications and everyone else is blocked from getting a lock until you update or unlock the record. Therefore, it is important to Update or Unlock the record as soon as possible so others will not be prevented from seeing the latest changes and making update. NOTE: If you forget to unlock a record, the lock will timeout after 20 minutes.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Indi.svc/Lock/{indiOgfn}?SessionId={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Indi.svc/Lock/12345?SessionId=gl4q23cwofpshi55sg1pvc3o
Success Response Payload 
<Indi xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<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>189755608</Ogfn>
	<SpouseFamilyOgfns />
	<lockId>1234567890</lockId>
</Indi> 
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

Request 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

Response Elements

Name Description

Indi

This operation returns a Indi aggregate upon success. Otherwise an error is returned.

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 aggregate. Retrieve the RestFault from the Webexception response property.