Trendsic Platform Service

ContactSayNameAsRequest

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

The following routes are available for this service:
PUT,OPTIONS	/v1/contact/{ContactId}/say-name-as

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 ContactQueueVisit:
    checkin_id: Optional[str] = None
    branch_id: Optional[str] = None
    branch_name: Optional[str] = None
    line_id: Optional[str] = None
    service_name: Optional[str] = None
    outcome: int = 0
    outcome_label: Optional[str] = None
    is_appointment: bool = False
    sign_in_utc: Optional[datetime.datetime] = None
    called_utc: Optional[datetime.datetime] = None
    first_start_utc: Optional[datetime.datetime] = None
    completed_time: Optional[datetime.datetime] = None
    wait_minutes: Optional[int] = None
    service_minutes: Optional[int] = None
    window_name: Optional[str] = None
    ticket_label: Optional[str] = None
    hold_reason: Optional[str] = None
    returned_time: Optional[datetime.datetime] = None
    paused_minutes: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactQueueVisitSummary:
    visits: int = 0
    completed: int = 0
    no_shows: int = 0
    no_shows90d: int = 0
    cancelled: int = 0
    unfulfilled: int = 0
    appointments: int = 0
    last_visit_utc: Optional[datetime.datetime] = None
    last_no_show_utc: Optional[datetime.datetime] = None
    avg_wait_minutes: Optional[float] = None
    sms_opt_in: bool = False
    texts_sent90d: int = 0
    say_name_as: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactVisitsResponse:
    response_status: Optional[ResponseStatus] = None
    visits: List[ContactQueueVisit] = field(default_factory=list)
    summary: Optional[ContactQueueVisitSummary] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactSayNameAsRequest:
    contact_id: int = 0
    say_name_as: Optional[str] = None

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

PUT /v1/contact/{ContactId}/say-name-as HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContactSayNameAsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactId>0</ContactId>
  <SayNameAs>String</SayNameAs>
</ContactSayNameAsRequest>

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

<ContactVisitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Summary>
    <Appointments>0</Appointments>
    <AvgWaitMinutes>0</AvgWaitMinutes>
    <Cancelled>0</Cancelled>
    <Completed>0</Completed>
    <LastNoShowUtc>0001-01-01T00:00:00</LastNoShowUtc>
    <LastVisitUtc>0001-01-01T00:00:00</LastVisitUtc>
    <NoShows>0</NoShows>
    <NoShows90d>0</NoShows90d>
    <SayNameAs>String</SayNameAs>
    <SmsOptIn>false</SmsOptIn>
    <TextsSent90d>0</TextsSent90d>
    <Unfulfilled>0</Unfulfilled>
    <Visits>0</Visits>
  </Summary>
  <Visits>
    <ContactQueueVisit>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <CalledUtc>0001-01-01T00:00:00</CalledUtc>
      <CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
      <CompletedTime>0001-01-01T00:00:00</CompletedTime>
      <FirstStartUtc>0001-01-01T00:00:00</FirstStartUtc>
      <HoldReason>String</HoldReason>
      <IsAppointment>false</IsAppointment>
      <LineId>00000000-0000-0000-0000-000000000000</LineId>
      <Outcome>0</Outcome>
      <OutcomeLabel>String</OutcomeLabel>
      <PausedMinutes>0</PausedMinutes>
      <ReturnedTime>0001-01-01T00:00:00</ReturnedTime>
      <ServiceMinutes>0</ServiceMinutes>
      <ServiceName>String</ServiceName>
      <SignInUtc>0001-01-01T00:00:00</SignInUtc>
      <TicketLabel>String</TicketLabel>
      <WaitMinutes>0</WaitMinutes>
      <WindowName>String</WindowName>
    </ContactQueueVisit>
  </Visits>
</ContactVisitsResponse>