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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ContactSayNameAsRequest
    {
        public Integer ContactId = null;
        public String SayNameAs = null;
        
        public Integer getContactId() { return ContactId; }
        public ContactSayNameAsRequest setContactId(Integer value) { this.ContactId = value; return this; }
        public String getSayNameAs() { return SayNameAs; }
        public ContactSayNameAsRequest setSayNameAs(String value) { this.SayNameAs = value; return this; }
    }

    public static class ContactVisitsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<ContactQueueVisit> Visits = new ArrayList<ContactQueueVisit>();
        public ContactQueueVisitSummary Summary = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ContactVisitsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<ContactQueueVisit> getVisits() { return Visits; }
        public ContactVisitsResponse setVisits(ArrayList<ContactQueueVisit> value) { this.Visits = value; return this; }
        public ContactQueueVisitSummary getSummary() { return Summary; }
        public ContactVisitsResponse setSummary(ContactQueueVisitSummary value) { this.Summary = value; return this; }
    }

    public static class ContactQueueVisit
    {
        public UUID CheckinId = null;
        public UUID BranchId = null;
        public String BranchName = null;
        public UUID LineId = null;
        public String ServiceName = null;
        public Integer Outcome = null;
        public String OutcomeLabel = null;
        public Boolean IsAppointment = null;
        public Date SignInUtc = null;
        public Date CalledUtc = null;
        public Date FirstStartUtc = null;
        public Date CompletedTime = null;
        public Integer WaitMinutes = null;
        public Integer ServiceMinutes = null;
        public String WindowName = null;
        public String TicketLabel = null;
        public String HoldReason = null;
        public Date ReturnedTime = null;
        public Integer PausedMinutes = null;
        
        public UUID getCheckinId() { return CheckinId; }
        public ContactQueueVisit setCheckinId(UUID value) { this.CheckinId = value; return this; }
        public UUID getBranchId() { return BranchId; }
        public ContactQueueVisit setBranchId(UUID value) { this.BranchId = value; return this; }
        public String getBranchName() { return BranchName; }
        public ContactQueueVisit setBranchName(String value) { this.BranchName = value; return this; }
        public UUID getLineId() { return LineId; }
        public ContactQueueVisit setLineId(UUID value) { this.LineId = value; return this; }
        public String getServiceName() { return ServiceName; }
        public ContactQueueVisit setServiceName(String value) { this.ServiceName = value; return this; }
        public Integer getOutcome() { return Outcome; }
        public ContactQueueVisit setOutcome(Integer value) { this.Outcome = value; return this; }
        public String getOutcomeLabel() { return OutcomeLabel; }
        public ContactQueueVisit setOutcomeLabel(String value) { this.OutcomeLabel = value; return this; }
        public Boolean getIsAppointment() { return IsAppointment; }
        public ContactQueueVisit setIsAppointment(Boolean value) { this.IsAppointment = value; return this; }
        public Date getSignInUtc() { return SignInUtc; }
        public ContactQueueVisit setSignInUtc(Date value) { this.SignInUtc = value; return this; }
        public Date getCalledUtc() { return CalledUtc; }
        public ContactQueueVisit setCalledUtc(Date value) { this.CalledUtc = value; return this; }
        public Date getFirstStartUtc() { return FirstStartUtc; }
        public ContactQueueVisit setFirstStartUtc(Date value) { this.FirstStartUtc = value; return this; }
        public Date getCompletedTime() { return CompletedTime; }
        public ContactQueueVisit setCompletedTime(Date value) { this.CompletedTime = value; return this; }
        public Integer getWaitMinutes() { return WaitMinutes; }
        public ContactQueueVisit setWaitMinutes(Integer value) { this.WaitMinutes = value; return this; }
        public Integer getServiceMinutes() { return ServiceMinutes; }
        public ContactQueueVisit setServiceMinutes(Integer value) { this.ServiceMinutes = value; return this; }
        public String getWindowName() { return WindowName; }
        public ContactQueueVisit setWindowName(String value) { this.WindowName = value; return this; }
        public String getTicketLabel() { return TicketLabel; }
        public ContactQueueVisit setTicketLabel(String value) { this.TicketLabel = value; return this; }
        public String getHoldReason() { return HoldReason; }
        public ContactQueueVisit setHoldReason(String value) { this.HoldReason = value; return this; }
        public Date getReturnedTime() { return ReturnedTime; }
        public ContactQueueVisit setReturnedTime(Date value) { this.ReturnedTime = value; return this; }
        public Integer getPausedMinutes() { return PausedMinutes; }
        public ContactQueueVisit setPausedMinutes(Integer value) { this.PausedMinutes = value; return this; }
    }

    public static class ContactQueueVisitSummary
    {
        public Integer Visits = null;
        public Integer Completed = null;
        public Integer NoShows = null;
        public Integer NoShows90d = null;
        public Integer Cancelled = null;
        public Integer Unfulfilled = null;
        public Integer Appointments = null;
        public Date LastVisitUtc = null;
        public Date LastNoShowUtc = null;
        public Double AvgWaitMinutes = null;
        public Boolean SmsOptIn = null;
        public Integer TextsSent90d = null;
        public String SayNameAs = null;
        
        public Integer getVisits() { return Visits; }
        public ContactQueueVisitSummary setVisits(Integer value) { this.Visits = value; return this; }
        public Integer getCompleted() { return Completed; }
        public ContactQueueVisitSummary setCompleted(Integer value) { this.Completed = value; return this; }
        public Integer getNoShows() { return NoShows; }
        public ContactQueueVisitSummary setNoShows(Integer value) { this.NoShows = value; return this; }
        public Integer getNoShows90d() { return NoShows90d; }
        public ContactQueueVisitSummary setNoShows90d(Integer value) { this.NoShows90d = value; return this; }
        public Integer getCancelled() { return Cancelled; }
        public ContactQueueVisitSummary setCancelled(Integer value) { this.Cancelled = value; return this; }
        public Integer getUnfulfilled() { return Unfulfilled; }
        public ContactQueueVisitSummary setUnfulfilled(Integer value) { this.Unfulfilled = value; return this; }
        public Integer getAppointments() { return Appointments; }
        public ContactQueueVisitSummary setAppointments(Integer value) { this.Appointments = value; return this; }
        public Date getLastVisitUtc() { return LastVisitUtc; }
        public ContactQueueVisitSummary setLastVisitUtc(Date value) { this.LastVisitUtc = value; return this; }
        public Date getLastNoShowUtc() { return LastNoShowUtc; }
        public ContactQueueVisitSummary setLastNoShowUtc(Date value) { this.LastNoShowUtc = value; return this; }
        public Double getAvgWaitMinutes() { return AvgWaitMinutes; }
        public ContactQueueVisitSummary setAvgWaitMinutes(Double value) { this.AvgWaitMinutes = value; return this; }
        public Boolean isSmsOptIn() { return SmsOptIn; }
        public ContactQueueVisitSummary setSmsOptIn(Boolean value) { this.SmsOptIn = value; return this; }
        public Integer getTextsSent90d() { return TextsSent90d; }
        public ContactQueueVisitSummary setTextsSent90d(Integer value) { this.TextsSent90d = value; return this; }
        public String getSayNameAs() { return SayNameAs; }
        public ContactQueueVisitSummary setSayNameAs(String value) { this.SayNameAs = value; return this; }
    }

}

Java ContactSayNameAsRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	ContactId: 0,
	SayNameAs: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			CalledUtc: 0001-01-01,
			FirstStartUtc: 0001-01-01,
			CompletedTime: 0001-01-01,
			WaitMinutes: 0,
			ServiceMinutes: 0,
			WindowName: String,
			TicketLabel: String,
			HoldReason: String,
			ReturnedTime: 0001-01-01,
			PausedMinutes: 0
		}
	],
	Summary: 
	{
		Visits: 0,
		Completed: 0,
		NoShows: 0,
		NoShows90d: 0,
		Cancelled: 0,
		Unfulfilled: 0,
		Appointments: 0,
		LastVisitUtc: 0001-01-01,
		LastNoShowUtc: 0001-01-01,
		AvgWaitMinutes: 0,
		SmsOptIn: False,
		TextsSent90d: 0,
		SayNameAs: String
	}
}