Booklinker.API

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v2/collections
import 'package:servicestack/servicestack.dart';

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

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

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

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

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

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

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

// @DataContract
class PostCollectionResponse extends V2BaseResponse implements IPostCollectionResponse, IConvertible
{
    PostCollectionResponse();
    PostCollectionResponse.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() => "PostCollectionResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class PostCollectionRequest extends V2BaseRequest implements IPostCollectionRequest, IConvertible
{
    // @DataMember(Name="aliasDomain")
    String? aliasDomain;

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

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

    // @DataMember(Name="linkIds")
    List<String>? linkIds;

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

    PostCollectionRequest({this.aliasDomain,this.aliasCode,this.title,this.linkIds,this.collectionSettingsId});
    PostCollectionRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        aliasDomain = json['aliasDomain'];
        aliasCode = json['aliasCode'];
        title = json['title'];
        linkIds = JsonConverters.fromJson(json['linkIds'],'List<String>',context!);
        collectionSettingsId = json['collectionSettingsId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'aliasDomain': aliasDomain,
        'aliasCode': aliasCode,
        'title': title,
        'linkIds': JsonConverters.toJson(linkIds,'List<String>',context!),
        'collectionSettingsId': collectionSettingsId
    });

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

TypeContext _ctx = TypeContext(library: 'api.booklinker.com', types: <String, TypeInfo> {
    'V2BaseRequest': TypeInfo(TypeOf.Class, create:() => V2BaseRequest()),
    'V2BaseResponse': TypeInfo(TypeOf.Class, create:() => V2BaseResponse()),
    'PostCollectionResponse': TypeInfo(TypeOf.Class, create:() => PostCollectionResponse()),
    'PostCollectionRequest': TypeInfo(TypeOf.Class, create:() => PostCollectionRequest()),
});

Dart PostCollectionRequest 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 /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"aliasDomain":"String","aliasCode":"String","title":"String","collectionSettingsId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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