| PUT | /v4/links | ||
|---|---|---|---|
| PUT | /v4/links/{Id} |
import Foundation
import ServiceStack
// @DataContract
public class PutUserLinkRequest : V4BaseRequest, IPutUserLinkRequest
{
// @DataMember(Name="id")
public var id:String
// @DataMember(Name="linkType")
public var linkType:LinkType
// @DataMember(Name="typeDefinitionPublicId")
public var typeDefinitionPublicId:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case linkType
case typeDefinitionPublicId
}
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)
linkType = try container.decodeIfPresent(LinkType.self, forKey: .linkType)
typeDefinitionPublicId = try container.decodeIfPresent(String.self, forKey: .typeDefinitionPublicId)
}
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 linkType != nil { try container.encode(linkType, forKey: .linkType) }
if typeDefinitionPublicId != nil { try container.encode(typeDefinitionPublicId, forKey: .typeDefinitionPublicId) }
}
}
// @DataContract
public class V4BaseRequest : Codable
{
required public init(){}
}
public enum LinkType : String, Codable
{
case None
case Simple
case Split
case Interstitial
case Advanced
case Collection
}
// @DataContract
public class PutUserLinkResponse : V4BaseResponse
{
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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v4/links HTTP/1.1
Host: shortlinks-api.qa.platform.georiot.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PutUserLinkRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShortlinksAPI.ServiceModel.V4.Requests">
<id>String</id>
<linkType>None</linkType>
<typeDefinitionPublicId>String</typeDefinitionPublicId>
</PutUserLinkRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PutUserLinkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShortlinksAPI.ServiceModel.V4.Responses">
<status xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</status>
</PutUserLinkResponse>