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}
KpiV2LiveRequest Parameters:
NameParameterData TypeRequiredDescription
BranchIdpathGuidNo
KpiV2LiveResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
LiveformSvcLiveNo
SvcLive Parameters:
NameParameterData TypeRequiredDescription
BranchIdformGuidNo
NowUtcformDateTimeNo
LocalOffMinformintNo
ZoneCodeformstringNo
WindowsformList<SvcLiveWindow>No
LineformList<SvcLiveLine>No
InLineformintNo
LongestWaitSecformintNo
StaffedformintNo
AlertsformList<SvcAlert>No
SvcLiveWindow Parameters:
NameParameterData TypeRequiredDescription
StationIdformGuidNo
NameformstringNo
StatusformstringNo
EmployeeIdformGuid?No
EmployeeNameformstringNo
SignedInUtcformDateTime?No
LastSeenUtcformDateTime?No
SinceUtcformDateTime?No
PauseReasonformstringNo
CheckinIdformGuid?No
TicketLabelformstringNo
CustomerNameformstringNo
ServiceNameformstringNo
StartUtcformDateTime?No
CalledUtcformDateTime?No
ServedTodayformintNo
LastCalledUtcformDateTime?No
SvcLiveLine Parameters:
NameParameterData TypeRequiredDescription
LineIdformGuidNo
NameformstringNo
WaitingformintNo
OldestHereUtcformDateTime?No
SvcAlert Parameters:
NameParameterData TypeRequiredDescription
LevelformstringNo
ViewformstringNo
CodeformstringNo
StationIdformGuid?No
EmployeeIdformGuid?No
BranchIdformGuid?No
LineIdformGuid?No
NameformstringNo
OtherLineIdformGuid?No
OtherNameformstringNo
StationIdsformList<Guid>No
ValuesformDictionary<string, double>No

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/dashboard/kpiv2/live/{BranchId} 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"}},"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}}]}}