ShortlinksAPI

<back to all web services

GetUserLinkRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links
GET/v4/links/{Id}
"use strict";
export class V4BaseRequest {
    constructor(init) { Object.assign(this, init) }
}
export class V4BaseResponse {
    /** @param {{status?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    status;
}
/** @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 GetUserLinkResponse extends V4BaseResponse {
    /** @param {{data?:IUserLink,status?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {IUserLink} */
    data;
}
export class GetUserLinkRequest extends V4BaseRequest {
    /** @param {{id?:string,username?:string,groupId?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    username;
    /** @type {number} */
    groupId;
}

JavaScript GetUserLinkRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v4/links 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

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}