Individual Media Delete

Description

Deletes media from an individual record.

URI

REST URI [GET]:
/v11.02/Individual.svc/MediaDelete?SessionId={SessionId}&MediaOgfn={mediaOgfn}&IndiOgfn={indiOgfn}

NOTES:

Media objects contain a reference count. Each time the Media object is linked to an Individual the reference count is incremented. Each time a link to an individual is deleted the count is decremented. The actual Media object is not deleted until the reference count reaches zero.

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Individual.svc/MediaDelete?SessionId=gl4q23cwofpshi55sg1pvc3o&MediaOgfn=12345&IndiOgfn=24345

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
</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
SessionId	The current session Id Type: string Default: None	Yes
MediaOgfn	The OneGreatFamily ID for the media object to delete Type: UInt64 Default: None Constraints: Must be a valid media object ID.	Yes
IndiOgfn	The OneGreatFamily ID for the Individual Type: UInt64 Default: None Constraints: Must be a valid individual object ID.	Yes

Name

Description

Required

SessionId

The current session Id

Type: string

Default: None

Yes

MediaOgfn

The OneGreatFamily ID for the media object to delete

Type: UInt64

Default: None

Constraints: Must be a valid media object ID.

Yes

IndiOgfn

The OneGreatFamily ID for the Individual

Type: UInt64

Default: None

Constraints: Must be a valid individual object ID.

Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be nothing Type: Nothing
`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.