Individual Unlock

Description

The unlock operation releases the lock for an individual record so it can be modified by someone else.

Version

2011-02-02

URI

REST URI [POST]:
/v11.02/Indi.svc/Unlock?SessionId={SessionId}

Content-Type: Application/xml

Example

Request POST
http://wsdev.onegreatfamily.com/v11.02/Indi.svc/Unlock?SessionId=gl4q23cwofpshi55sg1pvc3o
Request Headers
Content-Type: Application/xml
Request Payload 
<Indi xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Ogfn>12345</Ogfn>
	<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>0</GroupOgfn>
	<HintsExist>false</HintsExist>
	<MergesExist>false</MergesExist>
	<Name>Bill /Smith/</Name>
	<SpouseFamilyOgfns />
	<lockId>1234567890</lockId>
</Indi>
Success Response Payload 
<there is no response payload>
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

POST Payload

Name Description Required

Indi

The OneGreatFamily Indi aggregate returned by OGFNIndiLock

Type: Indi

Default: None

Constraints: Must have been returned by OGFNIndiLock.

Yes

Response Elements

Name Description

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.