Individual Unlock

Description

The unlock operation releases the lock for an individual record so it can be modified by someone else. Note: Unlock will loose any changes you have made, if you want to save any modifications you have made and release the lock, just call the CreateUpdate operation.

URI

REST URI [GET]:
/v11.02/Individual.svc/Unlock?SessionId={sessionId}&Ogfn={indiOgfn}&LockId={lockId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Individual.svc/Unlock?SessionId=gl4q23cwofpshi55sg1pvc3o&Ogfn=213456&LockId=666554
Success Response Payload 
<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
</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

Ogfn

The OneGreatFamily Indi entity returned by the IndiLock operation

Type: Ulong

Default: None

Constraints: Must have been returned by IndiLock.

Yes

LockId

The OneGreatFamily Indi entity returned by the IndiLock operation

Type: long

Default: None

Constraints: Must have been returned by IndiLock.

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 nothing

Type: Nothing

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.