Trendsic Platform Service

KpiV2LiveRequest

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<KpiV2LiveResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Live>
    <Alerts>
      <SvcAlert>
        <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
        <Code>String</Code>
        <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
        <Level>String</Level>
        <LineId>00000000-0000-0000-0000-000000000000</LineId>
        <Name>String</Name>
        <OtherLineId>00000000-0000-0000-0000-000000000000</OtherLineId>
        <OtherName>String</OtherName>
        <StationId>00000000-0000-0000-0000-000000000000</StationId>
        <StationIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:guid>00000000-0000-0000-0000-000000000000</d5p1:guid>
        </StationIds>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringdouble>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:KeyValueOfstringdouble>
        </Values>
        <View>String</View>
      </SvcAlert>
    </Alerts>
    <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
    <InLine>0</InLine>
    <Line>
      <SvcLiveLine>
        <LineId>00000000-0000-0000-0000-000000000000</LineId>
        <Name>String</Name>
        <OldestHereUtc>0001-01-01T00:00:00</OldestHereUtc>
        <Waiting>0</Waiting>
      </SvcLiveLine>
    </Line>
    <LocalOffMin>0</LocalOffMin>
    <LongestWaitSec>0</LongestWaitSec>
    <NowUtc>0001-01-01T00:00:00</NowUtc>
    <Staffed>0</Staffed>
    <Windows>
      <SvcLiveWindow>
        <CalledUtc>0001-01-01T00:00:00</CalledUtc>
        <CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
        <CustomerName>String</CustomerName>
        <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
        <EmployeeName>String</EmployeeName>
        <LastCalledUtc>0001-01-01T00:00:00</LastCalledUtc>
        <LastSeenUtc>0001-01-01T00:00:00</LastSeenUtc>
        <Name>String</Name>
        <PauseReason>String</PauseReason>
        <ServedToday>0</ServedToday>
        <ServiceName>String</ServiceName>
        <SignedInUtc>0001-01-01T00:00:00</SignedInUtc>
        <SinceUtc>0001-01-01T00:00:00</SinceUtc>
        <StartUtc>0001-01-01T00:00:00</StartUtc>
        <StationId>00000000-0000-0000-0000-000000000000</StationId>
        <Status>String</Status>
        <TicketLabel>String</TicketLabel>
      </SvcLiveWindow>
    </Windows>
    <ZoneCode>String</ZoneCode>
  </Live>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</KpiV2LiveResponse>