Platform API

<back to all web services

SaveMedia

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class SaveMedia
    {
        /**
        * The media file Id to use.
        */
        @ApiMember(DataType="Guid", Description="The media file Id to use.", Name="MediaFileId", ParameterType="query")
        public UUID MediaFileId = null;

        public String MediaName = null;
        public Date MediaCaptured = null;
        /**
        * The licensee's contact Id linked to the media file.
        */
        @ApiMember(DataType="Guid", Description="The licensee's contact Id linked to the media file.", IsRequired=true, Name="ContactId", ParameterType="query")
        public UUID ContactId = null;

        /**
        * The id of the session in which the media file was created.
        */
        @ApiMember(DataType="Guid", Description="The id of the session in which the media file was created.", IsRequired=true, Name="SessionId", ParameterType="query")
        public UUID SessionId = null;

        public UUID ApplianceId = null;
        public String ContainerName = null;
        public Integer ImageWidth = null;
        public Integer ImageHeight = null;
        
        public UUID getMediaFileId() { return MediaFileId; }
        public SaveMedia setMediaFileId(UUID value) { this.MediaFileId = value; return this; }
        public String getMediaName() { return MediaName; }
        public SaveMedia setMediaName(String value) { this.MediaName = value; return this; }
        public Date getMediaCaptured() { return MediaCaptured; }
        public SaveMedia setMediaCaptured(Date value) { this.MediaCaptured = value; return this; }
        public UUID getContactId() { return ContactId; }
        public SaveMedia setContactId(UUID value) { this.ContactId = value; return this; }
        public UUID getSessionId() { return SessionId; }
        public SaveMedia setSessionId(UUID value) { this.SessionId = value; return this; }
        public UUID getApplianceId() { return ApplianceId; }
        public SaveMedia setApplianceId(UUID value) { this.ApplianceId = value; return this; }
        public String getContainerName() { return ContainerName; }
        public SaveMedia setContainerName(String value) { this.ContainerName = value; return this; }
        public Integer getImageWidth() { return ImageWidth; }
        public SaveMedia setImageWidth(Integer value) { this.ImageWidth = value; return this; }
        public Integer getImageHeight() { return ImageHeight; }
        public SaveMedia 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 SaveMedia DTOs

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

{
	MediaName: String,
	MediaCaptured: 0001-01-01,
	ContainerName: String,
	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
		}
	}
}