ShortlinksAPI

PutUserLinkRequest

The following routes are available for this service:
PUT	/v4/links
PUT	/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;
}
export class PutUserLinkResponse extends V4BaseResponse {
    /** @param {{status?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
/** @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 PutUserLinkRequest extends V4BaseRequest {
    /** @param {{id?:string,linkType?:LinkType,typeDefinitionPublicId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {LinkType} */
    linkType;
    /** @type {string} */
    typeDefinitionPublicId;
}

JavaScript PutUserLinkRequest 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.

PUT /v4/links HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	linkType: None,
	typeDefinitionPublicId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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