Platform API

<back to all web services

SaveMedia

Requires Authentication
The following routes are available for this service:
All Verbs/api/json/reply/savemedia
All Verbs/api/media
All Verbs/api/media/userprofile
namespace Eros.Saguna.Common.WebAPIModel.ServiceModels

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SaveMediaResponse() = 
        ///<summary>
        ///Media File Guid
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")>]
        member val ErosMediaFileId:Guid = new Guid() with get,set

        ///<summary>
        ///Media File Name
        ///</summary>
        [<ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")>]
        member val MediaName:String = null with get,set

        ///<summary>
        ///The original name of the media being saved.
        ///</summary>
        [<ApiMember(DataType="string", Description="The original name of the media being saved.", Name="OriginalFileName", ParameterType="query")>]
        member val OriginalFileName:String = null with get,set

        ///<summary>
        ///Url of the media file.
        ///</summary>
        [<ApiMember(DataType="string", Description="Url of the media file.", Name="MediaFileUrl", ParameterType="query")>]
        member val MediaFileUrl:String = null with get,set

        ///<summary>
        ///Url of the media file thumbnail.
        ///</summary>
        [<ApiMember(DataType="string", Description="Url of the media file thumbnail.", Name="MediaFileThumbnailUrl", ParameterType="query")>]
        member val MediaFileThumbnailUrl:String = null with get,set

        ///<summary>
        ///Service Stack Response Status.
        ///</summary>
        [<ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type SaveMedia() = 
        ///<summary>
        ///The media file Id to use.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The media file Id to use.", Name="MediaFileId", ParameterType="query")>]
        member val MediaFileId:Guid = new Guid() with get,set

        member val MediaName:String = null with get,set
        member val MediaCaptured:DateTime = new DateTime() with get,set
        ///<summary>
        ///The licensee's contact Id linked to the media file.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The licensee's contact Id linked to the media file.", IsRequired=true, Name="ContactId", ParameterType="query")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<summary>
        ///The id of the session in which the media file was created.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The id of the session in which the media file was created.", IsRequired=true, Name="SessionId", ParameterType="query")>]
        member val SessionId:Guid = new Guid() with get,set

        member val ApplianceId:Guid = new Guid() with get,set
        member val ContainerName:String = null with get,set
        member val ImageWidth:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ImageHeight:Nullable<Int32> = new Nullable<Int32>() with get,set

F# SaveMedia DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"MediaFileId":"00000000-0000-0000-0000-000000000000","MediaName":"String","MediaCaptured":"0001-01-01T00:00:00.0000000","ContactId":"00000000-0000-0000-0000-000000000000","SessionId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000","ContainerName":"String","ImageWidth":0,"ImageHeight":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ErosMediaFileId":"00000000-0000-0000-0000-000000000000","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"}}}