Trendsic Platform Service

CustomerNotesRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET,POST,OPTIONS	/v1/customercheckins/{Id}/notes

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 CustomerNote:
    note_id: int = 0
    scope: Optional[str] = None
    text: Optional[str] = None
    is_priority: bool = False
    created_by_user_id: Optional[str] = None
    created_by_name: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    done_at: Optional[datetime.datetime] = None
    is_carry: bool = False
    shown_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerNoteResponse:
    response_status: Optional[ResponseStatus] = None
    notes: List[CustomerNote] = field(default_factory=list)
    carry: List[CustomerNote] = field(default_factory=list)
    can_priority: bool = False
    note: Optional[CustomerNote] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerNotesRequest:
    id: Optional[str] = None
    text: Optional[str] = None
    scope: Optional[str] = None
    is_priority: bool = False

Python CustomerNotesRequest 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 /v1/customercheckins/{Id}/notes HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerNotesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <IsPriority>false</IsPriority>
  <Scope>String</Scope>
  <Text>String</Text>
</CustomerNotesRequest>

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

<CustomerNoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanPriority>false</CanPriority>
  <Carry>
    <CustomerNote>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedByName>String</CreatedByName>
      <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
      <DoneAt>0001-01-01T00:00:00</DoneAt>
      <IsCarry>false</IsCarry>
      <IsPriority>false</IsPriority>
      <NoteId>0</NoteId>
      <Scope>String</Scope>
      <ShownAt>0001-01-01T00:00:00</ShownAt>
      <Text>String</Text>
    </CustomerNote>
  </Carry>
  <Note>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedByName>String</CreatedByName>
    <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
    <DoneAt>0001-01-01T00:00:00</DoneAt>
    <IsCarry>false</IsCarry>
    <IsPriority>false</IsPriority>
    <NoteId>0</NoteId>
    <Scope>String</Scope>
    <ShownAt>0001-01-01T00:00:00</ShownAt>
    <Text>String</Text>
  </Note>
  <Notes>
    <CustomerNote>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedByName>String</CreatedByName>
      <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
      <DoneAt>0001-01-01T00:00:00</DoneAt>
      <IsCarry>false</IsCarry>
      <IsPriority>false</IsPriority>
      <NoteId>0</NoteId>
      <Scope>String</Scope>
      <ShownAt>0001-01-01T00:00:00</ShownAt>
      <Text>String</Text>
    </CustomerNote>
  </Notes>
  <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>
</CustomerNoteResponse>