Platform API

<back to all web services

SaveMedia

Requires Authentication
The following routes are available for this service:
All Verbs/api/json/reply/savemedia
All Verbs/api/media
All Verbs/api/media/userprofile
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 SaveMedia implements IConvertible
{
    /**
    * The media file Id to use.
    */
    // @ApiMember(DataType="Guid", Description="The media file Id to use.", Name="MediaFileId", ParameterType="query")
    String? MediaFileId;

    String? MediaName;
    DateTime? MediaCaptured;
    /**
    * 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")
    String? ContactId;

    /**
    * 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")
    String? SessionId;

    String? ApplianceId;
    String? ContainerName;
    int? ImageWidth;
    int? ImageHeight;

    SaveMedia({this.MediaFileId,this.MediaName,this.MediaCaptured,this.ContactId,this.SessionId,this.ApplianceId,this.ContainerName,this.ImageWidth,this.ImageHeight});
    SaveMedia.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

Dart SaveMedia 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/json/reply/savemedia HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"MediaFileId":"00000000-0000-0000-0000-000000000000","MediaName":"String","MediaCaptured":"0001-01-01T00:00:00.0000000","ContactId":"00000000-0000-0000-0000-000000000000","SessionId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000","ContainerName":"String","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"}}}