<back to all web services

CommentCreateRequest

The following routes are available for this service:
POST/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 GroupCreateRequest:
    key: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ThreadCreateRequest:
    key: Optional[str] = None
    type: Optional[str] = None
    behavior: Optional[str] = None
    title: Optional[str] = None
    language: Optional[str] = None
    data_source: Optional[str] = None
    group_key: Optional[str] = None
    group: Optional[GroupCreateRequest] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CaptchaInfo:
    answer: Optional[str] = None
    correct_answer: Optional[str] = None
    initialization_vector: Optional[str] = None
    key: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommentCreateRequest:
    message: Optional[str] = None
    name: Optional[str] = None
    email: Optional[str] = None
    custom_data: Optional[str] = None
    thread_key: Optional[str] = None
    thread: Optional[ThreadCreateRequest] = None
    captcha: Optional[CaptchaInfo] = None
    rating: Optional[Decimal] = None


@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

Python CommentCreateRequest DTOs

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

HTTP + OTHER

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

POST /RestApi/comments-api/comments HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Message":"String","Name":"String","Email":"String","CustomData":"String","ThreadKey":"String","Thread":{"Key":"String","Type":"String","Behavior":"String","Title":"String","Language":"String","DataSource":"String","GroupKey":"String","Group":{"Key":"String","Name":"String","Description":"String"}},"Captcha":{"Answer":"String","CorrectAnswer":"String","InitializationVector":"String","Key":"String"},"Rating":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Key":"String","Name":"String","Message":"String","DateCreated":"\/Date(-62135596800000-0000)\/","ProfilePictureUrl":"String","ProfilePictureThumbnailUrl":"String","Status":"String","Email":"String","ThreadKey":"String","AuthorIpAddress":"String","CustomData":"String","Rating":0}