Booklinker.API

<back to all web services

GetProductMetadataRequest

The following routes are available for this service:
GET/v1/product/metadata
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Booklinker.API.ServiceModel.V1.Requests;
using Booklinker.API.ServiceModel.V1.Responses;
using Booklinker.API.ServiceModel.V1.DTOs;
using ProductAPI.Contracts.V1.DTOs;

namespace Booklinker.API.ServiceModel.V1.DTOs
{
    [DataContract]
    public partial class ProductMetadata
        : ProductMetadata
    {
    }

}

namespace Booklinker.API.ServiceModel.V1.Requests
{
    [DataContract]
    public partial class GetProductMetadataRequest
    {
        [DataMember(Name="url")]
        [ApiMember(IsRequired=true)]
        public virtual string Url { get; set; }
    }

}

namespace Booklinker.API.ServiceModel.V1.Responses
{
    [DataContract]
    public partial class GetProductMetadataResponse
    {
        [DataMember(Name="productMetadata")]
        public virtual ProductMetadata ProductMetadata { get; set; }

        [DataMember(Name="isSupported")]
        public virtual bool IsSupported { get; set; }

        [DataMember(Name="responseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace ProductAPI.Contracts.V1.DTOs
{
    [DataContract]
    public partial class ProductMetadata
    {
        [DataMember(Name="title")]
        public virtual string Title { get; set; }

        [DataMember(Name="author")]
        public virtual string Author { get; set; }

        [DataMember(Name="url")]
        public virtual Uri Url { get; set; }

        [DataMember(Name="description")]
        public virtual string Description { get; set; }

        [DataMember(Name="retailer")]
        public virtual string Retailer { get; set; }

        [DataMember(Name="productImages")]
        public virtual IDictionary<string, Uri> ProductImages { get; set; }
    }

}

C# GetProductMetadataRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	productMetadata: 
	{
		title: String,
		author: String,
		description: String,
		retailer: String
	},
	isSupported: False,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}