Trendsic Platform Service

ConversationByHeaderRequest

The following routes are available for this service:
GET	/v1/ConversationByHeader/{HeaderId}

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 ConversationHeader:
    conversation_header_id: Optional[str] = None
    table_name: Optional[str] = None
    field_name: Optional[str] = None
    record_id: int = 0
    agent_has_read: bool = False
    admin_has_read: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConversationDetail:
    conversation_detail_id: Optional[str] = None
    conversation_header_id: Optional[str] = None
    comment: Optional[str] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    created_by: Optional[str] = None
    created_by_name: Optional[str] = None
    attachment_id: Optional[str] = None
    is_admin_comment: bool = False
    is_deleted_comment: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Conversation(ConversationHeader):
    details: List[ConversationDetail] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConversationResponse:
    response_status: Optional[ResponseStatus] = None
    conversation: Optional[Conversation] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConversationByHeaderRequest:
    header_id: Optional[str] = None

Python ConversationByHeaderRequest 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 /v1/ConversationByHeader/{HeaderId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ConversationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Conversation>
    <AdminHasRead>false</AdminHasRead>
    <AgentHasRead>false</AgentHasRead>
    <ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
    <FieldName>String</FieldName>
    <RecordId>0</RecordId>
    <TableName>String</TableName>
    <Details>
      <ConversationDetail>
        <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
        <Comment>String</Comment>
        <ConversationDetailId>00000000-0000-0000-0000-000000000000</ConversationDetailId>
        <ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
        <CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
        <CreatedByName>String</CreatedByName>
        <DateCreated xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DateCreated>
        <IsAdminComment>false</IsAdminComment>
        <IsDeletedComment>false</IsDeletedComment>
      </ConversationDetail>
    </Details>
  </Conversation>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
</ConversationResponse>