Trendsic Platform Service

ContactVisitSummaryRequest

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

The following routes are available for this service:
GET,OPTIONS	/v1/contact/{ContactId}/visit-summary

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ContactVisitSummaryRequest
{
    open var ContactId:Int? = null
}

open class ContactVisitsResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Visits:ArrayList<ContactQueueVisit> = ArrayList<ContactQueueVisit>()
    open var Summary:ContactQueueVisitSummary? = null
}

open class ContactQueueVisit
{
    open var CheckinId:UUID? = null
    open var BranchId:UUID? = null
    open var BranchName:String? = null
    open var LineId:UUID? = null
    open var ServiceName:String? = null
    open var Outcome:Int? = null
    open var OutcomeLabel:String? = null
    open var IsAppointment:Boolean? = null
    open var SignInUtc:Date? = null
    open var CalledUtc:Date? = null
    open var FirstStartUtc:Date? = null
    open var CompletedTime:Date? = null
    open var WaitMinutes:Int? = null
    open var ServiceMinutes:Int? = null
    open var WindowName:String? = null
    open var TicketLabel:String? = null
    open var HoldReason:String? = null
    open var ReturnedTime:Date? = null
    open var PausedMinutes:Int? = null
}

open class ContactQueueVisitSummary
{
    open var Visits:Int? = null
    open var Completed:Int? = null
    open var NoShows:Int? = null
    open var NoShows90d:Int? = null
    open var Cancelled:Int? = null
    open var Unfulfilled:Int? = null
    open var Appointments:Int? = null
    open var LastVisitUtc:Date? = null
    open var LastNoShowUtc:Date? = null
    open var AvgWaitMinutes:Double? = null
    open var SmsOptIn:Boolean? = null
    open var TextsSent90d:Int? = null
    open var SayNameAs:String? = null
}

Kotlin ContactVisitSummaryRequest 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.

GET /v1/contact/{ContactId}/visit-summary HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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