Trendsic Platform Service

KpiV2LiveRequest

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

**KpiV2LiveRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BranchId	path	Guid	No

**KpiV2LiveResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Live	form	SvcLive	No

**SvcLive** Parameters:
Name	Parameter	Data Type	Required
BranchId	form	Guid	No
NowUtc	form	DateTime	No
LocalOffMin	form	int	No
ZoneCode	form	string	No
Windows	form	List<SvcLiveWindow>	No
Line	form	List<SvcLiveLine>	No
InLine	form	int	No
LongestWaitSec	form	int	No
Staffed	form	int	No
Alerts	form	List<SvcAlert>	No

**SvcLiveWindow** Parameters:
Name	Parameter	Data Type	Required
StationId	form	Guid	No
Name	form	string	No
Status	form	string	No
EmployeeId	form	Guid?	No
EmployeeName	form	string	No
SignedInUtc	form	DateTime?	No
LastSeenUtc	form	DateTime?	No
SinceUtc	form	DateTime?	No
PauseReason	form	string	No
CheckinId	form	Guid?	No
TicketLabel	form	string	No
CustomerName	form	string	No
ServiceName	form	string	No
StartUtc	form	DateTime?	No
CalledUtc	form	DateTime?	No
ServedToday	form	int	No
LastCalledUtc	form	DateTime?	No

**SvcLiveLine** Parameters:
Name	Parameter	Data Type	Required
LineId	form	Guid	No
Name	form	string	No
Waiting	form	int	No
OldestHereUtc	form	DateTime?	No

**SvcAlert** Parameters:
Name	Parameter	Data Type	Required
Level	form	string	No
View	form	string	No
Code	form	string	No
StationId	form	Guid?	No
EmployeeId	form	Guid?	No
BranchId	form	Guid?	No
LineId	form	Guid?	No
Name	form	string	No
OtherLineId	form	Guid?	No
OtherName	form	string	No
StationIds	form	List<Guid>	No
Values	form	Dictionary<string, double>	No

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