| 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]]):
@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)
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
offset: int = 0
total: int = 0
results: Optional[List[Post]] = None
meta: Optional[Dict[str, str]] = None
response_status: Optional[ResponseStatus] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfPostclPpLQp2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechStacks.ServiceModel.Types">
<d2p1:Post>
<d2p1:Approved>false</d2p1:Approved>
<d2p1:Archived>false</d2p1:Archived>
<d2p1:Bumped>0001-01-01T00:00:00</d2p1:Bumped>
<d2p1:CategoryId>0</d2p1:CategoryId>
<d2p1:CommentsCount>0</d2p1:CommentsCount>
<d2p1:Content>String</d2p1:Content>
<d2p1:ContentHtml>String</d2p1:ContentHtml>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:CreatedBy>String</d2p1:CreatedBy>
<d2p1:Deleted>0001-01-01T00:00:00</d2p1:Deleted>
<d2p1:DeletedBy>String</d2p1:DeletedBy>
<d2p1:DownVotes>0</d2p1:DownVotes>
<d2p1:Favorites>0</d2p1:Favorites>
<d2p1:FromDate>0001-01-01T00:00:00</d2p1:FromDate>
<d2p1:Hidden>0001-01-01T00:00:00</d2p1:Hidden>
<d2p1:HiddenBy>String</d2p1:HiddenBy>
<d2p1:Id>0</d2p1:Id>
<d2p1:ImageUrl>String</d2p1:ImageUrl>
<d2p1:Labels xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:Labels>
<d2p1:LastCommentDate>0001-01-01T00:00:00</d2p1:LastCommentDate>
<d2p1:LastCommentId>0</d2p1:LastCommentId>
<d2p1:LastCommentUserId>0</d2p1:LastCommentUserId>
<d2p1:LinkedToCount>0</d2p1:LinkedToCount>
<d2p1:LinksCount>0</d2p1:LinksCount>
<d2p1:Location>String</d2p1:Location>
<d2p1:Locked>0001-01-01T00:00:00</d2p1:Locked>
<d2p1:LockedBy>String</d2p1:LockedBy>
<d2p1:Meta>String</d2p1:Meta>
<d2p1:MetaType>String</d2p1:MetaType>
<d2p1:Modified>0001-01-01T00:00:00</d2p1:Modified>
<d2p1:ModifiedBy>String</d2p1:ModifiedBy>
<d2p1:MuteUserIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>0</d4p1:int>
</d2p1:MuteUserIds>
<d2p1:OrganizationId>0</d2p1:OrganizationId>
<d2p1:PinCommentId>0</d2p1:PinCommentId>
<d2p1:Points>0</d2p1:Points>
<d2p1:Rank>0</d2p1:Rank>
<d2p1:RefId>0</d2p1:RefId>
<d2p1:RefLinks xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:RefLinks>
<d2p1:RefSource>String</d2p1:RefSource>
<d2p1:RefUrn>String</d2p1:RefUrn>
<d2p1:RefUserIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>0</d4p1:int>
</d2p1:RefUserIds>
<d2p1:ReplyCount>0</d2p1:ReplyCount>
<d2p1:ReportCount>0</d2p1:ReportCount>
<d2p1:Score>0</d2p1:Score>
<d2p1:Slug>String</d2p1:Slug>
<d2p1:Status>String</d2p1:Status>
<d2p1:StatusBy>String</d2p1:StatusBy>
<d2p1:StatusDate>0001-01-01T00:00:00</d2p1:StatusDate>
<d2p1:Subscribers>0</d2p1:Subscribers>
<d2p1:TechnologyIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>0</d4p1:int>
</d2p1:TechnologyIds>
<d2p1:Title>String</d2p1:Title>
<d2p1:ToDate>0001-01-01T00:00:00</d2p1:ToDate>
<d2p1:Type>Announcement</d2p1:Type>
<d2p1:UpVotes>0</d2p1:UpVotes>
<d2p1:Url>String</d2p1:Url>
<d2p1:UserId>0</d2p1:UserId>
<d2p1:Views>0</d2p1:Views>
<d2p1:WordCount>0</d2p1:WordCount>
</d2p1:Post>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfPostclPpLQp2>