Families Merge

Description

The FamMerge operation forces two family records to be merged together.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Family.svc/Merge/fam/{OGFN1}/fam/{OGFN2}?SessionId={SessionId}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Family.svc/Merge/fam/34432345/fam/32452345?SessionId=43523454553451534514545

Fault Response Payload

<t;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
famOgfn1	The OneGreatFamily ID for the first family to merge Type: UInt64 Default: None Constraints: Must be a valid family ID.	Yes
famOgfn2	The OneGreatFamily ID for the second family to merge Type: UInt64 Default: None Constraints: Must be a valid family ID.	Yes
SessionId	The current session Id Type: string Default: None	Yes

Name

Description

Required

famOgfn1

The OneGreatFamily ID for the first family to merge

Type: UInt64

Default: None

Constraints: Must be a valid family ID.

Yes

famOgfn2

The OneGreatFamily ID for the second family to merge

Type: UInt64

Default: None

Constraints: Must be a valid family ID.

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

Name	Description
`UInt32`	This operation returns a UInt32. The return value is zero on success or non-zero if an error occurs.
`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.