Platform API

<back to all web services

DeleteMedia

Requires Authentication
The following routes are available for this service:
DELETE/api/media
DELETE/api/attachments
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Saguna.Common.WebAPIModel.ServiceModels;

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 virtual Guid MediaFileId { get; set; }

        ///<summary>
        ///File Name to be deleted.
        ///</summary>
        [ApiMember(DataType="string", Description="File Name to be deleted.", IsRequired=true, Name="FileName")]
        public virtual string FileName { 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")]
        public virtual Guid ApplianceId { 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")]
        public virtual string ContainerName { 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")]
        public virtual Guid ConnectedObjectId { 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")]
        public virtual Guid ConnectedObjectLicenseeId { 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")]
        public virtual bool IsPrimary { get; set; }
    }

    public partial class DeleteMediaResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# DeleteMedia DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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"}}}