Platform API

<back to all web services

DeleteMedia

Requires Authentication
The following routes are available for this service:
DELETE/api/media
DELETE/api/attachments
"use strict";
export class DeleteMediaResponse {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DeleteMedia {
    /** @param {{MediaFileId?:string,FileName?:string,ApplianceId?:string,ContainerName?:string,ConnectedObjectId?:string,ConnectedObjectLicenseeId?:string,IsPrimary?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Guid of the Media File to be deleted. */
    MediaFileId;
    /**
     * @type {string}
     * @description File Name to be deleted. */
    FileName;
    /**
     * @type {string}
     * @description Appliance from which media file is to be deleted. */
    ApplianceId;
    /**
     * @type {string}
     * @description Container from which media file is to be deleted. Defaults to 'attachments' container for attachments. */
    ContainerName;
    /**
     * @type {string}
     * @description Object connected to the attachment being deleted. */
    ConnectedObjectId;
    /**
     * @type {string}
     * @description Licensee Id of the Object owner for which primary image is to be uploaded. */
    ConnectedObjectLicenseeId;
    /**
     * @type {boolean}
     * @description Is the media file being deleted the primary file linked to the object?. */
    IsPrimary;
}

JavaScript DeleteMedia DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}