ShortlinksAPI

<back to all web services

GetUserLinksRequest

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 V4PaginatedBaseRequest(V4BaseRequest):
    offset: int = 0
    limit: int = 0


@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 V4PageObject:
    offset: int = 0
    limit: int = 0
    total_records: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class V4PaginatedBaseResponse(V4BaseResponse):
    page: Optional[V4PageObject] = 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 GetUserLinksResponse(V4PaginatedBaseResponse, IGetUserLinksResponse):
    data: Optional[List[IUserLink]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUserLinksRequest(V4PaginatedBaseRequest):
    username: Optional[str] = None
    group_id: int = 0
    link_type: Optional[LinkType] = None

Python GetUserLinksRequest DTOs

GET /v4/links/list HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: text/jsv

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

{
	page: 
	{
		offset: 0,
		limit: 0,
		totalRecords: 0
	},
	status: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}