Platform API

SaveMedia

The following routes are available for this service:
All Verbs	/api/json/reply/savemedia
All Verbs	/api/media
All Verbs	/api/media/userprofile

import Foundation
import ServiceStack

public class SaveMedia : Codable
{
    /**
    * The media file Id to use.
    */
    // @ApiMember(DataType="Guid", Description="The media file Id to use.", Name="MediaFileId", ParameterType="query")
    public var mediaFileId:String

    public var mediaName:String
    public var mediaCaptured:Date
    /**
    * 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 var contactId:String

    /**
    * 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 var sessionId:String

    public var applianceId:String
    public var containerName:String
    public var imageWidth:Int?
    public var imageHeight:Int?

    required public init(){}
}

public class SaveMediaResponse : Codable
{
    /**
    * Media File Guid
    */
    // @ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")
    public var erosMediaFileId:String

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

    /**
    * 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 var originalFileName:String

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

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

    /**
    * Service Stack Response Status.
    */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift SaveMedia 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/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
		}
	}
}