Booklinker.API

<back to all web services

PostLinkCreationRequest

Requires Authentication
The following routes are available for this service:
POST/v1/links
POST/v1/complete-link-creation-requests
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Booklinker.API.ServiceModel.V1.Requests;
using Booklinker.API.ServiceModel.V1.Responses;
using Booklinker.API.ServiceModel.V1.DTOs;
using ProductAPI.Contracts.V1.DTOs;

namespace Booklinker.API.ServiceModel.V1.DTOs
{
    [DataContract]
    public partial class ProductMetadata
        : ProductMetadata
    {
    }

}

namespace Booklinker.API.ServiceModel.V1.Requests
{
    public partial class PostLinkCreationRequest
        : PostLinkCreationRequestBase
    {
        [DataMember(Name="code")]
        public virtual string Code { get; set; }
    }

    [DataContract]
    public partial class PostLinkCreationRequestBase
    {
        [DataMember(Name="url")]
        [ApiMember(IsRequired=true)]
        public virtual string Url { get; set; }

        [DataMember(Name="domain")]
        public virtual string Domain { get; set; }

        [DataMember(Name="parameterKeyValues")]
        public virtual Dictionary<string, string> ParameterKeyValues { get; set; }
    }

}

namespace Booklinker.API.ServiceModel.V1.Responses
{
    [DataContract]
    public partial class PostLinkCreationResponse
    {
        [DataMember(Name="success")]
        public virtual bool Success { get; set; }

        [DataMember(Name="linkResult")]
        public virtual string LinkResult { get; set; }

        [DataMember(Name="destinations")]
        public virtual IEnumerable<ProductMetadata> Destinations { get; set; }

        [DataMember(Name="responseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace ProductAPI.Contracts.V1.DTOs
{
    [DataContract]
    public partial class ProductMetadata
    {
        [DataMember(Name="title")]
        public virtual string Title { get; set; }

        [DataMember(Name="author")]
        public virtual string Author { get; set; }

        [DataMember(Name="url")]
        public virtual Uri Url { get; set; }

        [DataMember(Name="description")]
        public virtual string Description { get; set; }

        [DataMember(Name="retailer")]
        public virtual string Retailer { get; set; }

        [DataMember(Name="productImages")]
        public virtual IDictionary<string, Uri> ProductImages { get; set; }
    }

}

C# PostLinkCreationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"code":"String","url":"String","domain":"String","parameterKeyValues":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}