Individual Delete

Description

Deletes an individual record.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Indi.svc/Delete/{indiOgfn}?SessionId={SessionId}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Indi.svc/Delete/12345?SessionId=gl4q23cwofpshi55sg1pvc3o

Success Response Payload

<there is no response payload>

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
SessionId	The current session Id Type: string Default: None	Yes

Name

Description

Required

SessionId

The current session Id

Type: string

Default: None

Yes

Request Parameters

Name	Description	Required
IndiOgfn	The OneGreatFamily ID for the individual to delete Type: UInt64 Default: None Constraints: Must be a valid individual ID.	Yes

Name

Description

Required

IndiOgfn

The OneGreatFamily ID for the individual to delete

Type: UInt64

Default: None

Constraints: Must be a valid individual ID.

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.