ShortlinksAPI

<back to all web services

GetUserLinksRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links/list
GetUserLinksRequest Parameters:
NameParameterData TypeRequiredDescription
UsernamequerystringNo
GroupIdqueryuintNo
LinkTypequeryLinkTypeNo
V4PaginatedBaseRequest Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
LimitformintNo
LinkType Enum:
None
Simple
Split
Interstitial
Advanced
Collection
GetUserLinksResponse Parameters:
NameParameterData TypeRequiredDescription
DataformIEnumerable<IUserLink>No
V4PaginatedBaseResponse Parameters:
NameParameterData TypeRequiredDescription
PageformV4PageObjectNo
V4BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
V4PageObject Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
LimitformintNo
TotalRecordsformintNo
IUserLink Parameters:
NameParameterData TypeRequiredDescription
UrlformstringNo
BaseCodeformstringNo
LinkTypeformLinkTypeNo
TypeDefinitionPublicIdformstringNo
MetadataformVersionedRefreshableMetadataNo
VersionedRefreshableMetadata Parameters:
NameParameterData TypeRequiredDescription
VersionCreatedDateformDateTimeNo
RefreshableMetadata Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
UpdatedDateformDateTimeNo

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

{"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"}}}