CollectionsAPI

<back to all web services

PutCollectionSettingsRequest

import Foundation
import ServiceStack

// @DataContract
public class PutCollectionSettingsRequest : CollectionSettingsBaseRequest, IPutCollectionSettingsRequest
{
    // @DataMember(Name="id")
    public var id:String

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

    private enum CodingKeys : String, CodingKey {
        case id
    }

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

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

// @DataContract
public class CollectionSettingsBaseRequest : V4BaseRequest, ICollectionSettingsBaseRequest
{
    // @DataMember(Name="profileImageId")
    public var profileImageId:String

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

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

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

    // @DataMember(Name="signatureAppearance")
    public var signatureAppearance:SignatureAppearance

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

    private enum CodingKeys : String, CodingKey {
        case profileImageId
        case signatureImageId
        case signatureText
        case signatureFont
        case signatureAppearance
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        profileImageId = try container.decodeIfPresent(String.self, forKey: .profileImageId)
        signatureImageId = try container.decodeIfPresent(String.self, forKey: .signatureImageId)
        signatureText = try container.decodeIfPresent(String.self, forKey: .signatureText)
        signatureFont = try container.decodeIfPresent(String.self, forKey: .signatureFont)
        signatureAppearance = try container.decodeIfPresent(SignatureAppearance.self, forKey: .signatureAppearance)
    }

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

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

public enum SignatureAppearance : String, Codable
{
    case None
    case Text
    case Upload
}

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

    required public init(){}
}

Swift PutCollectionSettingsRequest DTOs

PUT /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutCollectionSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Requests">
  <profileImageId>String</profileImageId>
  <signatureAppearance>None</signatureAppearance>
  <signatureFont>String</signatureFont>
  <signatureImageId>String</signatureImageId>
  <signatureText>String</signatureText>
  <id>String</id>
</PutCollectionSettingsRequest>

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

<PutCollectionSettingsResponse 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>
</PutCollectionSettingsResponse>