Family Seperate

Description

The FamSeparate operation separates a family record into a list of new records. The new records are owned by a single group.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Family.svc/Separate/{FamOgfn}?SessionId={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Family.svc/Separate/12345?SessionId=24354354353451534514545
Success Response Payload 
<ArrayOfunsignedLong xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" >
  <unsignedLong>92929906</unsignedLong>
  <unsignedLong>92929907</unsignedLong>
</ArrayOfunsignedLong>
 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

FamOgfn

The OneGreatFamily ID for the family to separate

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

List of OGFNs

This operation returns list of OGFNs. Otherwise an error is returned.

Type: list of 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 aggregate. Retrieve the RestFault from the Webexception response property.