Booklinker.API

<back to all web services

GetShortLinkMetadataRequest

The following routes are available for this service:
GET/v1/shortlink/metadata
namespace Booklinker.API.ServiceModel.DTOs.Shortlinks.ChoicePage

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type ProductMetadata() = 
        [<DataMember(Name="title")>]
        member val Title:String = null with get,set

        [<DataMember(Name="author")>]
        member val Author:String = null with get,set

        [<DataMember(Name="url")>]
        member val Url:Uri = null with get,set

        [<DataMember(Name="description")>]
        member val Description:String = null with get,set

        [<DataMember(Name="retailer")>]
        member val Retailer:String = null with get,set

        [<DataMember(Name="productImages")>]
        member val ProductImages:IDictionary<String, Uri> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Destination() = 
        [<DataMember(Name="isSuggestion")>]
        member val IsSuggestion:Boolean = new Boolean() with get,set

        [<DataMember(Name="isAutoSuggestion")>]
        member val IsAutoSuggestion:Boolean = new Boolean() with get,set

        [<DataMember(Name="destinationUrl")>]
        member val DestinationUrl:String = null with get,set

        [<DataMember(Name="replacementButton")>]
        member val ReplacementButton:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetShortLinkMetadataResponse() = 
        [<DataMember(Name="baseCode")>]
        member val BaseCode:String = null with get,set

        [<DataMember(Name="domain")>]
        member val Domain:String = null with get,set

        [<DataMember(Name="code")>]
        member val Code:String = null with get,set

        [<DataMember(Name="productMetadata")>]
        member val ProductMetadata:ProductMetadata = null with get,set

        [<DataMember(Name="destinations")>]
        member val Destinations:ResizeArray<Destination> = null with get,set

        [<DataMember(Name="responseStatus")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetShortLinkMetadataRequest() = 
        [<DataMember(Name="domain")>]
        member val AliasDomain:String = null with get,set

        [<DataMember(Name="code")>]
        member val AliasCode:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ProductMetadata() = 
        inherit ProductMetadata()

F# 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
		}
	}
}