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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SvcLiveWindow() = 
        member val StationId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Status:String = null with get,set
        member val EmployeeId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val EmployeeName:String = null with get,set
        member val SignedInUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LastSeenUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PauseReason:String = null with get,set
        member val CheckinId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val TicketLabel:String = null with get,set
        member val CustomerName:String = null with get,set
        member val ServiceName:String = null with get,set
        member val StartUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CalledUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ServedToday:Int32 = new Int32() with get,set
        member val LastCalledUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type SvcLiveLine() = 
        member val LineId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Waiting:Int32 = new Int32() with get,set
        member val OldestHereUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type SvcAlert() = 
        member val Level:String = null with get,set
        member val View:String = null with get,set
        member val Code:String = null with get,set
        member val StationId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val EmployeeId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val LineId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Name:String = null with get,set
        member val OtherLineId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val OtherName:String = null with get,set
        member val StationIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
        member val Values:Dictionary<String, Double> = new Dictionary<String, Double>() with get,set

    [<AllowNullLiteral>]
    type SvcLive() = 
        member val BranchId:Guid = new Guid() with get,set
        member val NowUtc:DateTime = new DateTime() with get,set
        member val LocalOffMin:Int32 = new Int32() with get,set
        member val ZoneCode:String = null with get,set
        member val Windows:ResizeArray<SvcLiveWindow> = new ResizeArray<SvcLiveWindow>() with get,set
        member val Line:ResizeArray<SvcLiveLine> = new ResizeArray<SvcLiveLine>() with get,set
        member val InLine:Int32 = new Int32() with get,set
        member val LongestWaitSec:Int32 = new Int32() with get,set
        member val Staffed:Int32 = new Int32() with get,set
        member val Alerts:ResizeArray<SvcAlert> = new ResizeArray<SvcAlert>() with get,set

    [<AllowNullLiteral>]
    type KpiV2LiveResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Live:SvcLive = null with get,set

    [<AllowNullLiteral>]
    type KpiV2LiveRequest() = 
        member val BranchId:Guid = new Guid() with get,set

F# 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
				}
			}
		]
	}
}