| DELETE | /api/media | ||
|---|---|---|---|
| DELETE | /api/attachments |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class DeleteMedia
{
/**
* 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 UUID MediaFileId = null;
/**
* File Name to be deleted.
*/
@ApiMember(DataType="string", Description="File Name to be deleted.", IsRequired=true, Name="FileName")
public String FileName = null;
/**
* 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 UUID ApplianceId = null;
/**
* 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 String ContainerName = null;
/**
* Object connected to the attachment being deleted.
*/
@ApiMember(DataType="Guid", Description="Object connected to the attachment being deleted.", IsRequired=true, Name="ConnectedObjectId")
public UUID ConnectedObjectId = null;
/**
* 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 UUID ConnectedObjectLicenseeId = null;
/**
* 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 Boolean IsPrimary = null;
public UUID getMediaFileId() { return MediaFileId; }
public DeleteMedia setMediaFileId(UUID value) { this.MediaFileId = value; return this; }
public String getFileName() { return FileName; }
public DeleteMedia setFileName(String value) { this.FileName = value; return this; }
public UUID getApplianceId() { return ApplianceId; }
public DeleteMedia setApplianceId(UUID value) { this.ApplianceId = value; return this; }
public String getContainerName() { return ContainerName; }
public DeleteMedia setContainerName(String value) { this.ContainerName = value; return this; }
public UUID getConnectedObjectId() { return ConnectedObjectId; }
public DeleteMedia setConnectedObjectId(UUID value) { this.ConnectedObjectId = value; return this; }
public UUID getConnectedObjectLicenseeId() { return ConnectedObjectLicenseeId; }
public DeleteMedia setConnectedObjectLicenseeId(UUID value) { this.ConnectedObjectLicenseeId = value; return this; }
public Boolean getIsPrimary() { return IsPrimary; }
public DeleteMedia setIsPrimary(Boolean value) { this.IsPrimary = value; return this; }
}
public static class DeleteMediaResponse
{
public ResponseStatus ResponseStatus = null;
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public DeleteMediaResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}