Booklinker.API

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v2/collections
import Foundation
import ServiceStack

// @DataContract
public class PostCollectionRequest : V2BaseRequest, IPostCollectionRequest
{
    // @DataMember(Name="aliasDomain")
    public var aliasDomain:String

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

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

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

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

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

    private enum CodingKeys : String, CodingKey {
        case aliasDomain
        case aliasCode
        case title
        case linkIds
        case collectionSettingsId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        aliasDomain = try container.decodeIfPresent(String.self, forKey: .aliasDomain)
        aliasCode = try container.decodeIfPresent(String.self, forKey: .aliasCode)
        title = try container.decodeIfPresent(String.self, forKey: .title)
        linkIds = try container.decodeIfPresent([String].self, forKey: .linkIds) ?? []
        collectionSettingsId = try container.decodeIfPresent(String.self, forKey: .collectionSettingsId)
    }

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

// @DataContract
public class V2BaseRequest : Codable
{
    required public init(){}
}

// @DataContract
public class PostCollectionResponse : V2BaseResponse, IPostCollectionResponse
{
    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 V2BaseResponse : Codable
{
    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift PostCollectionRequest 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 /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostCollectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Requests">
  <aliasCode>String</aliasCode>
  <aliasDomain>String</aliasDomain>
  <collectionSettingsId>String</collectionSettingsId>
  <linkIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <title>String</title>
</PostCollectionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostCollectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses">
  <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>
  <data i:nil="true" />
</PostCollectionResponse>