ShortlinksAPI

GetUserLinksRequest

The following routes are available for this service:
GET	/v4/links/list

**GetUserLinksRequest** Parameters:
Name	Parameter	Data Type	Required
Username	query	string	No
GroupId	query	uint	No
LinkType	query	LinkType	No

**V4PaginatedBaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	form	int	No
Limit	form	int	No

**LinkType** Enum:
None
Simple
Split
Interstitial
Advanced
Collection

**GetUserLinksResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	IEnumerable<IUserLink>	No

**V4PaginatedBaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Page	form	V4PageObject	No

**V4BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**V4PageObject** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Limit	form	int	No
TotalRecords	form	int	No

**IUserLink** Parameters:
Name	Parameter	Data Type	Required
Url	form	string	No
BaseCode	form	string	No
LinkType	form	LinkType	No
TypeDefinitionPublicId	form	string	No
Metadata	form	VersionedRefreshableMetadata	No

**VersionedRefreshableMetadata** Parameters:
Name	Parameter	Data Type	Required	Description
VersionCreatedDate	form	DateTime	No

**RefreshableMetadata** Parameters:
Name	Parameter	Data Type	Required	Description
CreatedDate	form	DateTime	No
UpdatedDate	form	DateTime	No

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