ShortlinksAPI

<back to all web services

GetUserLinkRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links
GET/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); }
}

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 GetUserLinkResponse extends V4BaseResponse implements IGetUserLinkResponse
{
    // @DataMember(Name="data")
    public data: IUserLink;

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

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

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

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

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

TypeScript GetUserLinkRequest 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.

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

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