Booklinker.API

<back to all web services

PostUnclaimedLinkCreationRequest

The following routes are available for this service:
POST/v1/links/unclaimed
import 'package:servicestack/servicestack.dart';

// @DataContract
class PostLinkCreationRequestBase implements IConvertible
{
    // @DataMember(Name="url")
    // @ApiMember(IsRequired=true)
    String? url;

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

    // @DataMember(Name="parameterKeyValues")
    Map<String,String?>? parameterKeyValues;

    PostLinkCreationRequestBase({this.url,this.domain,this.parameterKeyValues});
    PostLinkCreationRequestBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        url = json['url'];
        domain = json['domain'];
        parameterKeyValues = JsonConverters.toStringMap(json['parameterKeyValues']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'url': url,
        'domain': domain,
        'parameterKeyValues': parameterKeyValues
    };

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

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

// @DataContract
class PostLinkCreationResponse implements IConvertible
{
    // @DataMember(Name="success")
    bool? success;

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

    // @DataMember(Name="destinations")
    List<ProductMetadata>? destinations;

    // @DataMember(Name="responseStatus")
    ResponseStatus? responseStatus;

    PostLinkCreationResponse({this.success,this.linkResult,this.destinations,this.responseStatus});
    PostLinkCreationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

// @DataContract
class AffiliateTokens implements IConvertible
{
    // @DataMember(Name="guid")
    String? guid;

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

    // @DataMember(Name="affiliateTokens")
    Map<String,String?>? affiliateTokens;

    AffiliateTokens({this.guid,this.programGuid,this.affiliateTokens});
    AffiliateTokens.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        guid = json['guid'];
        programGuid = json['programGuid'];
        affiliateTokens = JsonConverters.toStringMap(json['tokens']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'guid': guid,
        'programGuid': programGuid,
        'affiliateTokens': affiliateTokens
    };

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

class PostUnclaimedLinkCreationRequest extends PostLinkCreationRequestBase implements IConvertible
{
    // @DataMember(Name="affiliatePrograms")
    List<AffiliateTokens>? affiliatePrograms;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'affiliatePrograms': JsonConverters.toJson(affiliatePrograms,'List<AffiliateTokens>',context!)
    });

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

// @DataContract
abstract class ProductMetadata
{
    // @DataMember(Name="title")
    String? title;

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

    // @DataMember(Name="url")
    Uri? url;

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

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

    // @DataMember(Name="productImages")
    Map<String,Uri?>? productImages;

    ProductMetadata({this.title,this.author,this.url,this.description,this.retailer,this.productImages});
    ProductMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        title = json['title'];
        author = json['author'];
        url = JsonConverters.fromJson(json['url'],'Uri',context!);
        description = json['description'];
        retailer = json['retailer'];
        productImages = JsonConverters.fromJson(json['productImages'],'Map<String,Uri?>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'title': title,
        'author': author,
        'url': JsonConverters.toJson(url,'Uri',context!),
        'description': description,
        'retailer': retailer,
        'productImages': JsonConverters.toJson(productImages,'Map<String,Uri?>',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'api.booklinker.com', types: <String, TypeInfo> {
    'PostLinkCreationRequestBase': TypeInfo(TypeOf.Class, create:() => PostLinkCreationRequestBase()),
    'ProductMetadata': TypeInfo(TypeOf.Class, create:() => ProductMetadata()),
    'PostLinkCreationResponse': TypeInfo(TypeOf.Class, create:() => PostLinkCreationResponse()),
    'List<ProductMetadata>': TypeInfo(TypeOf.Class, create:() => <ProductMetadata>[]),
    'AffiliateTokens': TypeInfo(TypeOf.Class, create:() => AffiliateTokens()),
    'PostUnclaimedLinkCreationRequest': TypeInfo(TypeOf.Class, create:() => PostUnclaimedLinkCreationRequest()),
    'List<AffiliateTokens>': TypeInfo(TypeOf.Class, create:() => <AffiliateTokens>[]),
    'Uri': TypeInfo(TypeOf.Class, create:() => Uri()),
    'Map<String,Uri?>': TypeInfo(TypeOf.Class, create:() => Map<String,Uri?>()),
});

Dart PostUnclaimedLinkCreationRequest 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 /v1/links/unclaimed HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostUnclaimedLinkCreationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Requests">
  <domain>String</domain>
  <parameterKeyValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </parameterKeyValues>
  <url>String</url>
  <AffiliatePrograms xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.DTOs">
    <d2p1:AffiliateTokens>
      <d2p1:affiliateTokens xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:affiliateTokens>
      <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
      <d2p1:programGuid>00000000-0000-0000-0000-000000000000</d2p1:programGuid>
    </d2p1:AffiliateTokens>
  </AffiliatePrograms>
</PostUnclaimedLinkCreationRequest>

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

<PostLinkCreationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Responses">
  <destinations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.DTOs" i:nil="true" />
  <linkResult>String</linkResult>
  <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>
  <success>false</success>
</PostLinkCreationResponse>