| Requires any of the roles: | Worker, Agent, Administrator |
| GET,OPTIONS | /v1/contact/{ContactId}/visit-summary |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Visits | form | List<ContactQueueVisit> | No | |
| Summary | form | ContactQueueVisitSummary | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CheckinId | form | Guid | No | |
| BranchId | form | Guid | No | |
| BranchName | form | string | No | |
| LineId | form | Guid | No | |
| ServiceName | form | string | No | |
| Outcome | form | int | No | |
| OutcomeLabel | form | string | No | |
| IsAppointment | form | bool | No | |
| SignInUtc | form | DateTime? | No | |
| CalledUtc | form | DateTime? | No | |
| FirstStartUtc | form | DateTime? | No | |
| CompletedTime | form | DateTime? | No | |
| WaitMinutes | form | int? | No | |
| ServiceMinutes | form | int? | No | |
| WindowName | form | string | No | |
| TicketLabel | form | string | No | |
| HoldReason | form | string | No | |
| ReturnedTime | form | DateTime? | No | |
| PausedMinutes | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Visits | form | int | No | |
| Completed | form | int | No | |
| NoShows | form | int | No | |
| NoShows90d | form | int | No | |
| Cancelled | form | int | No | |
| Unfulfilled | form | int | No | |
| Appointments | form | int | No | |
| LastVisitUtc | form | DateTime? | No | |
| LastNoShowUtc | form | DateTime? | No | |
| AvgWaitMinutes | form | double? | No | |
| SmsOptIn | form | bool | No | |
| TextsSent90d | form | int | No | |
| SayNameAs | form | string | No |
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
}
}