ShortlinksAPI

GetUserLinkRequest

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

**GetUserLinkRequest** Parameters:
Name	Parameter	Data Type	Required
Id	path	string	No
Username	query	string	No
GroupId	query	uint	No

**GetUserLinkResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	IUserLink	No

**V4BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	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

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

**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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUserLinkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShortlinksAPI.ServiceModel.V4.Responses">
  <status xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </status>
  <data i:nil="true" />
</GetUserLinkResponse>