FamLock

Description

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

History

2008-08-19 Initial version without URL versioning

2009-03-03 Version URL's implemented

2009-03-18 Seperate SOAP and REST URL's

2009-09-09 Added SessionId as parameter

URI's

SOAP URI:
/Service/2009-09-09

REST URI [GET]:
/FamilyTree/2009-09-09/Fam.svc/Lock/{FamOgfn}

Request 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

The only thing returned is the aggregate below:

Name Description

Fam

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

Type: FamWS