ShortlinksAPI

<back to all web services

GetUserLinksRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links/list
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ShortlinksAPI.ServiceModel.V4.Requests;
using Geniuslink.Shortlinks.Constants;
using ShortlinksAPI.ServiceModel.V4.Responses;
using ShortlinksAPI.Contracts.V4.DTOs;
using Geniuslink.Shortlinks;

namespace Geniuslink.Shortlinks
{
    public partial class RefreshableMetadata
        : IRefreshableMetadata
    {
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime UpdatedDate { get; set; }
    }

    public partial class VersionedRefreshableMetadata
        : RefreshableMetadata
    {
        public virtual DateTime VersionCreatedDate { get; set; }
    }

}

namespace Geniuslink.Shortlinks.Constants
{
    public enum LinkType
    {
        None,
        Simple,
        Split,
        Interstitial,
        Advanced,
        Collection,
    }

}

namespace ShortlinksAPI.Contracts.V4.DTOs
{
    public partial interface IUserLink
    {
        string Url { get; set; }
        string BaseCode { get; set; }
        LinkType LinkType { get; set; }
        string TypeDefinitionPublicId { get; set; }
        VersionedRefreshableMetadata Metadata { get; set; }
    }

}

namespace ShortlinksAPI.ServiceModel.V4.Requests
{
    [DataContract]
    public partial class GetUserLinksRequest
        : V4PaginatedBaseRequest
    {
        [DataMember(Name="username")]
        public virtual string Username { get; set; }

        [DataMember(Name="groupId")]
        public virtual uint GroupId { get; set; }

        [DataMember(Name="linkType")]
        public virtual LinkType LinkType { get; set; }
    }

    [DataContract]
    public partial class V4BaseRequest
    {
    }

    [DataContract]
    public partial class V4PaginatedBaseRequest
        : V4BaseRequest
    {
        [DataMember(Name="offset")]
        public virtual int Offset { get; set; }

        [DataMember(Name="limit")]
        public virtual int Limit { get; set; }
    }

}

namespace ShortlinksAPI.ServiceModel.V4.Responses
{
    [DataContract]
    public partial class GetUserLinksResponse
        : V4PaginatedBaseResponse, IGetUserLinksResponse
    {
        [DataMember(Name="data")]
        public virtual IEnumerable<IUserLink> Data { get; set; }
    }

    [DataContract]
    public partial class V4BaseResponse
    {
        [DataMember(Name="status")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class V4PageObject
    {
        [DataMember(Name="offset")]
        public virtual int Offset { get; set; }

        [DataMember(Name="limit")]
        public virtual int Limit { get; set; }

        [DataMember(Name="totalRecords")]
        public virtual int TotalRecords { get; set; }
    }

    [DataContract]
    public partial class V4PaginatedBaseResponse
        : V4BaseResponse
    {
        [DataMember(Name="page")]
        public virtual V4PageObject Page { get; set; }
    }

}

C# GetUserLinksRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}