Trendsic Platform Service

<back to all web services

ConversationHeaderRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/ConversationHeader
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 ConversationHeaderResponse:
    response_status: Optional[ResponseStatus] = None
    conversation_header: Optional[ConversationHeader] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConversationHeaderRequest:
    conversation_header: Optional[ConversationHeader] = None

Python ConversationHeaderRequest DTOs

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

HTTP + CSV

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

POST /v1/ConversationHeader HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ConversationHeader":{"ConversationHeaderId":"00000000000000000000000000000000","TableName":"String","FieldName":"String","RecordId":0,"AgentHasRead":false,"AdminHasRead":false}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ConversationHeader":{"ConversationHeaderId":"00000000000000000000000000000000","TableName":"String","FieldName":"String","RecordId":0,"AgentHasRead":false,"AdminHasRead":false}}