Platform API

<back to all web services

UploadFile

Requires Authentication
The following routes are available for this service:
All Verbs/api/media/file
import Foundation
import ServiceStack

public class UploadFile : Codable
{
    public var path:String
    public var mediaCaptured:Date
    public var contactId:String
    public var applianceId:String
    public var imageWidth:Int?
    public var imageHeight:Int?

    required public init(){}
}

public class SaveMediaResponse : Codable
{
    /**
    * Media File Guid
    */
    // @ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")
    public var erosMediaFileId:String

    /**
    * Media File Name
    */
    // @ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")
    public var mediaName:String

    /**
    * 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 var originalFileName:String

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

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

    /**
    * Service Stack Response Status.
    */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift UploadFile DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Path":"String","MediaCaptured":"0001-01-01T00:00:00.0000000","ContactId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000","ImageWidth":0,"ImageHeight":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ErosMediaFileId":"00000000-0000-0000-0000-000000000000","MediaName":"String","OriginalFileName":"String","MediaFileUrl":"String","MediaFileThumbnailUrl":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}