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}
"use strict";
export class SvcLiveWindow {
    /** @param {{StationId?:string,Name?:string,Status?:string,EmployeeId?:string,EmployeeName?:string,SignedInUtc?:string,LastSeenUtc?:string,SinceUtc?:string,PauseReason?:string,CheckinId?:string,TicketLabel?:string,CustomerName?:string,ServiceName?:string,StartUtc?:string,CalledUtc?:string,ServedToday?:number,LastCalledUtc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StationId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Status;
    /** @type {?string} */
    EmployeeId;
    /** @type {string} */
    EmployeeName;
    /** @type {?string} */
    SignedInUtc;
    /** @type {?string} */
    LastSeenUtc;
    /** @type {?string} */
    SinceUtc;
    /** @type {string} */
    PauseReason;
    /** @type {?string} */
    CheckinId;
    /** @type {string} */
    TicketLabel;
    /** @type {string} */
    CustomerName;
    /** @type {string} */
    ServiceName;
    /** @type {?string} */
    StartUtc;
    /** @type {?string} */
    CalledUtc;
    /** @type {number} */
    ServedToday;
    /** @type {?string} */
    LastCalledUtc;
}
export class SvcLiveLine {
    /** @param {{LineId?:string,Name?:string,Waiting?:number,OldestHereUtc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LineId;
    /** @type {string} */
    Name;
    /** @type {number} */
    Waiting;
    /** @type {?string} */
    OldestHereUtc;
}
export class SvcAlert {
    /** @param {{Level?:string,View?:string,Code?:string,StationId?:string,EmployeeId?:string,BranchId?:string,LineId?:string,Name?:string,OtherLineId?:string,OtherName?:string,StationIds?:string[],Values?:{ [index:string]: number; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Level;
    /** @type {string} */
    View;
    /** @type {string} */
    Code;
    /** @type {?string} */
    StationId;
    /** @type {?string} */
    EmployeeId;
    /** @type {?string} */
    BranchId;
    /** @type {?string} */
    LineId;
    /** @type {string} */
    Name;
    /** @type {?string} */
    OtherLineId;
    /** @type {string} */
    OtherName;
    /** @type {string[]} */
    StationIds = [];
    /** @type {{ [index:string]: number; }} */
    Values = {};
}
export class SvcLive {
    /** @param {{BranchId?:string,NowUtc?:string,LocalOffMin?:number,ZoneCode?:string,Windows?:SvcLiveWindow[],Line?:SvcLiveLine[],InLine?:number,LongestWaitSec?:number,Staffed?:number,Alerts?:SvcAlert[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    BranchId;
    /** @type {string} */
    NowUtc;
    /** @type {number} */
    LocalOffMin;
    /** @type {string} */
    ZoneCode;
    /** @type {SvcLiveWindow[]} */
    Windows = [];
    /** @type {SvcLiveLine[]} */
    Line = [];
    /** @type {number} */
    InLine;
    /** @type {number} */
    LongestWaitSec;
    /** @type {number} */
    Staffed;
    /** @type {SvcAlert[]} */
    Alerts = [];
}
export class KpiV2LiveResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Live?:SvcLive}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SvcLive} */
    Live;
}
export class KpiV2LiveRequest {
    /** @param {{BranchId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    BranchId;
}

JavaScript KpiV2LiveRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","LocalOffMin":0,"ZoneCode":"String","Windows":[{"StationId":"00000000000000000000000000000000","Name":"String","Status":"String","EmployeeId":"00000000000000000000000000000000","EmployeeName":"String","SignedInUtc":"0001-01-01T00:00:00.0000000","LastSeenUtc":"0001-01-01T00:00:00.0000000","SinceUtc":"0001-01-01T00:00:00.0000000","PauseReason":"String","CheckinId":"00000000000000000000000000000000","TicketLabel":"String","CustomerName":"String","ServiceName":"String","StartUtc":"0001-01-01T00:00:00.0000000","CalledUtc":"0001-01-01T00:00:00.0000000","ServedToday":0,"LastCalledUtc":"0001-01-01T00:00:00.0000000"}],"Line":[{"LineId":"00000000000000000000000000000000","Name":"String","Waiting":0,"OldestHereUtc":"0001-01-01T00:00:00.0000000"}],"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}}]}}