Booklinker.API

<back to all web services

GetProductMetadataRequest

The following routes are available for this service:
GET/v1/product/metadata
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
{

    @DataContract
    public static class GetProductMetadataRequest
    {
        @DataMember(Name="url")
        @SerializedName("url")
        @ApiMember(IsRequired=true)
        public String url = null;
        
        public String getUrl() { return url; }
        public GetProductMetadataRequest setUrl(String value) { this.url = value; return this; }
    }

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

        @DataMember(Name="isSupported")
        @SerializedName("isSupported")
        public Boolean isSupported = null;

        @DataMember(Name="responseStatus")
        @SerializedName("responseStatus")
        public ResponseStatus responseStatus = null;
        
        public ProductMetadata getProductMetadata() { return productMetadata; }
        public GetProductMetadataResponse setProductMetadata(ProductMetadata value) { this.productMetadata = value; return this; }
        public Boolean getIsSupported() { return isSupported; }
        public GetProductMetadataResponse setIsSupported(Boolean value) { this.isSupported = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetProductMetadataResponse 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 GetProductMetadataRequest 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.

GET /v1/product/metadata HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetProductMetadataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Responses">
  <isSupported>false</isSupported>
  <productMetadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.DTOs">
    <author xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.DTOs">String</author>
    <description xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.DTOs">String</description>
    <productImages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.DTOs" />
    <retailer xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.DTOs">String</retailer>
    <title xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.DTOs">String</title>
    <url i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.DTOs" />
  </productMetadata>
  <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>
</GetProductMetadataResponse>