Individuals Compare

Description

The IndiCompare operation compares two individual records by OGFN and determines if they match. If Automerge is true and the individuals match, they will be merged together.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Indi.svc/Compare/Indi/{indiOGFN1}/Indi/{indiOGFN2}?AutoMergeIfMatch=[true|false]&SessionId={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Indi.svc/Compare/Indi/12345/Indi/67890?AutoMergeIfMatch=false&SessionId=gl4q23cwofpshi55sg1pvc3o
Success Response Payload 
140
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

SessionId

The current session Id

Type: string

Default: None

Yes

AutoMergeIfMatch

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

Type: bool

Default: None

Constraints:

Yes

Request Parameters

Name Description Required

indiOgfn1

The OneGreatFamily ID for the first individual to compare

Type: UInt64

Default: None

Constraints: Must be a valid individual ID.

Yes

indiOgfn2

The OneGreatFamily ID for the second individual to compare

Type: UInt64

Default: None

Constraints: Must be a valid individual ID.

Yes

Response Elements

The only thing returned is the return code below:

Name Description

UInt32

This operation returns number or match score representing how well the two individuals compare.

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.