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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class KpiV2LiveRequest
    {
        public virtual Guid BranchId { get; set; }
    }

    public partial class KpiV2LiveResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual SvcLive Live { get; set; }
    }

    public partial class SvcAlert
    {
        public virtual string Level { get; set; }
        public virtual string View { get; set; }
        public virtual string Code { get; set; }
        public virtual Guid? StationId { get; set; }
        public virtual Guid? EmployeeId { get; set; }
        public virtual Guid? BranchId { get; set; }
        public virtual Guid? LineId { get; set; }
        public virtual string Name { get; set; }
        public virtual Guid? OtherLineId { get; set; }
        public virtual string OtherName { get; set; }
        public virtual List<Guid> StationIds { get; set; } = [];
        public virtual Dictionary<string, double> Values { get; set; } = new();
    }

    public partial class SvcLive
    {
        public virtual Guid BranchId { get; set; }
        public virtual DateTime NowUtc { get; set; }
        public virtual int LocalOffMin { get; set; }
        public virtual string ZoneCode { get; set; }
        public virtual List<SvcLiveWindow> Windows { get; set; } = [];
        public virtual List<SvcLiveLine> Line { get; set; } = [];
        public virtual int InLine { get; set; }
        public virtual int LongestWaitSec { get; set; }
        public virtual int Staffed { get; set; }
        public virtual List<SvcAlert> Alerts { get; set; } = [];
    }

    public partial class SvcLiveLine
    {
        public virtual Guid LineId { get; set; }
        public virtual string Name { get; set; }
        public virtual int Waiting { get; set; }
        public virtual DateTime? OldestHereUtc { get; set; }
    }

    public partial class SvcLiveWindow
    {
        public virtual Guid StationId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Status { get; set; }
        public virtual Guid? EmployeeId { get; set; }
        public virtual string EmployeeName { get; set; }
        public virtual DateTime? SignedInUtc { get; set; }
        public virtual DateTime? LastSeenUtc { get; set; }
        public virtual DateTime? SinceUtc { get; set; }
        public virtual string PauseReason { get; set; }
        public virtual Guid? CheckinId { get; set; }
        public virtual string TicketLabel { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string ServiceName { get; set; }
        public virtual DateTime? StartUtc { get; set; }
        public virtual DateTime? CalledUtc { get; set; }
        public virtual int ServedToday { get; set; }
        public virtual DateTime? LastCalledUtc { get; set; }
    }

}

C# KpiV2LiveRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
		LocalOffMin: 0,
		ZoneCode: String,
		Windows: 
		[
			{
				StationId: 00000000000000000000000000000000,
				Name: String,
				Status: String,
				EmployeeId: 00000000000000000000000000000000,
				EmployeeName: String,
				SignedInUtc: 0001-01-01,
				LastSeenUtc: 0001-01-01,
				SinceUtc: 0001-01-01,
				PauseReason: String,
				CheckinId: 00000000000000000000000000000000,
				TicketLabel: String,
				CustomerName: String,
				ServiceName: String,
				StartUtc: 0001-01-01,
				CalledUtc: 0001-01-01,
				ServedToday: 0,
				LastCalledUtc: 0001-01-01
			}
		],
		Line: 
		[
			{
				LineId: 00000000000000000000000000000000,
				Name: String,
				Waiting: 0,
				OldestHereUtc: 0001-01-01
			}
		],
		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
				}
			}
		]
	}
}