ShortlinksAPI

<back to all web services

GetUserLinksRequest

// @DataContract
export class V4BaseRequest
{

    public constructor(init?: Partial<V4BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class V4PaginatedBaseRequest extends V4BaseRequest
{
    // @DataMember(Name="offset")
    public offset: number;

    // @DataMember(Name="limit")
    public limit: number;

    public constructor(init?: Partial<V4PaginatedBaseRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class V4BaseResponse
{
    // @DataMember(Name="status")
    public status: ResponseStatus;

    public constructor(init?: Partial<V4BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class V4PageObject
{
    // @DataMember(Name="offset")
    public offset: number;

    // @DataMember(Name="limit")
    public limit: number;

    // @DataMember(Name="totalRecords")
    public totalRecords: number;

    public constructor(init?: Partial<V4PageObject>) { (Object as any).assign(this, init); }
}

// @DataContract
export class V4PaginatedBaseResponse extends V4BaseResponse
{
    // @DataMember(Name="page")
    public page: V4PageObject;

    public constructor(init?: Partial<V4PaginatedBaseResponse>) { super(init); (Object as any).assign(this, init); }
}

export enum LinkType
{
    None = 'None',
    Simple = 'Simple',
    Split = 'Split',
    Interstitial = 'Interstitial',
    Advanced = 'Advanced',
    Collection = 'Collection',
}

export class RefreshableMetadata implements IRefreshableMetadata
{
    public createdDate: string;
    public updatedDate: string;

    public constructor(init?: Partial<RefreshableMetadata>) { (Object as any).assign(this, init); }
}

export class VersionedRefreshableMetadata extends RefreshableMetadata
{
    public versionCreatedDate: string;

    public constructor(init?: Partial<VersionedRefreshableMetadata>) { super(init); (Object as any).assign(this, init); }
}

export interface IUserLink
{
    url: string;
    baseCode: string;
    linkType: LinkType;
    typeDefinitionPublicId: string;
    metadata: VersionedRefreshableMetadata;
}

// @DataContract
export class GetUserLinksResponse extends V4PaginatedBaseResponse implements IGetUserLinksResponse
{
    // @DataMember(Name="data")
    public data: IUserLink[];

    public constructor(init?: Partial<GetUserLinksResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetUserLinksRequest extends V4PaginatedBaseRequest
{
    // @DataMember(Name="username")
    public username: string;

    // @DataMember(Name="groupId")
    public groupId: number;

    // @DataMember(Name="linkType")
    public linkType: LinkType;

    public constructor(init?: Partial<GetUserLinksRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetUserLinksRequest DTOs

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