| DELETE | /api/media | ||
|---|---|---|---|
| DELETE | /api/attachments |
namespace Eros.Saguna.Common.WebAPIModel.ServiceModels
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type DeleteMediaResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type 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")>]
member val MediaFileId:Guid = new Guid() with get,set
///<summary>
///File Name to be deleted.
///</summary>
[<ApiMember(DataType="string", Description="File Name to be deleted.", IsRequired=true, Name="FileName")>]
member val FileName:String = null with get,set
///<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")>]
member val ApplianceId:Guid = new Guid() with get,set
///<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")>]
member val ContainerName:String = null with get,set
///<summary>
///Object connected to the attachment being deleted.
///</summary>
[<ApiMember(DataType="Guid", Description="Object connected to the attachment being deleted.", IsRequired=true, Name="ConnectedObjectId")>]
member val ConnectedObjectId:Guid = new Guid() with get,set
///<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")>]
member val ConnectedObjectLicenseeId:Guid = new Guid() with get,set
///<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")>]
member val IsPrimary:Boolean = new Boolean() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}