FamRead

Description

The FamRead operation retrieves a read-only family record that cannot be modified and updated.

History

2008-08-19 Initial version without URL versioning

2009-03-03 Version URL's implemented

/FamilyTree/2009-03-03/Fam.svc

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

SOAP URI:
/Service/2009-03-18

REST URI [GET]:
/FamilyTree/2009-03-18/Fam.svc/Read/{FamOgfn}/Group/{GroupOgfn}

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

GroupOgfn

The OneGreatFamily ID for the group requesting the record

Type: UInt64

Default: None

Constraints: Must be a valid group ID.

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