ShortlinksAPI

<back to all web services

PutUserLinkRequest

Requires Authentication
The following routes are available for this service:
PUT/v4/links
PUT/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


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


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 PutUserLinkRequest(V4BaseRequest, IPutUserLinkRequest):
    id: Optional[str] = None
    link_type: Optional[LinkType] = None
    type_definition_public_id: Optional[str] = None

Python PutUserLinkRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /v4/links HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","linkType":"None","typeDefinitionPublicId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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