ShortlinksAPI

<back to all web services

GetUserLinkRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links
GET/v4/links/{Id}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class V4BaseRequest:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class V4BaseResponse:
    response_status: Optional[ResponseStatus] = None


class LinkType(str, Enum):
    NONE = 'None'
    SIMPLE = 'Simple'
    SPLIT = 'Split'
    INTERSTITIAL = 'Interstitial'
    ADVANCED = 'Advanced'
    COLLECTION = 'Collection'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefreshableMetadata(IRefreshableMetadata):
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    updated_date: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VersionedRefreshableMetadata(RefreshableMetadata):
    version_created_date: datetime.datetime = datetime.datetime(1, 1, 1)


class IUserLink:
    url: Optional[str] = None
    base_code: Optional[str] = None
    link_type: Optional[LinkType] = None
    type_definition_public_id: Optional[str] = None
    metadata: Optional[VersionedRefreshableMetadata] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUserLinkResponse(V4BaseResponse, IGetUserLinkResponse):
    data: Optional[IUserLink] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUserLinkRequest(V4BaseRequest):
    id: Optional[str] = None
    username: Optional[str] = None
    group_id: int = 0

Python GetUserLinkRequest 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 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

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