Booklinker.API

<back to all web services

PostUnclaimedLinkCreationRequest

import Foundation
import ServiceStack

public class PostUnclaimedLinkCreationRequest : PostLinkCreationRequestBase
{
    // @DataMember(Name="affiliatePrograms")
    public var affiliatePrograms:[AffiliateTokens]

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case affiliatePrograms
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        affiliatePrograms = try container.decodeIfPresent([AffiliateTokens].self, forKey: .affiliatePrograms) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if affiliatePrograms != nil { try container.encode(affiliatePrograms, forKey: .affiliatePrograms) }
    }
}

// @DataContract
public class PostLinkCreationRequestBase : Codable
{
    // @DataMember(Name="url")
    // @ApiMember(IsRequired=true)
    public var url:String

    // @DataMember(Name="domain")
    public var domain:String

    // @DataMember(Name="parameterKeyValues")
    public var parameterKeyValues:[String:String]

    required public init(){}
}

// @DataContract
public class AffiliateTokens : Codable
{
    // @DataMember(Name="guid")
    public var guid:String

    // @DataMember(Name="programGuid")
    public var programGuid:String

    // @DataMember(Name="affiliateTokens")
    public var affiliateTokens:[String:String]

    required public init(){}
}

// @DataContract
public class PostLinkCreationResponse : Codable
{
    // @DataMember(Name="success")
    public var success:Bool

    // @DataMember(Name="linkResult")
    public var linkResult:String

    // @DataMember(Name="destinations")
    public var destinations:[ProductMetadata]

    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class ProductMetadata : ProductMetadata
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class ProductMetadata : Codable
{
    // @DataMember(Name="title")
    public var title:String

    // @DataMember(Name="author")
    public var author:String

    // @DataMember(Name="url")
    public var url:Uri

    // @DataMember(Name="description")
    public var description:String

    // @DataMember(Name="retailer")
    public var retailer:String

    // @DataMember(Name="productImages")
    public var productImages:[String:Uri]

    required public init(){}
}

Swift PostUnclaimedLinkCreationRequest DTOs

POST /v1/links/unclaimed HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostUnclaimedLinkCreationRequest 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>
  <AffiliatePrograms xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.DTOs">
    <d2p1:AffiliateTokens>
      <d2p1:affiliateTokens xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:affiliateTokens>
      <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
      <d2p1:programGuid>00000000-0000-0000-0000-000000000000</d2p1:programGuid>
    </d2p1:AffiliateTokens>
  </AffiliatePrograms>
</PostUnclaimedLinkCreationRequest>

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>