<back to all web services

CommentsFilter

The following routes are available for this service:
GET/RestApi/comments-api/comments
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 CommentResponse:
    key: Optional[str] = None
    name: Optional[str] = None
    message: Optional[str] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    profile_picture_url: Optional[str] = None
    profile_picture_thumbnail_url: Optional[str] = None
    status: Optional[str] = None
    email: Optional[str] = None
    thread_key: Optional[str] = None
    author_ip_address: Optional[str] = None
    custom_data: Optional[str] = None
    rating: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommentsFilter:
    thread_key: Optional[str] = None
    skip: int = 0
    take: int = 0
    sort_descending: bool = False
    newer_than: datetime.datetime = datetime.datetime(1, 1, 1)
    older_than: datetime.datetime = datetime.datetime(1, 1, 1)


CommentResponse = TypeVar('CommentResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CollectionResponse(Generic[CommentResponse]):
    total_count: int = 0
    items: Optional[List[CommentResponse]] = None

Python CommentsFilter DTOs

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

HTTP + XML

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

GET /RestApi/comments-api/comments HTTP/1.1 
Host: www.asg.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CollectionResponseOfCommentResponseXvaRN2Ag xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.Comments.DTO">
  <Items i:nil="true" />
  <TotalCount>0</TotalCount>
</CollectionResponseOfCommentResponseXvaRN2Ag>