| DELETE | /api/media | ||
|---|---|---|---|
| DELETE | /api/attachments |
import Foundation
import ServiceStack
public class DeleteMedia : Codable
{
/**
* Guid of the Media File to be deleted.
*/
// @ApiMember(DataType="Guid", Description="Guid of the Media File to be deleted.", IsRequired=true, Name="MediaFileId")
public var mediaFileId:String
/**
* File Name to be deleted.
*/
// @ApiMember(DataType="string", Description="File Name to be deleted.", IsRequired=true, Name="FileName")
public var fileName:String
/**
* 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")
public var applianceId:String
/**
* 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")
public var containerName:String
/**
* Object connected to the attachment being deleted.
*/
// @ApiMember(DataType="Guid", Description="Object connected to the attachment being deleted.", IsRequired=true, Name="ConnectedObjectId")
public var connectedObjectId:String
/**
* 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")
public var connectedObjectLicenseeId:String
/**
* 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")
public var isPrimary:Bool
required public init(){}
}
public class DeleteMediaResponse : Codable
{
public var responseStatus:ResponseStatus
required public init(){}
}
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>