Family Compare

Description

This 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.

URI

REST URI [GET]:
/v11.02/Family.svc/Compare?SessionId={sessionId}&FamOgfn1{OGFN1}&FamOgfn2={OGFN2}&AutoMergeIfMatch={true|false}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Family.svc/Compare?SessionId=43523454553451534514545&FamOgfn1=123432&FamOgfn2=3322113&AutoMergeIfMatch=true

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="a:unsignedLong">100</Value>
</Result>

Failed Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>27001</Code>
	<Message>Your developer Id does not have permissions to make this call</Message>
</Result>

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
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
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a UInt32 representing the score of how well they match Type: UInt64
`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` entity. Retrieve the RestFault from the Webexception response property.