Trendsic Platform Service

<back to all web services

KpiV2VisitsRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/kpiv2/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 KpiV2VisitsRequest
            Public Overridable Property BranchId As Guid
            Public Overridable Property FromDate As Date
            Public Overridable Property ToDate As Date
            Public Overridable Property StationId As Guid?
            Public Overridable Property EmployeeId As Guid?
            Public Overridable Property Outcome As String
            Public Overridable Property LineId As Guid?
            Public Overridable Property Page As Integer
            Public Overridable Property PageSize As Integer
        End Class

        Public Partial Class KpiV2VisitsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Visits As SvcVisitPage
        End Class

        Public Partial Class SvcChip
            Public Overridable Property LineId As Guid
            Public Overridable Property Name As String
            Public Overridable Property N As Integer
        End Class

        Public Partial Class SvcVisitPage
            Public Overridable Property Rows As List(Of SvcVisitRow) = New List(Of SvcVisitRow)
            Public Overridable Property TotalRows As Integer
            Public Overridable Property Page As Integer
            Public Overridable Property PageSize As Integer
            Public Overridable Property OutcomeCounts As Dictionary(Of String, Integer) = New Dictionary(Of String, Integer)
            Public Overridable Property Services As List(Of SvcChip) = New List(Of SvcChip)
            Public Overridable Property CanSeeStaff As Boolean
            Public Overridable Property CanSeeFinancial As Boolean
        End Class

        Public Partial Class SvcVisitRow
            Public Overridable Property CheckinId As Guid
            Public Overridable Property TicketLabel As String
            Public Overridable Property LocalDate As Date
            Public Overridable Property LineId As Guid
            Public Overridable Property ServiceName As String
            Public Overridable Property StationId As Guid?
            Public Overridable Property StationName As String
            Public Overridable Property EmployeeId As Guid?
            Public Overridable Property EmployeeName As String
            Public Overridable Property CustomerName As String
            Public Overridable Property ContactId As Integer?
            Public Overridable Property ContactAgentId As Integer?
            Public Overridable Property CustomerId As Guid
            Public Overridable Property IsAppointment As Boolean
            Public Overridable Property LocalHere As Date?
            Public Overridable Property LocalCalled As Date?
            Public Overridable Property LocalStart As Date?
            Public Overridable Property LocalEnd As Date?
            Public Overridable Property WaitSec As Integer?
            Public Overridable Property ServeSec As Integer?
            Public Overridable Property Outcome As String
            Public Overridable Property Fee As Decimal?
        End Class
    End Namespace
End Namespace

VB.NET KpiV2VisitsRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dashboard/kpiv2/visits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"BranchId":"00000000000000000000000000000000","FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","StationId":"00000000000000000000000000000000","EmployeeId":"00000000000000000000000000000000","Outcome":"String","LineId":"00000000000000000000000000000000","Page":0,"PageSize":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Visits":{"Rows":[{"CheckinId":"00000000000000000000000000000000","TicketLabel":"String","LocalDate":"0001-01-01T00:00:00.0000000","LineId":"00000000000000000000000000000000","ServiceName":"String","StationId":"00000000000000000000000000000000","StationName":"String","EmployeeId":"00000000000000000000000000000000","EmployeeName":"String","CustomerName":"String","ContactId":0,"ContactAgentId":0,"CustomerId":"00000000000000000000000000000000","IsAppointment":false,"LocalHere":"0001-01-01T00:00:00.0000000","LocalCalled":"0001-01-01T00:00:00.0000000","LocalStart":"0001-01-01T00:00:00.0000000","LocalEnd":"0001-01-01T00:00:00.0000000","WaitSec":0,"ServeSec":0,"Outcome":"String","Fee":0}],"TotalRows":0,"Page":0,"PageSize":0,"OutcomeCounts":{"String":0},"Services":[{"LineId":"00000000000000000000000000000000","Name":"String","N":0}],"CanSeeStaff":false,"CanSeeFinancial":false}}