Family Separate

Description

This operation separates a family record into a list of new records. The new records are owned by each group that had a view.

URI

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

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Family.svc/Separate?SessionId=24354354353451534514545&FamOgfn=12345
Success Response Payload 
<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="a:ArrayOfunsignedLong">
 		<unsignedLong>92929906</unsignedLong>
		<unsignedLong>92929907</unsignedLong>
	</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

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

Result

This operation returns a Result Entity

Type: Result

Result.Value

Result.Value will be an array of UInt64 representing the ids of the Separated records

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.