ShortlinksAPI

<back to all web services

PutUserLinkRequest

Requires Authentication
The following routes are available for this service:
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(){}
}


Swift PutUserLinkRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"id":"String","linkType":"None","typeDefinitionPublicId":"String"}
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"}}}