Booklinker.API

<back to all web services

PostImageRequest

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

// @DataContract
public class PostImageRequest : V2BaseRequest, IPostImageRequest
{
    // @DataMember(Name="provider")
    public var provider:String

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

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

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

    private enum CodingKeys : String, CodingKey {
        case provider
        case providerImageId
        case attributes
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        provider = try container.decodeIfPresent(String.self, forKey: .provider)
        providerImageId = try container.decodeIfPresent(String.self, forKey: .providerImageId)
        attributes = try container.decodeIfPresent([String:String].self, forKey: .attributes) ?? [:]
    }

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

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

// @DataContract
public class PostImageResponse : V2BaseResponse, IPostImageResponse
{
    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 PostImageRequest 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.

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

{
	provider: String,
	providerImageId: String,
	attributes: 
	{
		String: 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
		}
	}
}