Trendsic Platform Service

KpiV2LiveRequest

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


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

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>