Booklinker.API

GetShortLinkMetadataRequest

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

import Foundation
import ServiceStack

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

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

    required public init(){}
}

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

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

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

    // @DataMember(Name="productMetadata")
    public var productMetadata:ProductMetadata

    // @DataMember(Name="destinations")
    public var destinations:[Destination]

    // @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(){}
}

// @DataContract
public class Destination : Codable
{
    // @DataMember(Name="isSuggestion")
    public var isSuggestion:Bool

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

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

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

    required public init(){}
}

Swift GetShortLinkMetadataRequest 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/shortlink/metadata HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv

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

{
	baseCode: String,
	domain: String,
	code: String,
	productMetadata: 
	{
		title: String,
		author: String,
		description: String,
		retailer: String
	},
	destinations: 
	[
		{
			isSuggestion: False,
			isAutoSuggestion: False,
			destinationUrl: String,
			replacementButton: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}