CollectionsAPI

<back to all web services

GetCollectionsRequest

import Foundation
import ServiceStack

// @DataContract
public class GetCollectionsRequest : V4ListRequest
{
    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 V4ListRequest : V4PaginatedBaseRequest
{
    // @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 V4PaginatedBaseRequest : V4BaseRequest
{
    // @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 V4BaseRequest : Codable
{
    required public init(){}
}

// @DataContract
public class GetCollectionsResponse : V4PaginatedBaseResponse, IGetCollectionsResponse
{
    // @DataMember(Name="data")
    public var data:[IUserCollection]

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

    private enum CodingKeys : String, CodingKey {
        case data
    }

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

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

// @DataContract
public class V4PaginatedBaseResponse : V4BaseResponse
{
    // @DataMember(Name="page")
    public var page:V4PageObject

    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(V4PageObject.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 V4BaseResponse : Codable
{
    // @DataMember(Name="status")
    public var status:ResponseStatus

    required public init(){}
}

// @DataContract
public class V4PageObject : 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(){}
}

public protocol IUserCollection
{
    var id:String { get set }
    var title:String { get set }
    var linkIds:[String] { get set }
    var collectionSettingsId:String { get set }

}

Swift GetCollectionsRequest DTOs

GET /v4/collections/list HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCollectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Responses">
  <status 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>
  </status>
  <page>
    <limit>0</limit>
    <offset>0</offset>
    <totalRecords>0</totalRecords>
  </page>
  <data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</GetCollectionsResponse>