ShortlinksAPI

<back to all web services

GetUserLinkRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links
GET/v4/links/{Id}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetUserLinkRequest : V4BaseRequest()
{
    @DataMember(Name="id")
    @SerializedName("id")
    open var id:String? = null

    @DataMember(Name="username")
    @SerializedName("username")
    open var username:String? = null

    @DataMember(Name="groupId")
    @SerializedName("groupId")
    open var groupId:Long? = null
}

@DataContract
open class V4BaseRequest
{
}

@DataContract
open class GetUserLinkResponse : V4BaseResponse(), IGetUserLinkResponse
{
    @DataMember(Name="data")
    @SerializedName("data")
    override var Data:IUserLink? = null
}

@DataContract
open class V4BaseResponse
{
    @DataMember(Name="status")
    @SerializedName("status")
    open var responseStatus:ResponseStatus? = null
}

interface IUserLink
{
    var url:String?
    var baseCode:String?
    var linkType:LinkType?
    var typeDefinitionPublicId:String?
    var metadata:VersionedRefreshableMetadata?
}

enum class LinkType
{
    None,
    Simple,
    Split,
    Interstitial,
    Advanced,
    Collection,
}

open class VersionedRefreshableMetadata : RefreshableMetadata()
{
    open var versionCreatedDate:Date? = null
}

open class RefreshableMetadata : IRefreshableMetadata
{
    override var createdDate:Date? = null
    override var updatedDate:Date? = null
}

Kotlin GetUserLinkRequest DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}