| GET | /v4/links | ||
|---|---|---|---|
| GET | /v4/links/{Id} |
import Foundation
import ServiceStack
// @DataContract
public class GetUserLinkRequest : V4BaseRequest
{
// @DataMember(Name="id")
public var id:String
// @DataMember(Name="username")
public var username:String
// @DataMember(Name="groupId")
public var groupId:UInt32
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case username
case groupId
}
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)
username = try container.decodeIfPresent(String.self, forKey: .username)
groupId = try container.decodeIfPresent(UInt32.self, forKey: .groupId)
}
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 username != nil { try container.encode(username, forKey: .username) }
if groupId != nil { try container.encode(groupId, forKey: .groupId) }
}
}
// @DataContract
public class V4BaseRequest : Codable
{
required public init(){}
}
// @DataContract
public class GetUserLinkResponse : V4BaseResponse, IGetUserLinkResponse
{
//data:IUserLink ignored. Swift doesn't support interface properties
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case data
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
data = try container.decodeIfPresent(IUserLink.self, forKey: .data)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if data != nil { try container.encode(data, forKey: .data) }
}
}
// @DataContract
public class V4BaseResponse : Codable
{
// @DataMember(Name="status")
public var status:ResponseStatus
required public init(){}
}
public protocol IUserLink
{
var url:String { get set }
var baseCode:String { get set }
var linkType:LinkType { get set }
var typeDefinitionPublicId:String { get set }
var metadata:VersionedRefreshableMetadata { get set }
}
public enum LinkType : String, Codable
{
case None
case Simple
case Split
case Interstitial
case Advanced
case Collection
}
public class VersionedRefreshableMetadata : RefreshableMetadata
{
public var versionCreatedDate:Date
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case versionCreatedDate
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
versionCreatedDate = try container.decodeIfPresent(Date.self, forKey: .versionCreatedDate)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if versionCreatedDate != nil { try container.encode(versionCreatedDate, forKey: .versionCreatedDate) }
}
}
public class RefreshableMetadata : IRefreshableMetadata, Codable
{
public var createdDate:Date
public var updatedDate:Date
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v4/links HTTP/1.1 Host: shortlinks-api.qa.platform.georiot.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}