Platform API

<back to all web services

UploadFile

Requires Authentication
The following routes are available for this service:
All Verbs/api/media/file
"use strict";
export class SaveMediaResponse {
    /** @param {{ErosMediaFileId?:string,MediaName?:string,OriginalFileName?:string,MediaFileUrl?:string,MediaFileThumbnailUrl?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Media File Guid */
    ErosMediaFileId;
    /**
     * @type {string}
     * @description Media File Name */
    MediaName;
    /**
     * @type {string}
     * @description The original name of the media being saved. */
    OriginalFileName;
    /**
     * @type {string}
     * @description Url of the media file. */
    MediaFileUrl;
    /**
     * @type {string}
     * @description Url of the media file thumbnail. */
    MediaFileThumbnailUrl;
    /**
     * @type {ResponseStatus}
     * @description Service Stack Response Status. */
    ResponseStatus;
}
export class UploadFile {
    /** @param {{Path?:string,MediaCaptured?:string,ContactId?:string,ApplianceId?:string,ImageWidth?:number,ImageHeight?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Path;
    /** @type {string} */
    MediaCaptured;
    /** @type {string} */
    ContactId;
    /** @type {string} */
    ApplianceId;
    /** @type {?number} */
    ImageWidth;
    /** @type {?number} */
    ImageHeight;
}

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