| GET | /v4/links/list |
|---|
namespace Geniuslink.Shortlinks
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type V4BaseResponse() =
[<DataMember(Name="status")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type V4PageObject() =
[<DataMember(Name="offset")>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Name="limit")>]
member val Limit:Int32 = new Int32() with get,set
[<DataMember(Name="totalRecords")>]
member val TotalRecords:Int32 = new Int32() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type V4PaginatedBaseResponse() =
inherit V4BaseResponse()
[<DataMember(Name="page")>]
member val Page:V4PageObject = null with get,set
type LinkType =
| None = 0
| Simple = 1
| Split = 2
| Interstitial = 3
| Advanced = 4
| Collection = 5
[<AllowNullLiteral>]
type RefreshableMetadata() =
member val CreatedDate:DateTime = new DateTime() with get,set
member val UpdatedDate:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type VersionedRefreshableMetadata() =
inherit RefreshableMetadata()
member val VersionCreatedDate:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type IUserLink =
abstract Url:String with get,set
abstract BaseCode:String with get,set
abstract LinkType:LinkType with get,set
abstract TypeDefinitionPublicId:String with get,set
abstract Metadata:VersionedRefreshableMetadata with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetUserLinksResponse() =
inherit V4PaginatedBaseResponse()
[<DataMember(Name="data")>]
member val Data:IEnumerable<IUserLink> = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type V4BaseRequest() =
class end
[<DataContract>]
[<AllowNullLiteral>]
type V4PaginatedBaseRequest() =
inherit V4BaseRequest()
[<DataMember(Name="offset")>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Name="limit")>]
member val Limit:Int32 = new Int32() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetUserLinksRequest() =
inherit V4PaginatedBaseRequest()
[<DataMember(Name="username")>]
member val Username:String = null with get,set
[<DataMember(Name="groupId")>]
member val GroupId:UInt32 = new UInt32() with get,set
[<DataMember(Name="linkType")>]
member val LinkType:LinkType = new LinkType() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}