ShortlinksAPI

PostUserLinkRequest

The following routes are available for this service:
POST	/v4/links

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 PostUserLinkResponse(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 PostUserLinkRequest(V4BaseRequest, IPostUserLinkRequest):
    base_code: Optional[str] = None
    link_type: Optional[LinkType] = None
    type_definition_public_id: Optional[str] = None

Python PostUserLinkRequest DTOs

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

HTTP + JSV

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

POST /v4/links HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	baseCode: String,
	linkType: None,
	typeDefinitionPublicId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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