Booklinker.API

<back to all web services

PostUnclaimedLinkCreationRequest

The following routes are available for this service:
POST/v1/links/unclaimed
namespace Booklinker.API.ServiceModel.V1.DTOs

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 PostLinkCreationResponse() = 
        [<DataMember(Name="success")>]
        member val Success:Boolean = new Boolean() with get,set

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type PostLinkCreationRequestBase() = 
        [<DataMember(Name="url")>]
        [<ApiMember(IsRequired=true)>]
        member val Url:String = null with get,set

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

        [<DataMember(Name="parameterKeyValues")>]
        member val ParameterKeyValues:Dictionary<String, String> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AffiliateTokens() = 
        [<DataMember(Name="guid")>]
        member val Guid:Guid = new Guid() with get,set

        [<DataMember(Name="programGuid")>]
        member val ProgramGuid:Guid = new Guid() with get,set

        [<DataMember(Name="affiliateTokens")>]
        member val Tokens:Dictionary<String, String> = null with get,set

    [<AllowNullLiteral>]
    type PostUnclaimedLinkCreationRequest() = 
        inherit PostLinkCreationRequestBase()
        [<DataMember(Name="affiliatePrograms")>]
        member val AffiliatePrograms:ResizeArray<AffiliateTokens> = null with get,set

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

F# PostUnclaimedLinkCreationRequest 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/unclaimed HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"affiliatePrograms":[{"affiliateTokens":{"String":"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"}}}