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

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactVisitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Summary>
    <Appointments>0</Appointments>
    <AvgWaitMinutes>0</AvgWaitMinutes>
    <Cancelled>0</Cancelled>
    <Completed>0</Completed>
    <LastNoShowUtc>0001-01-01T00:00:00</LastNoShowUtc>
    <LastVisitUtc>0001-01-01T00:00:00</LastVisitUtc>
    <NoShows>0</NoShows>
    <NoShows90d>0</NoShows90d>
    <SayNameAs>String</SayNameAs>
    <SmsOptIn>false</SmsOptIn>
    <TextsSent90d>0</TextsSent90d>
    <Unfulfilled>0</Unfulfilled>
    <Visits>0</Visits>
  </Summary>
  <Visits>
    <ContactQueueVisit>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <CalledUtc>0001-01-01T00:00:00</CalledUtc>
      <CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
      <CompletedTime>0001-01-01T00:00:00</CompletedTime>
      <FirstStartUtc>0001-01-01T00:00:00</FirstStartUtc>
      <HoldReason>String</HoldReason>
      <IsAppointment>false</IsAppointment>
      <LineId>00000000-0000-0000-0000-000000000000</LineId>
      <Outcome>0</Outcome>
      <OutcomeLabel>String</OutcomeLabel>
      <PausedMinutes>0</PausedMinutes>
      <ReturnedTime>0001-01-01T00:00:00</ReturnedTime>
      <ServiceMinutes>0</ServiceMinutes>
      <ServiceName>String</ServiceName>
      <SignInUtc>0001-01-01T00:00:00</SignInUtc>
      <TicketLabel>String</TicketLabel>
      <WaitMinutes>0</WaitMinutes>
      <WindowName>String</WindowName>
    </ContactQueueVisit>
  </Visits>
</ContactVisitsResponse>