Booklinker.API

<back to all web services

PostPendingLinkRequest

Requires Authentication
The following routes are available for this service:
POST/v1/links/pending
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 PostPendingLinkRequest
    {
        [DataMember(Name="token")]
        [ApiMember(IsRequired=true, Name="token")]
        public virtual string Token { get; set; }
    }

}

namespace Booklinker.API.ServiceModel.V1.Responses
{
    [DataContract]
    public partial class PostPendingLinkResponse
    {
        [DataMember(Name="url")]
        public virtual string Url { get; set; }

        [DataMember(Name="productMetadata")]
        public virtual ProductMetadata ProductMetadata { get; set; }

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

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

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

        [DataMember(Name="baseCode")]
        public virtual string BaseCode { 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# PostPendingLinkRequest 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.

POST /v1/links/pending HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	url: String,
	productMetadata: 
	{
		title: String,
		author: String,
		description: String,
		retailer: String
	},
	domain: String,
	code: String,
	baseDomain: String,
	baseCode: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}