ShortlinksAPI

<back to all web services

GetShortLinkMetadataRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links/metadata/{baseCode}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ShortlinksAPI.ServiceModel.V4.Requests
Imports ShortlinksAPI.ServiceModel.V4.Responses
Imports Geniuslink.Shortlinks

Namespace Global

    Namespace Geniuslink.Shortlinks

        Public Enum LinkCreatorOption
            NotSet
            Simple
            Split
            Advanced
            Interstitial
            Other
        End Enum

        <DataContract>
        Public Partial Class ShortUrlAlias
            Implements IShortUrlAlias
            <DataMember>
            Public Overridable Property Code As String Implements IShortUrlAlias.Code

            <DataMember>
            Public Overridable Property Domain As String Implements IShortUrlAlias.Domain

            <DataMember>
            Public Overridable Property BaseCode As String Implements IShortUrlAlias.BaseCode

            <DataMember>
            Public Overridable Property LastUpdatedUtc As Date Implements IShortUrlAlias.LastUpdatedUtc
        End Class

        <DataContract>
        Public Partial Class UserShortLink
            Implements IUserShortLink
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property DestinationUrl As String Implements IUserShortLink.DestinationUrl

            <DataMember>
            Public Overridable Property ShortUrlCode As String Implements IUserShortLink.ShortUrlCode

            <DataMember>
            Public Overridable Property Domain As String Implements IUserShortLink.Domain

            <DataMember>
            Public Overridable Property LinkType As String Implements IUserShortLink.LinkType

            <DataMember>
            Public Overridable Property HasOverride As Boolean

            <DataMember>
            Public Overridable Property ProductUrl As String Implements IUserShortLink.ProductUrl

            <DataMember>
            Public Overridable Property TrackingCode As String

            <DataMember>
            Public Overridable Property SkipAffiliateRedirect As Boolean

            <DataMember>
            Public Overridable Property CreatedUtc As Date

            <DataMember>
            Public Overridable Property UpdatedUtc As Date

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property CreatedUserTime As Date

            <DataMember>
            Public Overridable Property UpdatedUserTime As Date

            <DataMember>
            Public Overridable Property Tsid As UInt32? Implements IUserShortLink.Tsid

            <DataMember>
            Public Overridable Property Group As String

            <DataMember>
            Public Overridable Property Username As String

            <DataMember>
            Public Overridable Property JsonMetadata As String

            <DataMember>
            Public Overridable Property JsonItemMetadata As String

            <DataMember>
            Public Overridable Property JsonPostProcessingRules As String

            <DataMember>
            Public Overridable Property JsonOverrides As String Implements IUserShortLink.JsonOverrides

            <DataMember>
            Public Overridable Property TotalClicks As Decimal

            <DataMember>
            Public Overridable Property Advertiser As String Implements IUserShortLink.Advertiser

            <DataMember>
            Public Overridable Property AdvertiserId As UInt32

            <DataMember>
            Public Overridable Property PercentChangePeriodOverPeriod As Decimal

            <DataMember>
            Public Overridable Property PreviousPeriodTotalClicks As Decimal

            <DataMember>
            Public Overridable Property IsArchived As UInt32

            <DataMember>
            Public Overridable Property IsArchivedInt As Integer

            <DataMember>
            Public Overridable Property FetchMetadata As Boolean

            <DataMember>
            Public Overridable Property ProductDisplayName1 As String Implements IUserShortLink.ProductDisplayName1

            <DataMember>
            Public Overridable Property ProductDisplayName2 As String Implements IUserShortLink.ProductDisplayName2

            <DataMember>
            Public Overridable Property ProductDisplayName3 As String

            <DataMember>
            Public Overridable Property ProductArtworkThumbnailUrl As String Implements IUserShortLink.ProductArtworkThumbnailUrl

            <DataMember>
            Public Overridable Property ProductArtworkThumbnailUrl100 As String Implements IUserShortLink.ProductArtworkThumbnailUrl100

            <DataMember>
            Public Overridable Property AdvertiserIcon As String

            <DataMember>
            Public Overridable Property AdvertiserIconCssClass As String

            <DataMember>
            Public Overridable Property IsGenius As Boolean

            <DataMember>
            Public Overridable Property AdvertiserIconTitle As String

            <DataMember>
            Public Overridable Property TrackingPixelIds As String

            <DataMember>
            Public Overridable Property ApplePreference As UInt32

            <DataMember>
            Public Overridable Property Aliases As List(Of ShortUrlAlias)

            <DataMember>
            Public Overridable Property LinkCreatorSetting As LinkCreatorOption
        End Class
    End Namespace

    Namespace ShortlinksAPI.ServiceModel.V4.Requests

        <DataContract>
        Public Partial Class GetShortLinkMetadataRequest
            Implements IGetShortLinkMetadataRequest
            <DataMember(Name:="baseCode")>
            Public Overridable Property BaseCode As String Implements IGetShortLinkMetadataRequest.BaseCode
        End Class
    End Namespace

    Namespace ShortlinksAPI.ServiceModel.V4.Responses

        <DataContract>
        Public Partial Class GetShortLinkMetadataResponse
            Implements IGetShortLinkMetadataResponse
            <DataMember(Name:="responseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus

            <DataMember(Name:="data")>
            Public Overridable Property Data As UserShortLink Implements IGetShortLinkMetadataResponse.Data
        End Class
    End Namespace
End Namespace

VB.NET GetShortLinkMetadataRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v4/links/metadata/{baseCode} HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"data":{"id":0,"destinationUrl":"String","shortUrlCode":"String","domain":"String","linkType":"NotSet","hasOverride":false,"productUrl":"String","trackingCode":"String","skipAffiliateRedirect":false,"createdUtc":"0001-01-01T00:00:00.0000000","updatedUtc":"0001-01-01T00:00:00.0000000","notes":"String","createdUserTime":"0001-01-01T00:00:00.0000000","updatedUserTime":"0001-01-01T00:00:00.0000000","tsid":0,"group":"String","username":"String","jsonMetadata":"String","jsonItemMetadata":"String","jsonPostProcessingRules":"String","jsonOverrides":"String","totalClicks":0,"advertiser":"String","advertiserId":0,"percentChangePeriodOverPeriod":0,"previousPeriodTotalClicks":0,"isArchived":0,"isArchivedInt":0,"fetchMetadata":false,"productDisplayName1":"String","productDisplayName2":"String","productDisplayName3":"String","productArtworkThumbnailUrl":"String","productArtworkThumbnailUrl100":"String","advertiserIcon":"String","advertiserIconCssClass":"String","isGenius":false,"advertiserIconTitle":"String","trackingPixelIds":"String","applePreference":0,"aliases":[{"code":"String","domain":"String","baseCode":"String","lastUpdatedUtc":"0001-01-01T00:00:00.0000000"}],"linkCreatorSetting":"NotSet"}}