Booklinker.API

PostLinkCreationRequest

The following routes are available for this service:
POST	/v1/links
POST	/v1/complete-link-creation-requests

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

Namespace Global

    Namespace Booklinker.API.ServiceModel.V1.DTOs

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

    Namespace Booklinker.API.ServiceModel.V1.Requests

        Public Partial Class PostLinkCreationRequest
            Inherits PostLinkCreationRequestBase
            <DataMember(Name:="code")>
            Public Overridable Property Code As String
        End Class

        <DataContract>
        Public Partial Class PostLinkCreationRequestBase
            <DataMember(Name:="url")>
            <ApiMember(IsRequired:=true)>
            Public Overridable Property Url As String

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

            <DataMember(Name:="parameterKeyValues")>
            Public Overridable Property ParameterKeyValues As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V1.Responses

        <DataContract>
        Public Partial Class PostLinkCreationResponse
            <DataMember(Name:="success")>
            Public Overridable Property Success As Boolean

            <DataMember(Name:="linkResult")>
            Public Overridable Property LinkResult As String

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

            <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 PostLinkCreationRequest 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 HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	code: 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
		}
	}
}