Platform API

<back to all web services

SaveImageAsObjectPrimary

Updates the specified objects primary image with the specified Images Media File ID.

Requires Authentication
The following routes are available for this service:
All Verbs/api/json/reply/SaveImageAsObjectPrimary
All Verbs/api/SaveImageAsObjectPrimary
All Verbs/api/SaveImageAsObjectPrimary/userprofile
import 'package:servicestack/servicestack.dart';

/**
* Updates the specified objects primary image with the specified Images Media File ID.
*/
// @Api(Description="Updates the specified objects primary image with the specified Images Media File ID.")
class SaveImageAsObjectPrimary implements IConvertible
{
    /**
    * Guid of the object whose primary image details we want to update.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the object whose primary image details we want to update.", IsRequired=true, Name="ObjectId", ParameterType="query")
    String? ObjectId;

    /**
    * Guid of the Media File that contains details of the image we want to be primary.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the Media File that contains details of the image we want to be primary.", IsRequired=true, Name="PrimaryImageMediaFileId", ParameterType="query")
    String? PrimaryImageMediaFileId;

    /**
    * URL to the full image.
    */
    // @ApiMember(DataType="Guid", Description="URL to the full image.", IsRequired=true, Name="BlobImageURL", ParameterType="query")
    String? BlobImageURL;

    /**
    * URL to the thumbnail image.
    */
    // @ApiMember(DataType="Guid", Description="URL to the thumbnail image.", IsRequired=true, Name="BlobImageURLThumbnail", ParameterType="query")
    String? BlobImageURLThumbnail;

    SaveImageAsObjectPrimary({this.ObjectId,this.PrimaryImageMediaFileId,this.BlobImageURL,this.BlobImageURLThumbnail});
    SaveImageAsObjectPrimary.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ObjectId = json['ObjectId'];
        PrimaryImageMediaFileId = json['PrimaryImageMediaFileId'];
        BlobImageURL = json['BlobImageURL'];
        BlobImageURLThumbnail = json['BlobImageURLThumbnail'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ObjectId': ObjectId,
        'PrimaryImageMediaFileId': PrimaryImageMediaFileId,
        'BlobImageURL': BlobImageURL,
        'BlobImageURLThumbnail': BlobImageURLThumbnail
    };

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

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

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

{"ObjectId":"00000000-0000-0000-0000-000000000000","PrimaryImageMediaFileId":"00000000-0000-0000-0000-000000000000","BlobImageURL":"String","BlobImageURLThumbnail":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}