Booklinker.API

<back to all web services

GetIsbnMetadataRequest

The following routes are available for this service:
GET/v1/product/metadata/isbn
import Foundation
import ServiceStack

// @DataContract
public class GetIsbnMetadataRequest : GetIsbnMetadataRequestBase, IGetIsbnMetadataRequest
{

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case isbn
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        isbn = try container.decodeIfPresent(String.self, forKey: .isbn)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if isbn != nil { try container.encode(isbn, forKey: .isbn) }
    }
}

public class GetIsbnMetadataRequestBase : Codable
{
    // @ApiMember(IsRequired=true, Name="isbn")
    public var isbn:String

    required public init(){}
}

// @DataContract
public class GetProductMetadataResponse : Codable
{
    // @DataMember(Name="productMetadata")
    public var productMetadata:ProductMetadata

    // @DataMember(Name="isSupported")
    public var isSupported:Bool

    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class ProductMetadata : ProductMetadata
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class ProductMetadata : Codable
{
    // @DataMember(Name="title")
    public var title:String

    // @DataMember(Name="author")
    public var author:String

    // @DataMember(Name="url")
    public var url:Uri

    // @DataMember(Name="description")
    public var description:String

    // @DataMember(Name="retailer")
    public var retailer:String

    // @DataMember(Name="productImages")
    public var productImages:[String:Uri]

    required public init(){}
}


Swift GetIsbnMetadataRequest 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/isbn 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
		}
	}
}