Booklinker.API

<back to all web services

GetIsbnMetadataRequest

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

export class GetIsbnMetadataRequestBase
{
    // @ApiMember(IsRequired=true, Name="isbn")
    public isbn: string;

    public constructor(init?: Partial<GetIsbnMetadataRequestBase>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ProductMetadata extends ProductMetadata
{

    public constructor(init?: Partial<ProductMetadata>) { super(init); (Object as any).assign(this, init); }
}

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

    // @DataMember(Name="isSupported")
    public isSupported: boolean;

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

    public constructor(init?: Partial<GetProductMetadataResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetIsbnMetadataRequest extends GetIsbnMetadataRequestBase implements IGetIsbnMetadataRequest
{
    // @DataMember(Name="isbn")
    // @ApiMember(IsRequired=true)
    public isbn: string;

    public constructor(init?: Partial<GetIsbnMetadataRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class ProductMetadata
{
    // @DataMember(Name="title")
    public title: string;

    // @DataMember(Name="author")
    public author: string;

    // @DataMember(Name="url")
    public url: string;

    // @DataMember(Name="description")
    public description: string;

    // @DataMember(Name="retailer")
    public retailer: string;

    // @DataMember(Name="productImages")
    public productImages: { [index:string]: string; };

    public constructor(init?: Partial<ProductMetadata>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}