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}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class KpiV2LiveRequest
    {
        public UUID BranchId = null;
        
        public UUID getBranchId() { return BranchId; }
        public KpiV2LiveRequest setBranchId(UUID value) { this.BranchId = value; return this; }
    }

    public static class KpiV2LiveResponse
    {
        public ResponseStatus ResponseStatus = null;
        public SvcLive Live = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public KpiV2LiveResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public SvcLive getLive() { return Live; }
        public KpiV2LiveResponse setLive(SvcLive value) { this.Live = value; return this; }
    }

    public static class SvcLive
    {
        public UUID BranchId = null;
        public Date NowUtc = null;
        public Integer LocalOffMin = null;
        public String ZoneCode = null;
        public ArrayList<SvcLiveWindow> Windows = new ArrayList<SvcLiveWindow>();
        public ArrayList<SvcLiveLine> Line = new ArrayList<SvcLiveLine>();
        public Integer InLine = null;
        public Integer LongestWaitSec = null;
        public Integer Staffed = null;
        public ArrayList<SvcAlert> Alerts = new ArrayList<SvcAlert>();
        
        public UUID getBranchId() { return BranchId; }
        public SvcLive setBranchId(UUID value) { this.BranchId = value; return this; }
        public Date getNowUtc() { return NowUtc; }
        public SvcLive setNowUtc(Date value) { this.NowUtc = value; return this; }
        public Integer getLocalOffMin() { return LocalOffMin; }
        public SvcLive setLocalOffMin(Integer value) { this.LocalOffMin = value; return this; }
        public String getZoneCode() { return ZoneCode; }
        public SvcLive setZoneCode(String value) { this.ZoneCode = value; return this; }
        public ArrayList<SvcLiveWindow> getWindows() { return Windows; }
        public SvcLive setWindows(ArrayList<SvcLiveWindow> value) { this.Windows = value; return this; }
        public ArrayList<SvcLiveLine> getLine() { return Line; }
        public SvcLive setLine(ArrayList<SvcLiveLine> value) { this.Line = value; return this; }
        public Integer getInLine() { return InLine; }
        public SvcLive setInLine(Integer value) { this.InLine = value; return this; }
        public Integer getLongestWaitSec() { return LongestWaitSec; }
        public SvcLive setLongestWaitSec(Integer value) { this.LongestWaitSec = value; return this; }
        public Integer getStaffed() { return Staffed; }
        public SvcLive setStaffed(Integer value) { this.Staffed = value; return this; }
        public ArrayList<SvcAlert> getAlerts() { return Alerts; }
        public SvcLive setAlerts(ArrayList<SvcAlert> value) { this.Alerts = value; return this; }
    }

    public static class SvcLiveWindow
    {
        public UUID StationId = null;
        public String Name = null;
        public String Status = null;
        public UUID EmployeeId = null;
        public String EmployeeName = null;
        public Date SignedInUtc = null;
        public Date LastSeenUtc = null;
        public Date SinceUtc = null;
        public String PauseReason = null;
        public UUID CheckinId = null;
        public String TicketLabel = null;
        public String CustomerName = null;
        public String ServiceName = null;
        public Date StartUtc = null;
        public Date CalledUtc = null;
        public Integer ServedToday = null;
        public Date LastCalledUtc = null;
        
        public UUID getStationId() { return StationId; }
        public SvcLiveWindow setStationId(UUID value) { this.StationId = value; return this; }
        public String getName() { return Name; }
        public SvcLiveWindow setName(String value) { this.Name = value; return this; }
        public String getStatus() { return Status; }
        public SvcLiveWindow setStatus(String value) { this.Status = value; return this; }
        public UUID getEmployeeId() { return EmployeeId; }
        public SvcLiveWindow setEmployeeId(UUID value) { this.EmployeeId = value; return this; }
        public String getEmployeeName() { return EmployeeName; }
        public SvcLiveWindow setEmployeeName(String value) { this.EmployeeName = value; return this; }
        public Date getSignedInUtc() { return SignedInUtc; }
        public SvcLiveWindow setSignedInUtc(Date value) { this.SignedInUtc = value; return this; }
        public Date getLastSeenUtc() { return LastSeenUtc; }
        public SvcLiveWindow setLastSeenUtc(Date value) { this.LastSeenUtc = value; return this; }
        public Date getSinceUtc() { return SinceUtc; }
        public SvcLiveWindow setSinceUtc(Date value) { this.SinceUtc = value; return this; }
        public String getPauseReason() { return PauseReason; }
        public SvcLiveWindow setPauseReason(String value) { this.PauseReason = value; return this; }
        public UUID getCheckinId() { return CheckinId; }
        public SvcLiveWindow setCheckinId(UUID value) { this.CheckinId = value; return this; }
        public String getTicketLabel() { return TicketLabel; }
        public SvcLiveWindow setTicketLabel(String value) { this.TicketLabel = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public SvcLiveWindow setCustomerName(String value) { this.CustomerName = value; return this; }
        public String getServiceName() { return ServiceName; }
        public SvcLiveWindow setServiceName(String value) { this.ServiceName = value; return this; }
        public Date getStartUtc() { return StartUtc; }
        public SvcLiveWindow setStartUtc(Date value) { this.StartUtc = value; return this; }
        public Date getCalledUtc() { return CalledUtc; }
        public SvcLiveWindow setCalledUtc(Date value) { this.CalledUtc = value; return this; }
        public Integer getServedToday() { return ServedToday; }
        public SvcLiveWindow setServedToday(Integer value) { this.ServedToday = value; return this; }
        public Date getLastCalledUtc() { return LastCalledUtc; }
        public SvcLiveWindow setLastCalledUtc(Date value) { this.LastCalledUtc = value; return this; }
    }

    public static class SvcLiveLine
    {
        public UUID LineId = null;
        public String Name = null;
        public Integer Waiting = null;
        public Date OldestHereUtc = null;
        
        public UUID getLineId() { return LineId; }
        public SvcLiveLine setLineId(UUID value) { this.LineId = value; return this; }
        public String getName() { return Name; }
        public SvcLiveLine setName(String value) { this.Name = value; return this; }
        public Integer getWaiting() { return Waiting; }
        public SvcLiveLine setWaiting(Integer value) { this.Waiting = value; return this; }
        public Date getOldestHereUtc() { return OldestHereUtc; }
        public SvcLiveLine setOldestHereUtc(Date value) { this.OldestHereUtc = value; return this; }
    }

    public static class SvcAlert
    {
        public String Level = null;
        public String View = null;
        public String Code = null;
        public UUID StationId = null;
        public UUID EmployeeId = null;
        public UUID BranchId = null;
        public UUID LineId = null;
        public String Name = null;
        public UUID OtherLineId = null;
        public String OtherName = null;
        public ArrayList<UUID> StationIds = new ArrayList<UUID>();
        public HashMap<String,Double> Values = new HashMap<String,Double>();
        
        public String getLevel() { return Level; }
        public SvcAlert setLevel(String value) { this.Level = value; return this; }
        public String getView() { return View; }
        public SvcAlert setView(String value) { this.View = value; return this; }
        public String getCode() { return Code; }
        public SvcAlert setCode(String value) { this.Code = value; return this; }
        public UUID getStationId() { return StationId; }
        public SvcAlert setStationId(UUID value) { this.StationId = value; return this; }
        public UUID getEmployeeId() { return EmployeeId; }
        public SvcAlert setEmployeeId(UUID value) { this.EmployeeId = value; return this; }
        public UUID getBranchId() { return BranchId; }
        public SvcAlert setBranchId(UUID value) { this.BranchId = value; return this; }
        public UUID getLineId() { return LineId; }
        public SvcAlert setLineId(UUID value) { this.LineId = value; return this; }
        public String getName() { return Name; }
        public SvcAlert setName(String value) { this.Name = value; return this; }
        public UUID getOtherLineId() { return OtherLineId; }
        public SvcAlert setOtherLineId(UUID value) { this.OtherLineId = value; return this; }
        public String getOtherName() { return OtherName; }
        public SvcAlert setOtherName(String value) { this.OtherName = value; return this; }
        public ArrayList<UUID> getStationIds() { return StationIds; }
        public SvcAlert setStationIds(ArrayList<UUID> value) { this.StationIds = value; return this; }
        public HashMap<String,Double> getValues() { return Values; }
        public SvcAlert setValues(HashMap<String,Double> value) { this.Values = value; return this; }
    }

}

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