| POST | /v4/images |
|---|
import Foundation
import ServiceStack
// @DataContract
public class PostImageRequest : V4BaseRequest, IPostImageRequest
{
// @DataMember(Name="provider")
public var provider:ImageProvider
// @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(ImageProvider.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.count > 0 { try container.encode(attributes, forKey: .attributes) }
}
}
// @DataContract
public class V4BaseRequest : Codable
{
required public init(){}
}
public enum ImageProvider : String, Codable
{
case None
case Cloudinary
}
// @DataContract
public class PostImageResponse : V4BaseResponse, 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 V4BaseResponse : Codable
{
// @DataMember(Name="status")
public var status:ResponseStatus
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v4/images HTTP/1.1
Host: image-service-api.qa.platform.georiot.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
provider: None,
providerImageId: String,
attributes:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
status:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}