| Requires any of the roles: | Worker, Agent, Administrator |
| GET,OPTIONS | /v1/contact/{ContactId}/visit-summary |
|---|
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 ContactVisitsResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<ContactQueueVisit> Visits { get; set; } = [];
public virtual ContactQueueVisitSummary Summary { get; set; }
}
public partial class ContactVisitSummaryRequest
{
public virtual int ContactId { get; set; }
}
}
C# ContactVisitSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}