Family Delete

Description

The Delete Family operation deletes a family record.

Version

2011-02-02

URI

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

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Family.svc/Delete/12345/Group/24543?SessionId=24354354353451534514545

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
FamOgfn	The OneGreatFamily ID for the family to delete 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

FamOgfn

The OneGreatFamily ID for the family to delete

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

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.

Name	Description
`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.