Family Lock for updates

Description

The FamLock operation retrieves a locked family record so it can be modified and updated.

Version

2011-02-02

URI

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

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Family.svc/12345?SessionId=24354354353451534514545
Success Response Payload 
<Fam xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
  <ChildrenOgfns xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <a:unsignedLong>1341234</a:unsignedLong>
  </ChildrenOgfns>
  <DivorceDate>1 Jan 2000</DivorceDate>
  <DivorcePlace>New york, New york, usa</DivorcePlace>
  <GroupOgfn>2345</GroupOgfn>
  <HusbandOgfn>24345</HusbandOgfn>
  <MarriageDate>1 Jan 1960</MarriageDate>
  <MarriagePlace>New york, New york, usa</MarriagePlace>
  <Ogfn>2542345</Ogfn>
  <WifeOgfn>3242435</WifeOgfn>
  <>3423523452342544</lockIdd>
</Fam>
 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 ID for the family to retrieve

Type: UInt64

Default: None

Constraints: Must be a valid family ID.

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

Name Description

Fam

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

Type: Fam

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.