| DELETE | /api/media | ||
|---|---|---|---|
| DELETE | /api/attachments |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Saguna.Common.WebAPIModel.ServiceModels
Namespace Global
Namespace Eros.Saguna.Common.WebAPIModel.ServiceModels
Public Partial Class DeleteMedia
'''<Summary>
'''Guid of the Media File to be deleted.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Guid of the Media File to be deleted.", IsRequired:=true, Name:="MediaFileId")>
Public Overridable Property MediaFileId As Guid
'''<Summary>
'''File Name to be deleted.
'''</Summary>
<ApiMember(DataType:="string", Description:="File Name to be deleted.", IsRequired:=true, Name:="FileName")>
Public Overridable Property FileName As String
'''<Summary>
'''Appliance from which media file is to be deleted.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Appliance from which media file is to be deleted.", IsRequired:=true, Name:="ApplianceId")>
Public Overridable Property ApplianceId As Guid
'''<Summary>
'''Container from which media file is to be deleted. Defaults to 'attachments' container for attachments.
'''</Summary>
<ApiMember(DataType:="string", Description:="Container from which media file is to be deleted. Defaults to 'attachments' container for attachments.", IsRequired:=true, Name:="ContainerName")>
Public Overridable Property ContainerName As String
'''<Summary>
'''Object connected to the attachment being deleted.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Object connected to the attachment being deleted.", IsRequired:=true, Name:="ConnectedObjectId")>
Public Overridable Property ConnectedObjectId As Guid
'''<Summary>
'''Licensee Id of the Object owner for which primary image is to be uploaded.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Licensee Id of the Object owner for which primary image is to be uploaded.", IsRequired:=true, Name:="ConnectedObjectLicenseeId")>
Public Overridable Property ConnectedObjectLicenseeId As Guid
'''<Summary>
'''Is the media file being deleted the primary file linked to the object?.
'''</Summary>
<ApiMember(DataType:="bool", Description:="Is the media file being deleted the primary file linked to the object?.", Name:="IsPrimary")>
Public Overridable Property IsPrimary As Boolean
End Class
Public Partial Class DeleteMediaResponse
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /api/media HTTP/1.1 Host: pfapi.pstpf.com.au Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}