CollectionsAPI

PostCollectionSettingsRequest

The following routes are available for this service:
POST	/v4/collections/settings

import 'package:servicestack/servicestack.dart';

// @DataContract
class V4BaseRequest implements IConvertible
{
    V4BaseRequest();
    V4BaseRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "V4BaseRequest";
    TypeContext? context = _ctx;
}

enum SignatureAppearance
{
    None,
    Text,
    Upload,
}

// @DataContract
class CollectionSettingsBaseRequest extends V4BaseRequest implements ICollectionSettingsBaseRequest, IConvertible
{
    // @DataMember(Name="profileImageId")
    String? profileImageId;

    // @DataMember(Name="signatureImageId")
    String? signatureImageId;

    // @DataMember(Name="signatureText")
    String? signatureText;

    // @DataMember(Name="signatureFont")
    String? signatureFont;

    // @DataMember(Name="signatureAppearance")
    SignatureAppearance? signatureAppearance;

    CollectionSettingsBaseRequest({this.profileImageId,this.signatureImageId,this.signatureText,this.signatureFont,this.signatureAppearance});
    CollectionSettingsBaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        profileImageId = json['profileImageId'];
        signatureImageId = json['signatureImageId'];
        signatureText = json['signatureText'];
        signatureFont = json['signatureFont'];
        signatureAppearance = JsonConverters.fromJson(json['signatureAppearance'],'SignatureAppearance',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'profileImageId': profileImageId,
        'signatureImageId': signatureImageId,
        'signatureText': signatureText,
        'signatureFont': signatureFont,
        'signatureAppearance': JsonConverters.toJson(signatureAppearance,'SignatureAppearance',context!)
    });

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

// @DataContract
class V4BaseResponse implements IConvertible
{
    // @DataMember(Name="status")
    ResponseStatus? status;

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

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

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

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

// @DataContract
class PostCollectionSettingsResponse extends V4BaseResponse implements IPostCollectionSettingsResponse, IConvertible
{
    PostCollectionSettingsResponse();
    PostCollectionSettingsResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "PostCollectionSettingsResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class PostCollectionSettingsRequest extends CollectionSettingsBaseRequest implements IPostCollectionSettingsRequest, IConvertible
{
    PostCollectionSettingsRequest();
    PostCollectionSettingsRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "PostCollectionSettingsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'collections_api_zane.dev.platform.georiot.com', types: <String, TypeInfo> {
    'V4BaseRequest': TypeInfo(TypeOf.Class, create:() => V4BaseRequest()),
    'SignatureAppearance': TypeInfo(TypeOf.Enum, enumValues:SignatureAppearance.values),
    'CollectionSettingsBaseRequest': TypeInfo(TypeOf.Class, create:() => CollectionSettingsBaseRequest()),
    'V4BaseResponse': TypeInfo(TypeOf.Class, create:() => V4BaseResponse()),
    'PostCollectionSettingsResponse': TypeInfo(TypeOf.Class, create:() => PostCollectionSettingsResponse()),
    'PostCollectionSettingsRequest': TypeInfo(TypeOf.Class, create:() => PostCollectionSettingsRequest()),
});

Dart PostCollectionSettingsRequest 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 /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"profileImageId":"String","signatureImageId":"String","signatureText":"String","signatureFont":"String","signatureAppearance":"none"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}