adnx.tanchinhdo.api

<back to all web services

GetPostByCategoryRequest

The following routes are available for this service:
GET/posts/{category}
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 PagingRequest:
    page: int = 0
    limit: int = 0
    off_set: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CategoryResponse:
    id: int = 0
    name: Optional[str] = None
    slug: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostResponse:
    id: int = 0
    title: Optional[str] = None
    slug: Optional[str] = None
    description: Optional[str] = None
    body: Optional[str] = None
    category_id: int = 0
    category: Optional[CategoryResponse] = None
    image_url: Optional[str] = None
    view_count: int = 0
    is_published: bool = False
    published_date: datetime.datetime = datetime.datetime(1, 1, 1)
    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 GetPostByCategoryRequest(PagingRequest):
    category: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Pagination:
    total: int = 0
    pages: int = 0
    offset: int = 0
    limit: int = 0
    current_page: int = 0


PostResponse = TypeVar('PostResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PageResponse(Generic[PostResponse], IResponseRequest):
    code: int = 0
    message: Optional[str] = None
    data: Optional[List[PostResponse]] = None
    pagination: Optional[Pagination] = None

Python GetPostByCategoryRequest 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/{category} HTTP/1.1 
Host: tanchinhdo-api-sandbox.adnx.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			id: 0,
			title: String,
			slug: String,
			description: String,
			body: String,
			categoryId: 0,
			category: 
			{
				id: 0,
				name: String,
				slug: String
			},
			imageUrl: String,
			viewCount: 0,
			isPublished: False
		}
	]
}