| 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;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DeleteMediaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</DeleteMediaResponse>