Trendsic Platform Service

KpiV2LiveRequest

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class KpiV2LiveRequest
{
    open var BranchId:UUID? = null
}

open class KpiV2LiveResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Live:SvcLive? = null
}

open class SvcLive
{
    open var BranchId:UUID? = null
    open var NowUtc:Date? = null
    open var LocalOffMin:Int? = null
    open var ZoneCode:String? = null
    open var Windows:ArrayList<SvcLiveWindow> = ArrayList<SvcLiveWindow>()
    open var Line:ArrayList<SvcLiveLine> = ArrayList<SvcLiveLine>()
    open var InLine:Int? = null
    open var LongestWaitSec:Int? = null
    open var Staffed:Int? = null
    open var Alerts:ArrayList<SvcAlert> = ArrayList<SvcAlert>()
}

open class SvcLiveWindow
{
    open var StationId:UUID? = null
    open var Name:String? = null
    open var Status:String? = null
    open var EmployeeId:UUID? = null
    open var EmployeeName:String? = null
    open var SignedInUtc:Date? = null
    open var LastSeenUtc:Date? = null
    open var SinceUtc:Date? = null
    open var PauseReason:String? = null
    open var CheckinId:UUID? = null
    open var TicketLabel:String? = null
    open var CustomerName:String? = null
    open var ServiceName:String? = null
    open var StartUtc:Date? = null
    open var CalledUtc:Date? = null
    open var ServedToday:Int? = null
    open var LastCalledUtc:Date? = null
}

open class SvcLiveLine
{
    open var LineId:UUID? = null
    open var Name:String? = null
    open var Waiting:Int? = null
    open var OldestHereUtc:Date? = null
}

open class SvcAlert
{
    open var Level:String? = null
    open var View:String? = null
    open var Code:String? = null
    open var StationId:UUID? = null
    open var EmployeeId:UUID? = null
    open var BranchId:UUID? = null
    open var LineId:UUID? = null
    open var Name:String? = null
    open var OtherLineId:UUID? = null
    open var OtherName:String? = null
    open var StationIds:ArrayList<UUID> = ArrayList<UUID>()
    open var Values:HashMap<String,Double> = HashMap<String,Double>()
}

Kotlin 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
				}
			}
		]
	}
}