Booklinker.API

<back to all web services

GetCollectionsRequest

import Foundation
import ServiceStack

// @DataContract
public class GetCollectionsRequest : V2ListRequest
{
    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 V2ListRequest : V2PaginatedBaseRequest
{
    // @DataMember(Name="ids")
    public var ids:[String]

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

    private enum CodingKeys : String, CodingKey {
        case ids
    }

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

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

// @DataContract
public class V2PaginatedBaseRequest : V2BaseRequest
{
    // @DataMember(Name="offset")
    public var offset:Int

    // @DataMember(Name="limit")
    public var limit:Int

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

    private enum CodingKeys : String, CodingKey {
        case offset
        case limit
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        offset = try container.decodeIfPresent(Int.self, forKey: .offset)
        limit = try container.decodeIfPresent(Int.self, forKey: .limit)
    }

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

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

// @DataContract
public class GetCollectionsResponse : V2PaginatedBaseResponse, IGetCollectionsResponse
{
    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 V2PaginatedBaseResponse : V2BaseResponse
{
    // @DataMember(Name="page")
    public var page:V2PageObject

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

    private enum CodingKeys : String, CodingKey {
        case page
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        page = try container.decodeIfPresent(V2PageObject.self, forKey: .page)
    }

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

// @DataContract
public class V2BaseResponse : Codable
{
    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class V2PageObject : Codable
{
    // @DataMember(Name="offset")
    public var offset:Int

    // @DataMember(Name="limit")
    public var limit:Int

    // @DataMember(Name="totalRecords")
    public var totalRecords:Int

    required public init(){}
}

Swift GetCollectionsRequest DTOs

GET /v2/collections/list HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"page":{"offset":0,"limit":0,"totalRecords":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}