Booklinker.API

<back to all web services

PutCollectionRequest

Requires Authentication
The following routes are available for this service:
PUT/v2/collections
PUT/v2/collections/{Id}
import Foundation
import ServiceStack

// @DataContract
public class PutCollectionRequest : V2BaseRequest
{
    // @DataMember(Name="id")
    public var id:String

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

    // @DataMember(Name="linkIds")
    public var linkIds:[String]

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

    private enum CodingKeys : String, CodingKey {
        case id
        case title
        case linkIds
    }

    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)
        title = try container.decodeIfPresent(String.self, forKey: .title)
        linkIds = try container.decodeIfPresent([String].self, forKey: .linkIds) ?? []
    }

    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) }
        if title != nil { try container.encode(title, forKey: .title) }
        if linkIds != nil { try container.encode(linkIds, forKey: .linkIds) }
    }
}

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

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

    required public init(){}
}


Swift PutCollectionRequest DTOs

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

HTTP + JSV

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

PUT /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	title: String,
	linkIds: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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