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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PostLinkCreationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Requests">
  <domain>String</domain>
  <parameterKeyValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </parameterKeyValues>
  <url>String</url>
  <Code>String</Code>
</PostLinkCreationRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostLinkCreationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Responses">
  <destinations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.DTOs" i:nil="true" />
  <linkResult>String</linkResult>
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
  <success>false</success>
</PostLinkCreationResponse>