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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Saguna.Common.WebAPIModel.ServiceModels;

namespace Eros.Saguna.Common.WebAPIModel.ServiceModels
{
    public partial class SaveMedia
    {
        ///<summary>
        ///The media file Id to use.
        ///</summary>
        [ApiMember(DataType="Guid", Description="The media file Id to use.", Name="MediaFileId", ParameterType="query")]
        public virtual Guid MediaFileId { get; set; }

        public virtual string MediaName { get; set; }
        public virtual DateTime MediaCaptured { 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")]
        public virtual Guid ContactId { 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")]
        public virtual Guid SessionId { get; set; }

        public virtual Guid ApplianceId { get; set; }
        public virtual string ContainerName { get; set; }
        public virtual int? ImageWidth { get; set; }
        public virtual int? ImageHeight { get; set; }
    }

    public partial class SaveMediaResponse
    {
        ///<summary>
        ///Media File Guid
        ///</summary>
        [ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")]
        public virtual Guid ErosMediaFileId { get; set; }

        ///<summary>
        ///Media File Name
        ///</summary>
        [ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")]
        public virtual string MediaName { 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")]
        public virtual string OriginalFileName { get; set; }

        ///<summary>
        ///Url of the media file.
        ///</summary>
        [ApiMember(DataType="string", Description="Url of the media file.", Name="MediaFileUrl", ParameterType="query")]
        public virtual string MediaFileUrl { get; set; }

        ///<summary>
        ///Url of the media file thumbnail.
        ///</summary>
        [ApiMember(DataType="string", Description="Url of the media file thumbnail.", Name="MediaFileThumbnailUrl", ParameterType="query")]
        public virtual string MediaFileThumbnailUrl { get; set; }

        ///<summary>
        ///Service Stack Response Status.
        ///</summary>
        [ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# SaveMedia DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SaveMedia xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
  <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
  <ContainerName>String</ContainerName>
  <ImageHeight>0</ImageHeight>
  <ImageWidth>0</ImageWidth>
  <MediaCaptured>0001-01-01T00:00:00</MediaCaptured>
  <MediaFileId>00000000-0000-0000-0000-000000000000</MediaFileId>
  <MediaName>String</MediaName>
  <SessionId>00000000-0000-0000-0000-000000000000</SessionId>
</SaveMedia>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SaveMediaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ErosMediaFileId>00000000-0000-0000-0000-000000000000</ErosMediaFileId>
  <MediaFileThumbnailUrl>String</MediaFileThumbnailUrl>
  <MediaFileUrl>String</MediaFileUrl>
  <MediaName>String</MediaName>
  <OriginalFileName>String</OriginalFileName>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SaveMediaResponse>