ShortlinksAPI

<back to all web services

GetUserLinksRequest

"use strict";
export class V4BaseRequest {
    constructor(init) { Object.assign(this, init) }
}
export class V4PaginatedBaseRequest extends V4BaseRequest {
    /** @param {{offset?:number,limit?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    offset;
    /** @type {number} */
    limit;
}
export class V4BaseResponse {
    /** @param {{status?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    status;
}
export class V4PageObject {
    /** @param {{offset?:number,limit?:number,totalRecords?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    offset;
    /** @type {number} */
    limit;
    /** @type {number} */
    totalRecords;
}
export class V4PaginatedBaseResponse extends V4BaseResponse {
    /** @param {{page?:V4PageObject,status?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {V4PageObject} */
    page;
}
/** @typedef {'None'|'Simple'|'Split'|'Interstitial'|'Advanced'|'Collection'} */
export var LinkType;
(function (LinkType) {
    LinkType["None"] = "None"
    LinkType["Simple"] = "Simple"
    LinkType["Split"] = "Split"
    LinkType["Interstitial"] = "Interstitial"
    LinkType["Advanced"] = "Advanced"
    LinkType["Collection"] = "Collection"
})(LinkType || (LinkType = {}));
export class RefreshableMetadata {
    /** @param {{createdDate?:string,updatedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    createdDate;
    /** @type {string} */
    updatedDate;
}
export class VersionedRefreshableMetadata extends RefreshableMetadata {
    /** @param {{versionCreatedDate?:string,createdDate?:string,updatedDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    versionCreatedDate;
}
export class GetUserLinksResponse extends V4PaginatedBaseResponse {
    /** @param {{data?:IUserLink[],page?:V4PageObject,status?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {IUserLink[]} */
    data;
}
export class GetUserLinksRequest extends V4PaginatedBaseRequest {
    /** @param {{username?:string,groupId?:number,linkType?:LinkType,offset?:number,limit?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    username;
    /** @type {number} */
    groupId;
    /** @type {LinkType} */
    linkType;
}

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