Trendsic Platform Service

<back to all web services

KpiV2LiveRequest

export class SvcLiveWindow
{
    public StationId: string;
    public Name: string;
    public Status: string;
    public EmployeeId?: string;
    public EmployeeName: string;
    public SignedInUtc?: string;
    public LastSeenUtc?: string;
    public SinceUtc?: string;
    public PauseReason: string;
    public CheckinId?: string;
    public TicketLabel: string;
    public CustomerName: string;
    public ServiceName: string;
    public StartUtc?: string;
    public CalledUtc?: string;
    public ServedToday: number;
    public LastCalledUtc?: string;

    public constructor(init?: Partial<SvcLiveWindow>) { (Object as any).assign(this, init); }
}

export class SvcLiveLine
{
    public LineId: string;
    public Name: string;
    public Waiting: number;
    public OldestHereUtc?: string;

    public constructor(init?: Partial<SvcLiveLine>) { (Object as any).assign(this, init); }
}

export class SvcAlert
{
    public Level: string;
    public View: string;
    public Code: string;
    public StationId?: string;
    public EmployeeId?: string;
    public BranchId?: string;
    public LineId?: string;
    public Name: string;
    public OtherLineId?: string;
    public OtherName: string;
    public StationIds: string[] = [];
    public Values: { [index:string]: number; } = {};

    public constructor(init?: Partial<SvcAlert>) { (Object as any).assign(this, init); }
}

export class SvcLive
{
    public BranchId: string;
    public NowUtc: string;
    public LocalOffMin: number;
    public ZoneCode: string;
    public Windows: SvcLiveWindow[] = [];
    public Line: SvcLiveLine[] = [];
    public InLine: number;
    public LongestWaitSec: number;
    public Staffed: number;
    public Alerts: SvcAlert[] = [];

    public constructor(init?: Partial<SvcLive>) { (Object as any).assign(this, init); }
}

export class KpiV2LiveResponse
{
    public ResponseStatus: ResponseStatus;
    public Live: SvcLive;

    public constructor(init?: Partial<KpiV2LiveResponse>) { (Object as any).assign(this, init); }
}

export class KpiV2LiveRequest
{
    public BranchId: string;

    public constructor(init?: Partial<KpiV2LiveRequest>) { (Object as any).assign(this, init); }
}

TypeScript KpiV2LiveRequest DTOs

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