Platform API

<back to all web services

UploadFile

Requires Authentication
The following routes are available for this service:
All Verbs/api/media/file
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class UploadFile
    {
        public String Path = null;
        public Date MediaCaptured = null;
        public UUID ContactId = null;
        public UUID ApplianceId = null;
        public Integer ImageWidth = null;
        public Integer ImageHeight = null;
        
        public String getPath() { return Path; }
        public UploadFile setPath(String value) { this.Path = value; return this; }
        public Date getMediaCaptured() { return MediaCaptured; }
        public UploadFile setMediaCaptured(Date value) { this.MediaCaptured = value; return this; }
        public UUID getContactId() { return ContactId; }
        public UploadFile setContactId(UUID value) { this.ContactId = value; return this; }
        public UUID getApplianceId() { return ApplianceId; }
        public UploadFile setApplianceId(UUID value) { this.ApplianceId = value; return this; }
        public Integer getImageWidth() { return ImageWidth; }
        public UploadFile setImageWidth(Integer value) { this.ImageWidth = value; return this; }
        public Integer getImageHeight() { return ImageHeight; }
        public UploadFile setImageHeight(Integer value) { this.ImageHeight = value; return this; }
    }

    public static class SaveMediaResponse
    {
        /**
        * Media File Guid
        */
        @ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")
        public UUID ErosMediaFileId = null;

        /**
        * Media File Name
        */
        @ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")
        public String MediaName = null;

        /**
        * The original name of the media being saved.
        */
        @ApiMember(DataType="string", Description="The original name of the media being saved.", Name="OriginalFileName", ParameterType="query")
        public String OriginalFileName = null;

        /**
        * Url of the media file.
        */
        @ApiMember(DataType="string", Description="Url of the media file.", Name="MediaFileUrl", ParameterType="query")
        public String MediaFileUrl = null;

        /**
        * Url of the media file thumbnail.
        */
        @ApiMember(DataType="string", Description="Url of the media file thumbnail.", Name="MediaFileThumbnailUrl", ParameterType="query")
        public String MediaFileThumbnailUrl = null;

        /**
        * Service Stack Response Status.
        */
        @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
        public ResponseStatus ResponseStatus = null;
        
        public UUID getErosMediaFileId() { return ErosMediaFileId; }
        public SaveMediaResponse setErosMediaFileId(UUID value) { this.ErosMediaFileId = value; return this; }
        public String getMediaName() { return MediaName; }
        public SaveMediaResponse setMediaName(String value) { this.MediaName = value; return this; }
        public String getOriginalFileName() { return OriginalFileName; }
        public SaveMediaResponse setOriginalFileName(String value) { this.OriginalFileName = value; return this; }
        public String getMediaFileUrl() { return MediaFileUrl; }
        public SaveMediaResponse setMediaFileUrl(String value) { this.MediaFileUrl = value; return this; }
        public String getMediaFileThumbnailUrl() { return MediaFileThumbnailUrl; }
        public SaveMediaResponse setMediaFileThumbnailUrl(String value) { this.MediaFileThumbnailUrl = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SaveMediaResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java UploadFile DTOs

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.

POST /api/media/file HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Path: String,
	MediaCaptured: 0001-01-01,
	ImageWidth: 0,
	ImageHeight: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MediaName: String,
	OriginalFileName: String,
	MediaFileUrl: String,
	MediaFileThumbnailUrl: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}