CollectionsAPI

<back to all web services

PostCollectionRequest

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

POST /v4/collections HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.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/CollectionsAPI.ServiceModel.V4.Requests">
  <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/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>
  <data i:nil="true" />
</PostCollectionResponse>