Trendsic Platform Service

ContactVisitsRequest

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

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

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 ContactVisitsRequest:
    contact_id: int = 0
    take: int = 0

Python ContactVisitsRequest 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}/visits 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
	}
}