CollectionsAPI

<back to all web services

PostCollectionRequest

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

// @DataContract
public class PostCollectionRequest : V4BaseRequest, IPostCollectionRequest
{
    // @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 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)
        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 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 V4BaseRequest : Codable
{
    required public init(){}
}

// @DataContract
public class PostCollectionResponse : V4BaseResponse, IPostCollectionResponse
{
    //data:IPostCollectionResponseData ignored. Swift doesn't support interface properties

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

    required public init(){}
}

public protocol IPostCollectionResponseData
{
    var id:String { get set }

}


Swift PostCollectionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v4/collections HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"title":"String","collectionSettingsId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}