Booklinker.API

<back to all web services

PostUnclaimedLinkCreationRequest

The following routes are available for this service:
POST/v1/links/unclaimed
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class PostUnclaimedLinkCreationRequest extends PostLinkCreationRequestBase
    {
        @DataMember(Name="affiliatePrograms")
        @SerializedName("affiliatePrograms")
        public ArrayList<AffiliateTokens> affiliatePrograms = null;
        
        public ArrayList<AffiliateTokens> getAffiliatePrograms() { return affiliatePrograms; }
        public PostUnclaimedLinkCreationRequest setAffiliatePrograms(ArrayList<AffiliateTokens> value) { this.affiliatePrograms = value; return this; }
    }

    @DataContract
    public static class PostLinkCreationRequestBase
    {
        @DataMember(Name="url")
        @SerializedName("url")
        @ApiMember(IsRequired=true)
        public String url = null;

        @DataMember(Name="domain")
        @SerializedName("domain")
        public String domain = null;

        @DataMember(Name="parameterKeyValues")
        @SerializedName("parameterKeyValues")
        public HashMap<String,String> parameterKeyValues = null;
        
        public String getUrl() { return url; }
        public PostLinkCreationRequestBase setUrl(String value) { this.url = value; return this; }
        public String getDomain() { return domain; }
        public PostLinkCreationRequestBase setDomain(String value) { this.domain = value; return this; }
        public HashMap<String,String> getParameterKeyValues() { return parameterKeyValues; }
        public PostLinkCreationRequestBase setParameterKeyValues(HashMap<String,String> value) { this.parameterKeyValues = value; return this; }
    }

    @DataContract
    public static class AffiliateTokens
    {
        @DataMember(Name="guid")
        @SerializedName("guid")
        public UUID guid = null;

        @DataMember(Name="programGuid")
        @SerializedName("programGuid")
        public UUID programGuid = null;

        @DataMember(Name="affiliateTokens")
        @SerializedName("affiliateTokens")
        public HashMap<String,String> tokens = null;
        
        public UUID getGuid() { return guid; }
        public AffiliateTokens setGuid(UUID value) { this.guid = value; return this; }
        public UUID getProgramGuid() { return programGuid; }
        public AffiliateTokens setProgramGuid(UUID value) { this.programGuid = value; return this; }
        public HashMap<String,String> getTokens() { return tokens; }
        public AffiliateTokens setTokens(HashMap<String,String> value) { this.tokens = value; return this; }
    }

    @DataContract
    public static class PostLinkCreationResponse
    {
        @DataMember(Name="success")
        @SerializedName("success")
        public Boolean success = null;

        @DataMember(Name="linkResult")
        @SerializedName("linkResult")
        public String linkResult = null;

        @DataMember(Name="destinations")
        @SerializedName("destinations")
        public ArrayList<ProductMetadata> destinations = null;

        @DataMember(Name="responseStatus")
        @SerializedName("responseStatus")
        public ResponseStatus responseStatus = null;
        
        public Boolean isSuccess() { return success; }
        public PostLinkCreationResponse setSuccess(Boolean value) { this.success = value; return this; }
        public String getLinkResult() { return linkResult; }
        public PostLinkCreationResponse setLinkResult(String value) { this.linkResult = value; return this; }
        public ArrayList<ProductMetadata> getDestinations() { return destinations; }
        public PostLinkCreationResponse setDestinations(ArrayList<ProductMetadata> value) { this.destinations = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PostLinkCreationResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class ProductMetadata extends ProductMetadata
    {
        
    }

    @DataContract
    public static class ProductMetadata
    {
        @DataMember(Name="title")
        @SerializedName("title")
        public String title = null;

        @DataMember(Name="author")
        @SerializedName("author")
        public String author = null;

        @DataMember(Name="url")
        @SerializedName("url")
        public Uri url = null;

        @DataMember(Name="description")
        @SerializedName("description")
        public String description = null;

        @DataMember(Name="retailer")
        @SerializedName("retailer")
        public String retailer = null;

        @DataMember(Name="productImages")
        @SerializedName("productImages")
        public HashMap<String,Uri> productImages = null;
        
        public String getTitle() { return title; }
        public ProductMetadata setTitle(String value) { this.title = value; return this; }
        public String getAuthor() { return author; }
        public ProductMetadata setAuthor(String value) { this.author = value; return this; }
        public Uri getUrl() { return url; }
        public ProductMetadata setUrl(Uri value) { this.url = value; return this; }
        public String getDescription() { return description; }
        public ProductMetadata setDescription(String value) { this.description = value; return this; }
        public String getRetailer() { return retailer; }
        public ProductMetadata setRetailer(String value) { this.retailer = value; return this; }
        public HashMap<String,Uri> getProductImages() { return productImages; }
        public ProductMetadata setProductImages(HashMap<String,Uri> value) { this.productImages = value; return this; }
    }

}

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

{"affiliatePrograms":[{"affiliateTokens":{"String":"String"}}],"url":"String","domain":"String","parameterKeyValues":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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