Platform API

DeleteMedia

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

**DeleteMedia** Parameters:
Name	Parameter	Data Type	Required	Description
MediaFileId	query	Guid	Yes	Guid of the Media File to be deleted.
FileName	query	string	Yes	File Name to be deleted.
ApplianceId	query	Guid	Yes	Appliance from which media file is to be deleted.
ContainerName	query	string	Yes	Container from which media file is to be deleted. Defaults to 'attachments' container for attachments.
ConnectedObjectId	query	Guid	Yes	Object connected to the attachment being deleted.
ConnectedObjectLicenseeId	query	Guid	Yes	Licensee Id of the Object owner for which primary image is to be uploaded.
IsPrimary	query	bool	No	Is the media file being deleted the primary file linked to the object?.

**DeleteMediaResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

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

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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