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
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

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>