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}
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 KpiV2LiveRequest
            Public Overridable Property BranchId As Guid
        End Class

        Public Partial Class KpiV2LiveResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Live As SvcLive
        End Class

        Public Partial Class SvcAlert
            Public Overridable Property Level As String
            Public Overridable Property View As String
            Public Overridable Property Code As String
            Public Overridable Property StationId As Guid?
            Public Overridable Property EmployeeId As Guid?
            Public Overridable Property BranchId As Guid?
            Public Overridable Property LineId As Guid?
            Public Overridable Property Name As String
            Public Overridable Property OtherLineId As Guid?
            Public Overridable Property OtherName As String
            Public Overridable Property StationIds As List(Of Guid) = New List(Of Guid)
            Public Overridable Property Values As Dictionary(Of String, Double) = New Dictionary(Of String, Double)
        End Class

        Public Partial Class SvcLive
            Public Overridable Property BranchId As Guid
            Public Overridable Property NowUtc As Date
            Public Overridable Property LocalOffMin As Integer
            Public Overridable Property ZoneCode As String
            Public Overridable Property Windows As List(Of SvcLiveWindow) = New List(Of SvcLiveWindow)
            Public Overridable Property Line As List(Of SvcLiveLine) = New List(Of SvcLiveLine)
            Public Overridable Property InLine As Integer
            Public Overridable Property LongestWaitSec As Integer
            Public Overridable Property Staffed As Integer
            Public Overridable Property Alerts As List(Of SvcAlert) = New List(Of SvcAlert)
        End Class

        Public Partial Class SvcLiveLine
            Public Overridable Property LineId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Waiting As Integer
            Public Overridable Property OldestHereUtc As Date?
        End Class

        Public Partial Class SvcLiveWindow
            Public Overridable Property StationId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Status As String
            Public Overridable Property EmployeeId As Guid?
            Public Overridable Property EmployeeName As String
            Public Overridable Property SignedInUtc As Date?
            Public Overridable Property LastSeenUtc As Date?
            Public Overridable Property SinceUtc As Date?
            Public Overridable Property PauseReason As String
            Public Overridable Property CheckinId As Guid?
            Public Overridable Property TicketLabel As String
            Public Overridable Property CustomerName As String
            Public Overridable Property ServiceName As String
            Public Overridable Property StartUtc As Date?
            Public Overridable Property CalledUtc As Date?
            Public Overridable Property ServedToday As Integer
            Public Overridable Property LastCalledUtc As Date?
        End Class
    End Namespace
End Namespace

VB.NET KpiV2LiveRequest DTOs

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

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<KpiV2LiveResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Live>
    <Alerts>
      <SvcAlert>
        <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
        <Code>String</Code>
        <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
        <Level>String</Level>
        <LineId>00000000-0000-0000-0000-000000000000</LineId>
        <Name>String</Name>
        <OtherLineId>00000000-0000-0000-0000-000000000000</OtherLineId>
        <OtherName>String</OtherName>
        <StationId>00000000-0000-0000-0000-000000000000</StationId>
        <StationIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:guid>00000000-0000-0000-0000-000000000000</d5p1:guid>
        </StationIds>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringdouble>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:KeyValueOfstringdouble>
        </Values>
        <View>String</View>
      </SvcAlert>
    </Alerts>
    <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
    <InLine>0</InLine>
    <Line>
      <SvcLiveLine>
        <LineId>00000000-0000-0000-0000-000000000000</LineId>
        <Name>String</Name>
        <OldestHereUtc>0001-01-01T00:00:00</OldestHereUtc>
        <Waiting>0</Waiting>
      </SvcLiveLine>
    </Line>
    <LocalOffMin>0</LocalOffMin>
    <LongestWaitSec>0</LongestWaitSec>
    <NowUtc>0001-01-01T00:00:00</NowUtc>
    <Staffed>0</Staffed>
    <Windows>
      <SvcLiveWindow>
        <CalledUtc>0001-01-01T00:00:00</CalledUtc>
        <CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
        <CustomerName>String</CustomerName>
        <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
        <EmployeeName>String</EmployeeName>
        <LastCalledUtc>0001-01-01T00:00:00</LastCalledUtc>
        <LastSeenUtc>0001-01-01T00:00:00</LastSeenUtc>
        <Name>String</Name>
        <PauseReason>String</PauseReason>
        <ServedToday>0</ServedToday>
        <ServiceName>String</ServiceName>
        <SignedInUtc>0001-01-01T00:00:00</SignedInUtc>
        <SinceUtc>0001-01-01T00:00:00</SinceUtc>
        <StartUtc>0001-01-01T00:00:00</StartUtc>
        <StationId>00000000-0000-0000-0000-000000000000</StationId>
        <Status>String</Status>
        <TicketLabel>String</TicketLabel>
      </SvcLiveWindow>
    </Windows>
    <ZoneCode>String</ZoneCode>
  </Live>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</KpiV2LiveResponse>