Trendsic Platform Service

KpiV2LiveRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcLiveWindow:
    station_id: Optional[str] = None
    name: Optional[str] = None
    status: Optional[str] = None
    employee_id: Optional[str] = None
    employee_name: Optional[str] = None
    signed_in_utc: Optional[datetime.datetime] = None
    last_seen_utc: Optional[datetime.datetime] = None
    since_utc: Optional[datetime.datetime] = None
    pause_reason: Optional[str] = None
    checkin_id: Optional[str] = None
    ticket_label: Optional[str] = None
    customer_name: Optional[str] = None
    service_name: Optional[str] = None
    start_utc: Optional[datetime.datetime] = None
    called_utc: Optional[datetime.datetime] = None
    served_today: int = 0
    last_called_utc: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcLiveLine:
    line_id: Optional[str] = None
    name: Optional[str] = None
    waiting: int = 0
    oldest_here_utc: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcAlert:
    level: Optional[str] = None
    view: Optional[str] = None
    code: Optional[str] = None
    station_id: Optional[str] = None
    employee_id: Optional[str] = None
    branch_id: Optional[str] = None
    line_id: Optional[str] = None
    name: Optional[str] = None
    other_line_id: Optional[str] = None
    other_name: Optional[str] = None
    station_ids: List[str] = field(default_factory=list)
    values: Dict[str, float] = field(default_factory=dict)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcLive:
    branch_id: Optional[str] = None
    now_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    local_off_min: int = 0
    zone_code: Optional[str] = None
    windows: List[SvcLiveWindow] = field(default_factory=list)
    line: List[SvcLiveLine] = field(default_factory=list)
    in_line: int = 0
    longest_wait_sec: int = 0
    staffed: int = 0
    alerts: List[SvcAlert] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiV2LiveResponse:
    response_status: Optional[ResponseStatus] = None
    live: Optional[SvcLive] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiV2LiveRequest:
    branch_id: Optional[str] = None

Python 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>