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
ContactSayNameAsRequest Parameters:
NameParameterData TypeRequiredDescription
ContactIdpathintNo
SayNameAsbodystringNo
ContactVisitsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
VisitsformList<ContactQueueVisit>No
SummaryformContactQueueVisitSummaryNo
ContactQueueVisit Parameters:
NameParameterData TypeRequiredDescription
CheckinIdformGuidNo
BranchIdformGuidNo
BranchNameformstringNo
LineIdformGuidNo
ServiceNameformstringNo
OutcomeformintNo
OutcomeLabelformstringNo
IsAppointmentformboolNo
SignInUtcformDateTime?No
CalledUtcformDateTime?No
FirstStartUtcformDateTime?No
CompletedTimeformDateTime?No
WaitMinutesformint?No
ServiceMinutesformint?No
WindowNameformstringNo
TicketLabelformstringNo
HoldReasonformstringNo
ReturnedTimeformDateTime?No
PausedMinutesformintNo
ContactQueueVisitSummary Parameters:
NameParameterData TypeRequiredDescription
VisitsformintNo
CompletedformintNo
NoShowsformintNo
NoShows90dformintNo
CancelledformintNo
UnfulfilledformintNo
AppointmentsformintNo
LastVisitUtcformDateTime?No
LastNoShowUtcformDateTime?No
AvgWaitMinutesformdouble?No
SmsOptInformboolNo
TextsSent90dformintNo
SayNameAsformstringNo

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
	}
}