Trendsic Platform Service

<back to all web services

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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class ContactQueueVisit
            Public Overridable Property CheckinId As Guid
            Public Overridable Property BranchId As Guid
            Public Overridable Property BranchName As String
            Public Overridable Property LineId As Guid
            Public Overridable Property ServiceName As String
            Public Overridable Property Outcome As Integer
            Public Overridable Property OutcomeLabel As String
            Public Overridable Property IsAppointment As Boolean
            Public Overridable Property SignInUtc As Date?
            Public Overridable Property CalledUtc As Date?
            Public Overridable Property FirstStartUtc As Date?
            Public Overridable Property CompletedTime As Date?
            Public Overridable Property WaitMinutes As Integer?
            Public Overridable Property ServiceMinutes As Integer?
            Public Overridable Property WindowName As String
            Public Overridable Property TicketLabel As String
            Public Overridable Property HoldReason As String
            Public Overridable Property ReturnedTime As Date?
            Public Overridable Property PausedMinutes As Integer
        End Class

        Public Partial Class ContactQueueVisitSummary
            Public Overridable Property Visits As Integer
            Public Overridable Property Completed As Integer
            Public Overridable Property NoShows As Integer
            Public Overridable Property NoShows90d As Integer
            Public Overridable Property Cancelled As Integer
            Public Overridable Property Unfulfilled As Integer
            Public Overridable Property Appointments As Integer
            Public Overridable Property LastVisitUtc As Date?
            Public Overridable Property LastNoShowUtc As Date?
            Public Overridable Property AvgWaitMinutes As Double?
            Public Overridable Property SmsOptIn As Boolean
            Public Overridable Property TextsSent90d As Integer
            Public Overridable Property SayNameAs As String
        End Class

        Public Partial Class ContactVisitsRequest
            Public Overridable Property ContactId As Integer
            Public Overridable Property Take As Integer
        End Class

        Public Partial Class ContactVisitsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Visits As List(Of ContactQueueVisit) = New List(Of ContactQueueVisit)
            Public Overridable Property Summary As ContactQueueVisitSummary
        End Class
    End Namespace
End Namespace

VB.NET ContactVisitsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","CalledUtc":"0001-01-01T00:00:00.0000000","FirstStartUtc":"0001-01-01T00:00:00.0000000","CompletedTime":"0001-01-01T00:00:00.0000000","WaitMinutes":0,"ServiceMinutes":0,"WindowName":"String","TicketLabel":"String","HoldReason":"String","ReturnedTime":"0001-01-01T00:00:00.0000000","PausedMinutes":0}],"Summary":{"Visits":0,"Completed":0,"NoShows":0,"NoShows90d":0,"Cancelled":0,"Unfulfilled":0,"Appointments":0,"LastVisitUtc":"0001-01-01T00:00:00.0000000","LastNoShowUtc":"0001-01-01T00:00:00.0000000","AvgWaitMinutes":0,"SmsOptIn":false,"TextsSent90d":0,"SayNameAs":"String"}}