Booklinker.API

PostCollectionRequest

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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<PostCollectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Requests">
  <aliasCode>String</aliasCode>
  <aliasDomain>String</aliasDomain>
  <collectionSettingsId>String</collectionSettingsId>
  <linkIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <title>String</title>
</PostCollectionRequest>

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

<PostCollectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses">
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
  <data i:nil="true" />
</PostCollectionResponse>