Booklinker.API

GetShortLinkMetadataRequest

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Booklinker.API.ServiceModel.V1.Requests
Imports Booklinker.API.ServiceModel.V1.Responses
Imports Booklinker.API.ServiceModel.V1.DTOs
Imports ProductAPI.Contracts.V1.DTOs
Imports Booklinker.API.ServiceModel.DTOs.Shortlinks.ChoicePage

Namespace Global

    Namespace Booklinker.API.ServiceModel.DTOs.Shortlinks.ChoicePage

        <DataContract>
        Public Partial Class Destination
            <DataMember(Name:="isSuggestion")>
            Public Overridable Property IsSuggestion As Boolean

            <DataMember(Name:="isAutoSuggestion")>
            Public Overridable Property IsAutoSuggestion As Boolean

            <DataMember(Name:="destinationUrl")>
            Public Overridable Property DestinationUrl As String

            <DataMember(Name:="replacementButton")>
            Public Overridable Property ReplacementButton As String
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V1.DTOs

        <DataContract>
        Public Partial Class ProductMetadata
            Inherits ProductMetadata
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V1.Requests

        <DataContract>
        Public Partial Class GetShortLinkMetadataRequest
            <DataMember(Name:="domain")>
            Public Overridable Property AliasDomain As String

            <DataMember(Name:="code")>
            Public Overridable Property AliasCode As String
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V1.Responses

        <DataContract>
        Public Partial Class GetShortLinkMetadataResponse
            <DataMember(Name:="baseCode")>
            Public Overridable Property BaseCode As String

            <DataMember(Name:="domain")>
            Public Overridable Property Domain As String

            <DataMember(Name:="code")>
            Public Overridable Property Code As String

            <DataMember(Name:="productMetadata")>
            Public Overridable Property ProductMetadata As ProductMetadata

            <DataMember(Name:="destinations")>
            Public Overridable Property Destinations As List(Of Destination)

            <DataMember(Name:="responseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace ProductAPI.Contracts.V1.DTOs

        <DataContract>
        Public Partial Class ProductMetadata
            <DataMember(Name:="title")>
            Public Overridable Property Title As String

            <DataMember(Name:="author")>
            Public Overridable Property Author As String

            <DataMember(Name:="url")>
            Public Overridable Property Url As Uri

            <DataMember(Name:="description")>
            Public Overridable Property Description As String

            <DataMember(Name:="retailer")>
            Public Overridable Property Retailer As String

            <DataMember(Name:="productImages")>
            Public Overridable Property ProductImages As IDictionary(Of String, Uri)
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}