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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

HTTP/1.1 200 OK
Content-Type: application/json
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}}]}}