ShortlinksAPI

<back to all web services

PostUserLinkRequest

Requires Authentication
The following routes are available for this service:
POST/v4/links
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 PostUserLinkRequest : V4BaseRequest(), IPostUserLinkRequest
{
    @DataMember(Name="baseCode")
    @SerializedName("baseCode")
    override var baseCode:String? = null

    @DataMember(Name="linkType")
    @SerializedName("linkType")
    override var linkType:LinkType? = null

    @DataMember(Name="typeDefinitionPublicId")
    @SerializedName("typeDefinitionPublicId")
    override var typeDefinitionPublicId:String? = null
}

@DataContract
open class V4BaseRequest
{
}

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

@DataContract
open class PostUserLinkResponse : V4BaseResponse()
{
}

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

Kotlin PostUserLinkRequest 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.

POST /v4/links HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"baseCode":"String","linkType":"None","typeDefinitionPublicId":"String"}

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"}}}