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}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class KpiV2LiveRequest
    {
        public UUID BranchId = null;
        
        public UUID getBranchId() { return BranchId; }
        public KpiV2LiveRequest setBranchId(UUID value) { this.BranchId = value; return this; }
    }

    public static class KpiV2LiveResponse
    {
        public ResponseStatus ResponseStatus = null;
        public SvcLive Live = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public KpiV2LiveResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public SvcLive getLive() { return Live; }
        public KpiV2LiveResponse setLive(SvcLive value) { this.Live = value; return this; }
    }

    public static class SvcLive
    {
        public UUID BranchId = null;
        public Date NowUtc = null;
        public Integer LocalOffMin = null;
        public String ZoneCode = null;
        public ArrayList<SvcLiveWindow> Windows = new ArrayList<SvcLiveWindow>();
        public ArrayList<SvcLiveLine> Line = new ArrayList<SvcLiveLine>();
        public Integer InLine = null;
        public Integer LongestWaitSec = null;
        public Integer Staffed = null;
        public ArrayList<SvcAlert> Alerts = new ArrayList<SvcAlert>();
        
        public UUID getBranchId() { return BranchId; }
        public SvcLive setBranchId(UUID value) { this.BranchId = value; return this; }
        public Date getNowUtc() { return NowUtc; }
        public SvcLive setNowUtc(Date value) { this.NowUtc = value; return this; }
        public Integer getLocalOffMin() { return LocalOffMin; }
        public SvcLive setLocalOffMin(Integer value) { this.LocalOffMin = value; return this; }
        public String getZoneCode() { return ZoneCode; }
        public SvcLive setZoneCode(String value) { this.ZoneCode = value; return this; }
        public ArrayList<SvcLiveWindow> getWindows() { return Windows; }
        public SvcLive setWindows(ArrayList<SvcLiveWindow> value) { this.Windows = value; return this; }
        public ArrayList<SvcLiveLine> getLine() { return Line; }
        public SvcLive setLine(ArrayList<SvcLiveLine> value) { this.Line = value; return this; }
        public Integer getInLine() { return InLine; }
        public SvcLive setInLine(Integer value) { this.InLine = value; return this; }
        public Integer getLongestWaitSec() { return LongestWaitSec; }
        public SvcLive setLongestWaitSec(Integer value) { this.LongestWaitSec = value; return this; }
        public Integer getStaffed() { return Staffed; }
        public SvcLive setStaffed(Integer value) { this.Staffed = value; return this; }
        public ArrayList<SvcAlert> getAlerts() { return Alerts; }
        public SvcLive setAlerts(ArrayList<SvcAlert> value) { this.Alerts = value; return this; }
    }

    public static class SvcLiveWindow
    {
        public UUID StationId = null;
        public String Name = null;
        public String Status = null;
        public UUID EmployeeId = null;
        public String EmployeeName = null;
        public Date SignedInUtc = null;
        public Date LastSeenUtc = null;
        public Date SinceUtc = null;
        public String PauseReason = null;
        public UUID CheckinId = null;
        public String TicketLabel = null;
        public String CustomerName = null;
        public String ServiceName = null;
        public Date StartUtc = null;
        public Date CalledUtc = null;
        public Integer ServedToday = null;
        public Date LastCalledUtc = null;
        
        public UUID getStationId() { return StationId; }
        public SvcLiveWindow setStationId(UUID value) { this.StationId = value; return this; }
        public String getName() { return Name; }
        public SvcLiveWindow setName(String value) { this.Name = value; return this; }
        public String getStatus() { return Status; }
        public SvcLiveWindow setStatus(String value) { this.Status = value; return this; }
        public UUID getEmployeeId() { return EmployeeId; }
        public SvcLiveWindow setEmployeeId(UUID value) { this.EmployeeId = value; return this; }
        public String getEmployeeName() { return EmployeeName; }
        public SvcLiveWindow setEmployeeName(String value) { this.EmployeeName = value; return this; }
        public Date getSignedInUtc() { return SignedInUtc; }
        public SvcLiveWindow setSignedInUtc(Date value) { this.SignedInUtc = value; return this; }
        public Date getLastSeenUtc() { return LastSeenUtc; }
        public SvcLiveWindow setLastSeenUtc(Date value) { this.LastSeenUtc = value; return this; }
        public Date getSinceUtc() { return SinceUtc; }
        public SvcLiveWindow setSinceUtc(Date value) { this.SinceUtc = value; return this; }
        public String getPauseReason() { return PauseReason; }
        public SvcLiveWindow setPauseReason(String value) { this.PauseReason = value; return this; }
        public UUID getCheckinId() { return CheckinId; }
        public SvcLiveWindow setCheckinId(UUID value) { this.CheckinId = value; return this; }
        public String getTicketLabel() { return TicketLabel; }
        public SvcLiveWindow setTicketLabel(String value) { this.TicketLabel = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public SvcLiveWindow setCustomerName(String value) { this.CustomerName = value; return this; }
        public String getServiceName() { return ServiceName; }
        public SvcLiveWindow setServiceName(String value) { this.ServiceName = value; return this; }
        public Date getStartUtc() { return StartUtc; }
        public SvcLiveWindow setStartUtc(Date value) { this.StartUtc = value; return this; }
        public Date getCalledUtc() { return CalledUtc; }
        public SvcLiveWindow setCalledUtc(Date value) { this.CalledUtc = value; return this; }
        public Integer getServedToday() { return ServedToday; }
        public SvcLiveWindow setServedToday(Integer value) { this.ServedToday = value; return this; }
        public Date getLastCalledUtc() { return LastCalledUtc; }
        public SvcLiveWindow setLastCalledUtc(Date value) { this.LastCalledUtc = value; return this; }
    }

    public static class SvcLiveLine
    {
        public UUID LineId = null;
        public String Name = null;
        public Integer Waiting = null;
        public Date OldestHereUtc = null;
        
        public UUID getLineId() { return LineId; }
        public SvcLiveLine setLineId(UUID value) { this.LineId = value; return this; }
        public String getName() { return Name; }
        public SvcLiveLine setName(String value) { this.Name = value; return this; }
        public Integer getWaiting() { return Waiting; }
        public SvcLiveLine setWaiting(Integer value) { this.Waiting = value; return this; }
        public Date getOldestHereUtc() { return OldestHereUtc; }
        public SvcLiveLine setOldestHereUtc(Date value) { this.OldestHereUtc = value; return this; }
    }

    public static class SvcAlert
    {
        public String Level = null;
        public String View = null;
        public String Code = null;
        public UUID StationId = null;
        public UUID EmployeeId = null;
        public UUID BranchId = null;
        public UUID LineId = null;
        public String Name = null;
        public UUID OtherLineId = null;
        public String OtherName = null;
        public ArrayList<UUID> StationIds = new ArrayList<UUID>();
        public HashMap<String,Double> Values = new HashMap<String,Double>();
        
        public String getLevel() { return Level; }
        public SvcAlert setLevel(String value) { this.Level = value; return this; }
        public String getView() { return View; }
        public SvcAlert setView(String value) { this.View = value; return this; }
        public String getCode() { return Code; }
        public SvcAlert setCode(String value) { this.Code = value; return this; }
        public UUID getStationId() { return StationId; }
        public SvcAlert setStationId(UUID value) { this.StationId = value; return this; }
        public UUID getEmployeeId() { return EmployeeId; }
        public SvcAlert setEmployeeId(UUID value) { this.EmployeeId = value; return this; }
        public UUID getBranchId() { return BranchId; }
        public SvcAlert setBranchId(UUID value) { this.BranchId = value; return this; }
        public UUID getLineId() { return LineId; }
        public SvcAlert setLineId(UUID value) { this.LineId = value; return this; }
        public String getName() { return Name; }
        public SvcAlert setName(String value) { this.Name = value; return this; }
        public UUID getOtherLineId() { return OtherLineId; }
        public SvcAlert setOtherLineId(UUID value) { this.OtherLineId = value; return this; }
        public String getOtherName() { return OtherName; }
        public SvcAlert setOtherName(String value) { this.OtherName = value; return this; }
        public ArrayList<UUID> getStationIds() { return StationIds; }
        public SvcAlert setStationIds(ArrayList<UUID> value) { this.StationIds = value; return this; }
        public HashMap<String,Double> getValues() { return Values; }
        public SvcAlert setValues(HashMap<String,Double> value) { this.Values = value; return this; }
    }

}

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