Family Unlock

Description

This operation releases the lock for an family record so it can be modified by someone else.

URI

REST URI [GET]:
/v11.02/Family.svc/Unlock?SessionId={sessionId}&FamOgfn={famOgfn}&LockId={lockId}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Family.svc/Unlock?SessionId=113434515134543151134&FamOgfn=123456&LockId=666666666

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
FamOgfn	The OneGreatFamily Fam entity returned by the FamLock operation Type: Ulong Default: None Constraints: Must have been returned by FamLock.	Yes
LockId	The OneGreatFamily Fam entity returned by the FamLock operation Type: long Default: None Constraints: Must have been returned by FamLock.	Yes
SessionId	The current session Id Type: string Default: None	Yes

Name

Description

Required

FamOgfn

The OneGreatFamily Fam entity returned by the FamLock operation

Type: Ulong

Default: None

Constraints: Must have been returned by FamLock.

Yes

LockId

The OneGreatFamily Fam entity returned by the FamLock operation

Type: long

Default: None

Constraints: Must have been returned by FamLock.

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 returns 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.