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

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

<CommentCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.Comments.DTO">
  <Captcha>
    <Answer>String</Answer>
    <CorrectAnswer>String</CorrectAnswer>
    <InitializationVector>String</InitializationVector>
    <Key>String</Key>
  </Captcha>
  <CustomData>String</CustomData>
  <Email>String</Email>
  <Message>String</Message>
  <Name>String</Name>
  <Rating>0</Rating>
  <Thread>
    <Behavior>String</Behavior>
    <DataSource>String</DataSource>
    <Group>
      <Description>String</Description>
      <Key>String</Key>
      <Name>String</Name>
    </Group>
    <GroupKey>String</GroupKey>
    <Key>String</Key>
    <Language>String</Language>
    <Title>String</Title>
    <Type>String</Type>
  </Thread>
  <ThreadKey>String</ThreadKey>
</CommentCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.Comments.DTO">
  <AuthorIpAddress>String</AuthorIpAddress>
  <CustomData>String</CustomData>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <Email>String</Email>
  <Key>String</Key>
  <Message>String</Message>
  <Name>String</Name>
  <ProfilePictureThumbnailUrl>String</ProfilePictureThumbnailUrl>
  <ProfilePictureUrl>String</ProfilePictureUrl>
  <Rating>0</Rating>
  <Status>String</Status>
  <ThreadKey>String</ThreadKey>
</CommentResponse>