ShortlinksAPI

PutUserLinkRequest

The following routes are available for this service:
PUT	/v4/links
PUT	/v4/links/{Id}


// @DataContract
export class V4BaseRequest
{

    public constructor(init?: Partial<V4BaseRequest>) { (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 PutUserLinkResponse extends V4BaseResponse
{

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

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

// @DataContract
export class PutUserLinkRequest extends V4BaseRequest implements IPutUserLinkRequest
{
    // @DataMember(Name="id")
    public id: string;

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

    // @DataMember(Name="typeDefinitionPublicId")
    public typeDefinitionPublicId: string;

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

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