Trendsic Platform Service

<back to all web services

KpiV2LiveRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dashboard/kpiv2/live/{BranchId}
import Foundation
import ServiceStack

public class KpiV2LiveRequest : Codable
{
    public var branchId:String

    required public init(){}
}

public class KpiV2LiveResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var live:SvcLive

    required public init(){}
}

public class SvcLive : Codable
{
    public var branchId:String
    public var nowUtc:Date
    public var localOffMin:Int
    public var zoneCode:String
    public var windows:[SvcLiveWindow] = []
    public var line:[SvcLiveLine] = []
    public var inLine:Int
    public var longestWaitSec:Int
    public var staffed:Int
    public var alerts:[SvcAlert] = []

    required public init(){}
}

public class SvcLiveWindow : Codable
{
    public var stationId:String
    public var name:String
    public var status:String
    public var employeeId:String?
    public var employeeName:String
    public var signedInUtc:Date?
    public var lastSeenUtc:Date?
    public var sinceUtc:Date?
    public var pauseReason:String
    public var checkinId:String?
    public var ticketLabel:String
    public var customerName:String
    public var serviceName:String
    public var startUtc:Date?
    public var calledUtc:Date?
    public var servedToday:Int
    public var lastCalledUtc:Date?

    required public init(){}
}

public class SvcLiveLine : Codable
{
    public var lineId:String
    public var name:String
    public var waiting:Int
    public var oldestHereUtc:Date?

    required public init(){}
}

public class SvcAlert : Codable
{
    public var level:String
    public var view:String
    public var code:String
    public var stationId:String?
    public var employeeId:String?
    public var branchId:String?
    public var lineId:String?
    public var name:String
    public var otherLineId:String?
    public var otherName:String
    public var stationIds:[String] = []
    public var values:[String:Double] = [:]

    required public init(){}
}


Swift KpiV2LiveRequest 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/dashboard/kpiv2/live/{BranchId} 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"}},"Live":{"BranchId":"00000000000000000000000000000000","NowUtc":"0001-01-01T00:00:00.0000000","LocalOffMin":0,"ZoneCode":"String","Windows":[{"StationId":"00000000000000000000000000000000","Name":"String","Status":"String","EmployeeId":"00000000000000000000000000000000","EmployeeName":"String","SignedInUtc":"0001-01-01T00:00:00.0000000","LastSeenUtc":"0001-01-01T00:00:00.0000000","SinceUtc":"0001-01-01T00:00:00.0000000","PauseReason":"String","CheckinId":"00000000000000000000000000000000","TicketLabel":"String","CustomerName":"String","ServiceName":"String","StartUtc":"0001-01-01T00:00:00.0000000","CalledUtc":"0001-01-01T00:00:00.0000000","ServedToday":0,"LastCalledUtc":"0001-01-01T00:00:00.0000000"}],"Line":[{"LineId":"00000000000000000000000000000000","Name":"String","Waiting":0,"OldestHereUtc":"0001-01-01T00:00:00.0000000"}],"InLine":0,"LongestWaitSec":0,"Staffed":0,"Alerts":[{"Level":"String","View":"String","Code":"String","StationId":"00000000000000000000000000000000","EmployeeId":"00000000000000000000000000000000","BranchId":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","Name":"String","OtherLineId":"00000000000000000000000000000000","OtherName":"String","StationIds":["00000000000000000000000000000000"],"Values":{"String":0}}]}}