CollectionsAPI

<back to all web services

GetCollectionSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v4/collections/settings
GET/v4/collections/settings/{Id}
import Foundation
import ServiceStack

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

// @DataContract
public class GetCollectionSettingsResponse : IGetCollectionSettingsResponse, Codable
{
    required public init(){}
}


Swift GetCollectionSettingsRequest DTOs

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

HTTP + XML

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

GET /v4/collections/settings 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

<GetCollectionSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Responses">
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.DTOs" i:nil="true" />
</GetCollectionSettingsResponse>