Platform API

DeleteMedia

The following routes are available for this service:
DELETE	/api/media
DELETE	/api/attachments

import 'package:servicestack/servicestack.dart';

class DeleteMediaResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;

    DeleteMediaResponse({this.ResponseStatus});
    DeleteMediaResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "DeleteMediaResponse";
    TypeContext? context = _ctx;
}

class DeleteMedia implements IConvertible
{
    /**
    * Guid of the Media File to be deleted.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the Media File to be deleted.", IsRequired=true, Name="MediaFileId")
    String? MediaFileId;

    /**
    * File Name to be deleted.
    */
    // @ApiMember(DataType="string", Description="File Name to be deleted.", IsRequired=true, Name="FileName")
    String? FileName;

    /**
    * Appliance from which media file is to be deleted.
    */
    // @ApiMember(DataType="Guid", Description="Appliance from which media file is to be deleted.", IsRequired=true, Name="ApplianceId")
    String? ApplianceId;

    /**
    * Container from which media file is to be deleted. Defaults to 'attachments' container for attachments.
    */
    // @ApiMember(DataType="string", Description="Container from which media file is to be deleted. Defaults to 'attachments' container for attachments.", IsRequired=true, Name="ContainerName")
    String? ContainerName;

    /**
    * Object connected to the attachment being deleted.
    */
    // @ApiMember(DataType="Guid", Description="Object connected to the attachment being deleted.", IsRequired=true, Name="ConnectedObjectId")
    String? ConnectedObjectId;

    /**
    * Licensee Id of the Object owner for which primary image is to be uploaded.
    */
    // @ApiMember(DataType="Guid", Description="Licensee Id of the Object owner for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectLicenseeId")
    String? ConnectedObjectLicenseeId;

    /**
    * Is the media file being deleted the primary file linked to the object?.
    */
    // @ApiMember(DataType="bool", Description="Is the media file being deleted the primary file linked to the object?.", Name="IsPrimary")
    bool? IsPrimary;

    DeleteMedia({this.MediaFileId,this.FileName,this.ApplianceId,this.ContainerName,this.ConnectedObjectId,this.ConnectedObjectLicenseeId,this.IsPrimary});
    DeleteMedia.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MediaFileId = json['MediaFileId'];
        FileName = json['FileName'];
        ApplianceId = json['ApplianceId'];
        ContainerName = json['ContainerName'];
        ConnectedObjectId = json['ConnectedObjectId'];
        ConnectedObjectLicenseeId = json['ConnectedObjectLicenseeId'];
        IsPrimary = json['IsPrimary'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MediaFileId': MediaFileId,
        'FileName': FileName,
        'ApplianceId': ApplianceId,
        'ContainerName': ContainerName,
        'ConnectedObjectId': ConnectedObjectId,
        'ConnectedObjectLicenseeId': ConnectedObjectLicenseeId,
        'IsPrimary': IsPrimary
    };

    getTypeName() => "DeleteMedia";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'DeleteMediaResponse': TypeInfo(TypeOf.Class, create:() => DeleteMediaResponse()),
    'DeleteMedia': TypeInfo(TypeOf.Class, create:() => DeleteMedia()),
});

Dart 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"}}}