Booklinker.API

<back to all web services

PostLinkCreationRequest

Requires Authentication
The following routes are available for this service:
POST/v1/links
POST/v1/complete-link-creation-requests
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 PostLinkCreationRequest extends PostLinkCreationRequestBase
    {
        @DataMember(Name="code")
        @SerializedName("code")
        public String code = null;
        
        public String getCode() { return code; }
        public PostLinkCreationRequest setCode(String value) { this.code = 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 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 PostLinkCreationRequest 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 HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostLinkCreationRequest 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>
  <Code>String</Code>
</PostLinkCreationRequest>
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>