Trendsic Platform Service

<back to all web services

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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class ContactQueueVisit
    {
        public virtual Guid CheckinId { get; set; }
        public virtual Guid BranchId { get; set; }
        public virtual string BranchName { get; set; }
        public virtual Guid LineId { get; set; }
        public virtual string ServiceName { get; set; }
        public virtual int Outcome { get; set; }
        public virtual string OutcomeLabel { get; set; }
        public virtual bool IsAppointment { get; set; }
        public virtual DateTime? SignInUtc { get; set; }
        public virtual DateTime? CalledUtc { get; set; }
        public virtual DateTime? FirstStartUtc { get; set; }
        public virtual DateTime? CompletedTime { get; set; }
        public virtual int? WaitMinutes { get; set; }
        public virtual int? ServiceMinutes { get; set; }
        public virtual string WindowName { get; set; }
        public virtual string TicketLabel { get; set; }
        public virtual string HoldReason { get; set; }
        public virtual DateTime? ReturnedTime { get; set; }
        public virtual int PausedMinutes { get; set; }
    }

    public partial class ContactQueueVisitSummary
    {
        public virtual int Visits { get; set; }
        public virtual int Completed { get; set; }
        public virtual int NoShows { get; set; }
        public virtual int NoShows90d { get; set; }
        public virtual int Cancelled { get; set; }
        public virtual int Unfulfilled { get; set; }
        public virtual int Appointments { get; set; }
        public virtual DateTime? LastVisitUtc { get; set; }
        public virtual DateTime? LastNoShowUtc { get; set; }
        public virtual double? AvgWaitMinutes { get; set; }
        public virtual bool SmsOptIn { get; set; }
        public virtual int TextsSent90d { get; set; }
        public virtual string SayNameAs { get; set; }
    }

    public partial class ContactSayNameAsRequest
    {
        public virtual int ContactId { get; set; }
        public virtual string SayNameAs { get; set; }
    }

    public partial class ContactVisitsResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<ContactQueueVisit> Visits { get; set; } = [];
        public virtual ContactQueueVisitSummary Summary { get; set; }
    }

}

C# ContactSayNameAsRequest 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.

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

{"ContactId":0,"SayNameAs":"String"}
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"}},"Visits":[{"CheckinId":"00000000000000000000000000000000","BranchId":"00000000000000000000000000000000","BranchName":"String","LineId":"00000000000000000000000000000000","ServiceName":"String","Outcome":0,"OutcomeLabel":"String","IsAppointment":false,"SignInUtc":"0001-01-01T00:00:00.0000000","CalledUtc":"0001-01-01T00:00:00.0000000","FirstStartUtc":"0001-01-01T00:00:00.0000000","CompletedTime":"0001-01-01T00:00:00.0000000","WaitMinutes":0,"ServiceMinutes":0,"WindowName":"String","TicketLabel":"String","HoldReason":"String","ReturnedTime":"0001-01-01T00:00:00.0000000","PausedMinutes":0}],"Summary":{"Visits":0,"Completed":0,"NoShows":0,"NoShows90d":0,"Cancelled":0,"Unfulfilled":0,"Appointments":0,"LastVisitUtc":"0001-01-01T00:00:00.0000000","LastNoShowUtc":"0001-01-01T00:00:00.0000000","AvgWaitMinutes":0,"SmsOptIn":false,"TextsSent90d":0,"SayNameAs":"String"}}