TechStacks!

<back to all web services

QueryPosts

AutoQueryPosts
The following routes are available for this service:
GET/posts
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 QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None
    @staticmethod
    def response_type(): return QueryResponse[T]


class PostType(str, Enum):
    ANNOUNCEMENT = 'Announcement'
    POST = 'Post'
    SHOWCASE = 'Showcase'
    QUESTION = 'Question'
    REQUEST = 'Request'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Post:
    id: int = 0
    organization_id: int = 0
    user_id: int = 0
    type: Optional[PostType] = None
    category_id: int = 0
    title: Optional[str] = None
    slug: Optional[str] = None
    url: Optional[str] = None
    image_url: Optional[str] = None
    # @StringLength(2147483647)
    content: Optional[str] = None

    # @StringLength(2147483647)
    content_html: Optional[str] = None

    pin_comment_id: Optional[int] = None
    technology_ids: Optional[List[int]] = None
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None
    location: Optional[str] = None
    meta_type: Optional[str] = None
    meta: Optional[str] = None
    approved: bool = False
    up_votes: int = 0
    down_votes: int = 0
    points: int = 0
    views: int = 0
    favorites: int = 0
    subscribers: int = 0
    reply_count: int = 0
    comments_count: int = 0
    word_count: int = 0
    report_count: int = 0
    links_count: int = 0
    linked_to_count: int = 0
    score: int = 0
    rank: int = 0
    labels: Optional[List[str]] = None
    ref_user_ids: Optional[List[int]] = None
    ref_links: Optional[List[str]] = None
    mute_user_ids: Optional[List[int]] = None
    last_comment_date: Optional[datetime.datetime] = None
    last_comment_id: Optional[int] = None
    last_comment_user_id: Optional[int] = None
    deleted: Optional[datetime.datetime] = None
    deleted_by: Optional[str] = None
    locked: Optional[datetime.datetime] = None
    locked_by: Optional[str] = None
    hidden: Optional[datetime.datetime] = None
    hidden_by: Optional[str] = None
    status: Optional[str] = None
    status_date: Optional[datetime.datetime] = None
    status_by: Optional[str] = None
    archived: bool = False
    bumped: Optional[datetime.datetime] = None
    created: datetime.datetime = datetime.datetime(1, 1, 1)
    created_by: Optional[str] = None
    modified: datetime.datetime = datetime.datetime(1, 1, 1)
    modified_by: Optional[str] = None
    ref_id: Optional[int] = None
    ref_source: Optional[str] = None
    ref_urn: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryPosts(QueryDb[Post]):
    ids: Optional[List[int]] = None
    organization_id: Optional[int] = None
    organization_ids: Optional[List[int]] = None
    types: Optional[List[str]] = None
    any_technology_ids: Optional[List[int]] = None
    is_: Optional[List[str]] = field(metadata=config(field_name='is'), default=None)
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


Post = TypeVar('Post')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[Post]):
    offset: int = 0
    total: int = 0
    results: Optional[List[Post]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python QueryPosts 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.

GET /posts HTTP/1.1 
Host: techstacks.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			organizationId: 0,
			userId: 0,
			type: Announcement,
			categoryId: 0,
			title: String,
			slug: String,
			url: String,
			imageUrl: String,
			content: String,
			contentHtml: String,
			pinCommentId: 0,
			technologyIds: 
			[
				0
			],
			fromDate: 0001-01-01,
			toDate: 0001-01-01,
			location: String,
			metaType: String,
			meta: String,
			approved: False,
			upVotes: 0,
			downVotes: 0,
			points: 0,
			views: 0,
			favorites: 0,
			subscribers: 0,
			replyCount: 0,
			commentsCount: 0,
			wordCount: 0,
			reportCount: 0,
			linksCount: 0,
			linkedToCount: 0,
			score: 0,
			rank: 0,
			labels: 
			[
				String
			],
			refUserIds: 
			[
				0
			],
			refLinks: 
			[
				String
			],
			muteUserIds: 
			[
				0
			],
			lastCommentDate: 0001-01-01,
			lastCommentId: 0,
			lastCommentUserId: 0,
			deleted: 0001-01-01,
			deletedBy: String,
			locked: 0001-01-01,
			lockedBy: String,
			hidden: 0001-01-01,
			hiddenBy: String,
			status: String,
			statusDate: 0001-01-01,
			statusBy: String,
			archived: False,
			bumped: 0001-01-01,
			created: 0001-01-01,
			createdBy: String,
			modified: 0001-01-01,
			modifiedBy: String,
			refId: 0,
			refSource: String,
			refUrn: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}