Booklinker.API

PostUnclaimedLinkCreationRequest

The following routes are available for this service:
POST	/v1/links/unclaimed

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.DTOs;
using Booklinker.API.ServiceModel.V1.Responses;
using ProductAPI.Contracts.V1.DTOs;

namespace Booklinker.API.ServiceModel.V1.DTOs
{
    [DataContract]
    public partial class AffiliateTokens
    {
        [DataMember(Name="guid")]
        public virtual Guid Guid { get; set; }

        [DataMember(Name="programGuid")]
        public virtual Guid ProgramGuid { get; set; }

        [DataMember(Name="affiliateTokens")]
        public virtual Dictionary<string, string> Tokens { get; set; }
    }

    [DataContract]
    public partial class ProductMetadata
        : ProductMetadata
    {
    }

}

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

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

        [DataMember(Name="parameterKeyValues")]
        public virtual Dictionary<string, string> ParameterKeyValues { get; set; }
    }

    public partial class PostUnclaimedLinkCreationRequest
        : PostLinkCreationRequestBase
    {
        [DataMember(Name="affiliatePrograms")]
        public virtual List<AffiliateTokens> AffiliatePrograms { get; set; }
    }

}

namespace Booklinker.API.ServiceModel.V1.Responses
{
    [DataContract]
    public partial class PostLinkCreationResponse
    {
        [DataMember(Name="success")]
        public virtual bool Success { get; set; }

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

        [DataMember(Name="destinations")]
        public virtual IEnumerable<ProductMetadata> Destinations { 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# PostUnclaimedLinkCreationRequest 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/unclaimed HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	affiliatePrograms: 
	[
		{
			affiliateTokens: 
			{
				String: String
			}
		}
	],
	url: String,
	domain: String,
	parameterKeyValues: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False,
	linkResult: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}