Platform API

GetAttachments

The following routes are available for this service:
All Verbs	/api/attachments/{ConnectedObjectId}

import 'package:servicestack/servicestack.dart';

class MediaModel implements IConvertible
{
    String? MediaFileId;
    String? MediaName;
    String? FileContent;
    String? FileContentType;
    String? FilePath;
    String? OriginalFileName;
    int? ImageWidth;
    int? ImageHeight;
    int? FileSizeKB;
    String? BlobUriRaw;
    String? BlobUriFull;
    String? BlobUriThumbnail;
    String? WatermarkUri;
    DateTime? CapturedDate;
    String? CapturedByContactId;
    String? CapturedByContactName;
    String? CapturedByContactThumbnailUrl;
    String? Notes;
    String? ResourceActionName;
    String? LocationVerified;
    String? TrafficLightLocationVerified;
    String? AudienceLevel;
    String? WorksFor;

    MediaModel({this.MediaFileId,this.MediaName,this.FileContent,this.FileContentType,this.FilePath,this.OriginalFileName,this.ImageWidth,this.ImageHeight,this.FileSizeKB,this.BlobUriRaw,this.BlobUriFull,this.BlobUriThumbnail,this.WatermarkUri,this.CapturedDate,this.CapturedByContactId,this.CapturedByContactName,this.CapturedByContactThumbnailUrl,this.Notes,this.ResourceActionName,this.LocationVerified,this.TrafficLightLocationVerified,this.AudienceLevel,this.WorksFor});
    MediaModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MediaFileId = json['MediaFileId'];
        MediaName = json['MediaName'];
        FileContent = json['FileContent'];
        FileContentType = json['FileContentType'];
        FilePath = json['FilePath'];
        OriginalFileName = json['OriginalFileName'];
        ImageWidth = json['ImageWidth'];
        ImageHeight = json['ImageHeight'];
        FileSizeKB = json['FileSizeKB'];
        BlobUriRaw = json['BlobUriRaw'];
        BlobUriFull = json['BlobUriFull'];
        BlobUriThumbnail = json['BlobUriThumbnail'];
        WatermarkUri = json['WatermarkUri'];
        CapturedDate = JsonConverters.fromJson(json['CapturedDate'],'DateTime',context!);
        CapturedByContactId = json['CapturedByContactId'];
        CapturedByContactName = json['CapturedByContactName'];
        CapturedByContactThumbnailUrl = json['CapturedByContactThumbnailUrl'];
        Notes = json['Notes'];
        ResourceActionName = json['ResourceActionName'];
        LocationVerified = json['LocationVerified'];
        TrafficLightLocationVerified = json['TrafficLightLocationVerified'];
        AudienceLevel = json['AudienceLevel'];
        WorksFor = json['WorksFor'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MediaFileId': MediaFileId,
        'MediaName': MediaName,
        'FileContent': FileContent,
        'FileContentType': FileContentType,
        'FilePath': FilePath,
        'OriginalFileName': OriginalFileName,
        'ImageWidth': ImageWidth,
        'ImageHeight': ImageHeight,
        'FileSizeKB': FileSizeKB,
        'BlobUriRaw': BlobUriRaw,
        'BlobUriFull': BlobUriFull,
        'BlobUriThumbnail': BlobUriThumbnail,
        'WatermarkUri': WatermarkUri,
        'CapturedDate': JsonConverters.toJson(CapturedDate,'DateTime',context!),
        'CapturedByContactId': CapturedByContactId,
        'CapturedByContactName': CapturedByContactName,
        'CapturedByContactThumbnailUrl': CapturedByContactThumbnailUrl,
        'Notes': Notes,
        'ResourceActionName': ResourceActionName,
        'LocationVerified': LocationVerified,
        'TrafficLightLocationVerified': TrafficLightLocationVerified,
        'AudienceLevel': AudienceLevel,
        'WorksFor': WorksFor
    };

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

// @ApiResponse(Description="Returns list of attachments linked to an object.")
class GetAttachmentsResponse implements IConvertible
{
    List<MediaModel>? Attachments;
    ResponseStatus? ResponseStatus;

    GetAttachmentsResponse({this.Attachments,this.ResponseStatus});
    GetAttachmentsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Attachments = JsonConverters.fromJson(json['Attachments'],'List<MediaModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Attachments': JsonConverters.toJson(Attachments,'List<MediaModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class GetAttachments implements IConvertible
{
    /**
    * Object for which primary image is to be uploaded.
    */
    // @ApiMember(DataType="Guid", Description="Object for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectId")
    String? ConnectedObjectId;

    GetAttachments({this.ConnectedObjectId});
    GetAttachments.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ConnectedObjectId = json['ConnectedObjectId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ConnectedObjectId': ConnectedObjectId
    };

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'MediaModel': TypeInfo(TypeOf.Class, create:() => MediaModel()),
    'GetAttachmentsResponse': TypeInfo(TypeOf.Class, create:() => GetAttachmentsResponse()),
    'List<MediaModel>': TypeInfo(TypeOf.Class, create:() => <MediaModel>[]),
    'GetAttachments': TypeInfo(TypeOf.Class, create:() => GetAttachments()),
});

Dart GetAttachments DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/attachments/{ConnectedObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ConnectedObjectId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Attachments":[{"MediaFileId":"00000000-0000-0000-0000-000000000000","MediaName":"String","FileContent":"String","FileContentType":"String","FilePath":"String","OriginalFileName":"String","ImageWidth":0,"ImageHeight":0,"FileSizeKB":0,"BlobUriRaw":"String","BlobUriFull":"String","BlobUriThumbnail":"String","WatermarkUri":"String","CapturedDate":"0001-01-01T00:00:00.0000000","CapturedByContactId":"00000000000000000000000000000000","CapturedByContactName":"String","CapturedByContactThumbnailUrl":"String","Notes":"String","ResourceActionName":"String","LocationVerified":"String","TrafficLightLocationVerified":"00000000-0000-0000-0000-000000000000","AudienceLevel":"String","WorksFor":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}