FamCompare

Description

The FamCompare operation compares two family records by OGFN and determines if they match. If Automerge is true and the families match, they will be merged together.

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/Compare/indi/{OGFN1}/indi/{OGFN2}?AutoMergeIfMatch={AutoMergeIfMatch}

Request Parameters

Name Description Required

indiOgfn1

The OneGreatFamily ID for the first family to compare

Type: UInt64

Default: None

Constraints: Must be a valid family ID.

Yes

indiOgfn2

The OneGreatFamily ID for the second family to compare

Type: UInt64

Default: None

Constraints: Must be a valid family ID.

Yes

AutoMergeIfMatch

Flag that if true will automatically merge OGFN1 and OGFN2 if the OGFNs match

Type: bool

Default: None

Constraints:

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

Name Description

UInt32

This operation returns a UInt32.