Platform API

<back to all web services

UploadFile

Requires Authentication
The following routes are available for this service:
All Verbs/api/media/file
import 'package:servicestack/servicestack.dart';

class SaveMediaResponse implements IConvertible
{
    /**
    * Media File Guid
    */
    // @ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")
    String? ErosMediaFileId;

    /**
    * Media File Name
    */
    // @ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")
    String? MediaName;

    /**
    * The original name of the media being saved.
    */
    // @ApiMember(DataType="string", Description="The original name of the media being saved.", Name="OriginalFileName", ParameterType="query")
    String? OriginalFileName;

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

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

    /**
    * Service Stack Response Status.
    */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    ResponseStatus? ResponseStatus;

    SaveMediaResponse({this.ErosMediaFileId,this.MediaName,this.OriginalFileName,this.MediaFileUrl,this.MediaFileThumbnailUrl,this.ResponseStatus});
    SaveMediaResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ErosMediaFileId = json['ErosMediaFileId'];
        MediaName = json['MediaName'];
        OriginalFileName = json['OriginalFileName'];
        MediaFileUrl = json['MediaFileUrl'];
        MediaFileThumbnailUrl = json['MediaFileThumbnailUrl'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ErosMediaFileId': ErosMediaFileId,
        'MediaName': MediaName,
        'OriginalFileName': OriginalFileName,
        'MediaFileUrl': MediaFileUrl,
        'MediaFileThumbnailUrl': MediaFileThumbnailUrl,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SaveMediaResponse";
    TypeContext? context = _ctx;
}

class UploadFile implements IConvertible
{
    String? Path;
    DateTime? MediaCaptured;
    String? ContactId;
    String? ApplianceId;
    int? ImageWidth;
    int? ImageHeight;

    UploadFile({this.Path,this.MediaCaptured,this.ContactId,this.ApplianceId,this.ImageWidth,this.ImageHeight});
    UploadFile.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Path = json['Path'];
        MediaCaptured = JsonConverters.fromJson(json['MediaCaptured'],'DateTime',context!);
        ContactId = json['ContactId'];
        ApplianceId = json['ApplianceId'];
        ImageWidth = json['ImageWidth'];
        ImageHeight = json['ImageHeight'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Path': Path,
        'MediaCaptured': JsonConverters.toJson(MediaCaptured,'DateTime',context!),
        'ContactId': ContactId,
        'ApplianceId': ApplianceId,
        'ImageWidth': ImageWidth,
        'ImageHeight': ImageHeight
    };

    getTypeName() => "UploadFile";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SaveMediaResponse': TypeInfo(TypeOf.Class, create:() => SaveMediaResponse()),
    'UploadFile': TypeInfo(TypeOf.Class, create:() => UploadFile()),
});

Dart UploadFile DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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"}}}