| POST | /v1/links | ||
|---|---|---|---|
| POST | /v1/complete-link-creation-requests |
import Foundation
import ServiceStack
public class PostLinkCreationRequest : PostLinkCreationRequestBase
{
// @DataMember(Name="code")
public var code:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case code
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
code = try container.decodeIfPresent(String.self, forKey: .code)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if code != nil { try container.encode(code, forKey: .code) }
}
}
// @DataContract
public class PostLinkCreationRequestBase : Codable
{
// @DataMember(Name="url")
// @ApiMember(IsRequired=true)
public var url:String
// @DataMember(Name="domain")
public var domain:String
// @DataMember(Name="parameterKeyValues")
public var parameterKeyValues:[String:String]
required public init(){}
}
// @DataContract
public class PostLinkCreationResponse : Codable
{
// @DataMember(Name="success")
public var success:Bool
// @DataMember(Name="linkResult")
public var linkResult:String
// @DataMember(Name="destinations")
public var destinations:[ProductMetadata]
// @DataMember(Name="responseStatus")
public var responseStatus:ResponseStatus
required public init(){}
}
// @DataContract
public class ProductMetadata : ProductMetadata
{
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 ProductMetadata : Codable
{
// @DataMember(Name="title")
public var title:String
// @DataMember(Name="author")
public var author:String
// @DataMember(Name="url")
public var url:Uri
// @DataMember(Name="description")
public var description:String
// @DataMember(Name="retailer")
public var retailer:String
// @DataMember(Name="productImages")
public var productImages:[String:Uri]
required public init(){}
}
Swift PostLinkCreationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/links HTTP/1.1
Host: api.booklinker.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"code":"String","url":"String","domain":"String","parameterKeyValues":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"success":false,"linkResult":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}