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

namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ContactQueueVisit() = 
        member val CheckinId:Guid = new Guid() with get,set
        member val BranchId:Guid = new Guid() with get,set
        member val BranchName:String = null with get,set
        member val LineId:Guid = new Guid() with get,set
        member val ServiceName:String = null with get,set
        member val Outcome:Int32 = new Int32() with get,set
        member val OutcomeLabel:String = null with get,set
        member val IsAppointment:Boolean = new Boolean() with get,set
        member val SignInUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CalledUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val FirstStartUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CompletedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val WaitMinutes:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ServiceMinutes:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val WindowName:String = null with get,set
        member val TicketLabel:String = null with get,set
        member val HoldReason:String = null with get,set
        member val ReturnedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PausedMinutes:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ContactQueueVisitSummary() = 
        member val Visits:Int32 = new Int32() with get,set
        member val Completed:Int32 = new Int32() with get,set
        member val NoShows:Int32 = new Int32() with get,set
        member val NoShows90d:Int32 = new Int32() with get,set
        member val Cancelled:Int32 = new Int32() with get,set
        member val Unfulfilled:Int32 = new Int32() with get,set
        member val Appointments:Int32 = new Int32() with get,set
        member val LastVisitUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LastNoShowUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AvgWaitMinutes:Nullable<Double> = new Nullable<Double>() with get,set
        member val SmsOptIn:Boolean = new Boolean() with get,set
        member val TextsSent90d:Int32 = new Int32() with get,set
        member val SayNameAs:String = null with get,set

    [<AllowNullLiteral>]
    type ContactVisitsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Visits:ResizeArray<ContactQueueVisit> = new ResizeArray<ContactQueueVisit>() with get,set
        member val Summary:ContactQueueVisitSummary = null with get,set

    [<AllowNullLiteral>]
    type ContactVisitSummaryRequest() = 
        member val ContactId:Int32 = new Int32() with get,set

F# 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>