| GET | /v4/links/list |
|---|
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 GetUserLinksRequest : V4PaginatedBaseRequest()
{
@DataMember(Name="username")
@SerializedName("username")
open var username:String? = null
@DataMember(Name="groupId")
@SerializedName("groupId")
open var groupId:Long? = null
@DataMember(Name="linkType")
@SerializedName("linkType")
open var linkType:LinkType? = null
}
@DataContract
open class V4PaginatedBaseRequest : V4BaseRequest()
{
@DataMember(Name="offset")
@SerializedName("offset")
open var offset:Int? = null
@DataMember(Name="limit")
@SerializedName("limit")
open var limit:Int? = null
}
@DataContract
open class V4BaseRequest
{
}
enum class LinkType
{
None,
Simple,
Split,
Interstitial,
Advanced,
Collection,
}
@DataContract
open class GetUserLinksResponse : V4PaginatedBaseResponse(), IGetUserLinksResponse
{
@DataMember(Name="data")
@SerializedName("data")
override var Data:ArrayList<IUserLink>? = null
}
@DataContract
open class V4PaginatedBaseResponse : V4BaseResponse()
{
@DataMember(Name="page")
@SerializedName("page")
open var page:V4PageObject? = null
}
@DataContract
open class V4BaseResponse
{
@DataMember(Name="status")
@SerializedName("status")
open var responseStatus:ResponseStatus? = null
}
@DataContract
open class V4PageObject
{
@DataMember(Name="offset")
@SerializedName("offset")
open var offset:Int? = null
@DataMember(Name="limit")
@SerializedName("limit")
open var limit:Int? = null
@DataMember(Name="totalRecords")
@SerializedName("totalRecords")
open var totalRecords:Int? = null
}
interface IUserLink
{
var url:String?
var baseCode:String?
var linkType:LinkType?
var typeDefinitionPublicId:String?
var metadata:VersionedRefreshableMetadata?
}
open class VersionedRefreshableMetadata : RefreshableMetadata()
{
open var versionCreatedDate:Date? = null
}
open class RefreshableMetadata : IRefreshableMetadata
{
override var createdDate:Date? = null
override var updatedDate:Date? = null
}
Kotlin GetUserLinksRequest DTOs
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/list 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
{"page":{"offset":0,"limit":0,"totalRecords":0},"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}