Platform API

<back to all web services

UploadFile

Requires Authentication
The following routes are available for this service:
All Verbs/api/media/file
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Saguna.Common.WebAPIModel.ServiceModels

Namespace Global

    Namespace Eros.Saguna.Common.WebAPIModel.ServiceModels

        Public Partial Class SaveMediaResponse
            '''<Summary>
            '''Media File Guid
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Media File Guid", Name:="ErosMediaFileId", ParameterType:="query")>
            Public Overridable Property ErosMediaFileId As Guid

            '''<Summary>
            '''Media File Name
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Media File Name", Name:="MediaName", ParameterType:="query")>
            Public Overridable Property MediaName As String

            '''<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 Overridable Property OriginalFileName As String

            '''<Summary>
            '''Url of the media file.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Url of the media file.", Name:="MediaFileUrl", ParameterType:="query")>
            Public Overridable Property MediaFileUrl As String

            '''<Summary>
            '''Url of the media file thumbnail.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Url of the media file thumbnail.", Name:="MediaFileThumbnailUrl", ParameterType:="query")>
            Public Overridable Property MediaFileThumbnailUrl As String

            '''<Summary>
            '''Service Stack Response Status.
            '''</Summary>
            <ApiMember(DataType:="ResponseStatus", Description:="Service Stack Response Status.", Name:="ResponseStatus", ParameterType:="query")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class UploadFile
            Public Overridable Property Path As String
            Public Overridable Property MediaCaptured As Date
            Public Overridable Property ContactId As Guid
            Public Overridable Property ApplianceId As Guid
            Public Overridable Property ImageWidth As Integer?
            Public Overridable Property ImageHeight As Integer?
        End Class
    End Namespace
End Namespace

VB.NET UploadFile 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/media/file HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UploadFile 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>
  <ImageHeight>0</ImageHeight>
  <ImageWidth>0</ImageWidth>
  <MediaCaptured>0001-01-01T00:00:00</MediaCaptured>
  <Path>String</Path>
</UploadFile>
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>