Platform API

<back to all web services

SaveMedia

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


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

    open var MediaName:String? = null
    open var MediaCaptured:Date? = 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")
    open var ContactId:UUID? = 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")
    open var SessionId:UUID? = null

    open var ApplianceId:UUID? = null
    open var ContainerName:String? = null
    open var ImageWidth:Int? = null
    open var ImageHeight:Int? = null
}

open class SaveMediaResponse
{
    /**
    * Media File Guid
    */
    @ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")
    open var ErosMediaFileId:UUID? = null

    /**
    * Media File Name
    */
    @ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")
    open var MediaName:String? = 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")
    open var OriginalFileName:String? = null

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

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

    /**
    * Service Stack Response Status.
    */
    @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin SaveMedia DTOs

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>