Trendsic Platform Service

<back to all web services

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
import Foundation
import ServiceStack

public class ContactVisitSummaryRequest : Codable
{
    public var contactId:Int

    required public init(){}
}

public class ContactVisitsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var visits:[ContactQueueVisit] = []
    public var summary:ContactQueueVisitSummary

    required public init(){}
}

public class ContactQueueVisit : Codable
{
    public var checkinId:String
    public var branchId:String
    public var branchName:String
    public var lineId:String
    public var serviceName:String
    public var outcome:Int
    public var outcomeLabel:String
    public var isAppointment:Bool
    public var signInUtc:Date?
    public var calledUtc:Date?
    public var firstStartUtc:Date?
    public var completedTime:Date?
    public var waitMinutes:Int?
    public var serviceMinutes:Int?
    public var windowName:String
    public var ticketLabel:String
    public var holdReason:String
    public var returnedTime:Date?
    public var pausedMinutes:Int

    required public init(){}
}

public class ContactQueueVisitSummary : Codable
{
    public var visits:Int
    public var completed:Int
    public var noShows:Int
    public var noShows90d:Int
    public var cancelled:Int
    public var unfulfilled:Int
    public var appointments:Int
    public var lastVisitUtc:Date?
    public var lastNoShowUtc:Date?
    public var avgWaitMinutes:Double?
    public var smsOptIn:Bool
    public var textsSent90d:Int
    public var sayNameAs:String

    required public init(){}
}


Swift ContactVisitSummaryRequest 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.

GET /v1/contact/{ContactId}/visit-summary HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
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":[{"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"}}