Trendsic Platform Service

<back to all web services

KpiV2VisitsRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/kpiv2/visits
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class KpiV2VisitsRequest
    {
        public UUID BranchId = null;
        public Date FromDate = null;
        public Date ToDate = null;
        public UUID StationId = null;
        public UUID EmployeeId = null;
        public String Outcome = null;
        public UUID LineId = null;
        public Integer Page = null;
        public Integer PageSize = null;
        
        public UUID getBranchId() { return BranchId; }
        public KpiV2VisitsRequest setBranchId(UUID value) { this.BranchId = value; return this; }
        public Date getFromDate() { return FromDate; }
        public KpiV2VisitsRequest setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public KpiV2VisitsRequest setToDate(Date value) { this.ToDate = value; return this; }
        public UUID getStationId() { return StationId; }
        public KpiV2VisitsRequest setStationId(UUID value) { this.StationId = value; return this; }
        public UUID getEmployeeId() { return EmployeeId; }
        public KpiV2VisitsRequest setEmployeeId(UUID value) { this.EmployeeId = value; return this; }
        public String getOutcome() { return Outcome; }
        public KpiV2VisitsRequest setOutcome(String value) { this.Outcome = value; return this; }
        public UUID getLineId() { return LineId; }
        public KpiV2VisitsRequest setLineId(UUID value) { this.LineId = value; return this; }
        public Integer getPage() { return Page; }
        public KpiV2VisitsRequest setPage(Integer value) { this.Page = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public KpiV2VisitsRequest setPageSize(Integer value) { this.PageSize = value; return this; }
    }

    public static class KpiV2VisitsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public SvcVisitPage Visits = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public KpiV2VisitsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public SvcVisitPage getVisits() { return Visits; }
        public KpiV2VisitsResponse setVisits(SvcVisitPage value) { this.Visits = value; return this; }
    }

    public static class SvcVisitPage
    {
        public ArrayList<SvcVisitRow> Rows = new ArrayList<SvcVisitRow>();
        public Integer TotalRows = null;
        public Integer Page = null;
        public Integer PageSize = null;
        public HashMap<String,Integer> OutcomeCounts = new HashMap<String,Integer>();
        public ArrayList<SvcChip> Services = new ArrayList<SvcChip>();
        public Boolean CanSeeStaff = null;
        public Boolean CanSeeFinancial = null;
        
        public ArrayList<SvcVisitRow> getRows() { return Rows; }
        public SvcVisitPage setRows(ArrayList<SvcVisitRow> value) { this.Rows = value; return this; }
        public Integer getTotalRows() { return TotalRows; }
        public SvcVisitPage setTotalRows(Integer value) { this.TotalRows = value; return this; }
        public Integer getPage() { return Page; }
        public SvcVisitPage setPage(Integer value) { this.Page = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public SvcVisitPage setPageSize(Integer value) { this.PageSize = value; return this; }
        public HashMap<String,Integer> getOutcomeCounts() { return OutcomeCounts; }
        public SvcVisitPage setOutcomeCounts(HashMap<String,Integer> value) { this.OutcomeCounts = value; return this; }
        public ArrayList<SvcChip> getServices() { return Services; }
        public SvcVisitPage setServices(ArrayList<SvcChip> value) { this.Services = value; return this; }
        public Boolean isCanSeeStaff() { return CanSeeStaff; }
        public SvcVisitPage setCanSeeStaff(Boolean value) { this.CanSeeStaff = value; return this; }
        public Boolean isCanSeeFinancial() { return CanSeeFinancial; }
        public SvcVisitPage setCanSeeFinancial(Boolean value) { this.CanSeeFinancial = value; return this; }
    }

    public static class SvcVisitRow
    {
        public UUID CheckinId = null;
        public String TicketLabel = null;
        public Date LocalDate = null;
        public UUID LineId = null;
        public String ServiceName = null;
        public UUID StationId = null;
        public String StationName = null;
        public UUID EmployeeId = null;
        public String EmployeeName = null;
        public String CustomerName = null;
        public Integer ContactId = null;
        public Integer ContactAgentId = null;
        public UUID CustomerId = null;
        public Boolean IsAppointment = null;
        public Date LocalHere = null;
        public Date LocalCalled = null;
        public Date LocalStart = null;
        public Date LocalEnd = null;
        public Integer WaitSec = null;
        public Integer ServeSec = null;
        public String Outcome = null;
        public BigDecimal Fee = null;
        
        public UUID getCheckinId() { return CheckinId; }
        public SvcVisitRow setCheckinId(UUID value) { this.CheckinId = value; return this; }
        public String getTicketLabel() { return TicketLabel; }
        public SvcVisitRow setTicketLabel(String value) { this.TicketLabel = value; return this; }
        public Date getLocalDate() { return LocalDate; }
        public SvcVisitRow setLocalDate(Date value) { this.LocalDate = value; return this; }
        public UUID getLineId() { return LineId; }
        public SvcVisitRow setLineId(UUID value) { this.LineId = value; return this; }
        public String getServiceName() { return ServiceName; }
        public SvcVisitRow setServiceName(String value) { this.ServiceName = value; return this; }
        public UUID getStationId() { return StationId; }
        public SvcVisitRow setStationId(UUID value) { this.StationId = value; return this; }
        public String getStationName() { return StationName; }
        public SvcVisitRow setStationName(String value) { this.StationName = value; return this; }
        public UUID getEmployeeId() { return EmployeeId; }
        public SvcVisitRow setEmployeeId(UUID value) { this.EmployeeId = value; return this; }
        public String getEmployeeName() { return EmployeeName; }
        public SvcVisitRow setEmployeeName(String value) { this.EmployeeName = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public SvcVisitRow setCustomerName(String value) { this.CustomerName = value; return this; }
        public Integer getContactId() { return ContactId; }
        public SvcVisitRow setContactId(Integer value) { this.ContactId = value; return this; }
        public Integer getContactAgentId() { return ContactAgentId; }
        public SvcVisitRow setContactAgentId(Integer value) { this.ContactAgentId = value; return this; }
        public UUID getCustomerId() { return CustomerId; }
        public SvcVisitRow setCustomerId(UUID value) { this.CustomerId = value; return this; }
        public Boolean getIsAppointment() { return IsAppointment; }
        public SvcVisitRow setIsAppointment(Boolean value) { this.IsAppointment = value; return this; }
        public Date getLocalHere() { return LocalHere; }
        public SvcVisitRow setLocalHere(Date value) { this.LocalHere = value; return this; }
        public Date getLocalCalled() { return LocalCalled; }
        public SvcVisitRow setLocalCalled(Date value) { this.LocalCalled = value; return this; }
        public Date getLocalStart() { return LocalStart; }
        public SvcVisitRow setLocalStart(Date value) { this.LocalStart = value; return this; }
        public Date getLocalEnd() { return LocalEnd; }
        public SvcVisitRow setLocalEnd(Date value) { this.LocalEnd = value; return this; }
        public Integer getWaitSec() { return WaitSec; }
        public SvcVisitRow setWaitSec(Integer value) { this.WaitSec = value; return this; }
        public Integer getServeSec() { return ServeSec; }
        public SvcVisitRow setServeSec(Integer value) { this.ServeSec = value; return this; }
        public String getOutcome() { return Outcome; }
        public SvcVisitRow setOutcome(String value) { this.Outcome = value; return this; }
        public BigDecimal getFee() { return Fee; }
        public SvcVisitRow setFee(BigDecimal value) { this.Fee = value; return this; }
    }

    public static class SvcChip
    {
        public UUID LineId = null;
        public String Name = null;
        public Integer N = null;
        
        public UUID getLineId() { return LineId; }
        public SvcChip setLineId(UUID value) { this.LineId = value; return this; }
        public String getName() { return Name; }
        public SvcChip setName(String value) { this.Name = value; return this; }
        public Integer getN() { return N; }
        public SvcChip setN(Integer value) { this.N = value; return this; }
    }

}

Java KpiV2VisitsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dashboard/kpiv2/visits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"BranchId":"00000000000000000000000000000000","FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","StationId":"00000000000000000000000000000000","EmployeeId":"00000000000000000000000000000000","Outcome":"String","LineId":"00000000000000000000000000000000","Page":0,"PageSize":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Visits":{"Rows":[{"CheckinId":"00000000000000000000000000000000","TicketLabel":"String","LocalDate":"0001-01-01T00:00:00.0000000","LineId":"00000000000000000000000000000000","ServiceName":"String","StationId":"00000000000000000000000000000000","StationName":"String","EmployeeId":"00000000000000000000000000000000","EmployeeName":"String","CustomerName":"String","ContactId":0,"ContactAgentId":0,"CustomerId":"00000000000000000000000000000000","IsAppointment":false,"LocalHere":"0001-01-01T00:00:00.0000000","LocalCalled":"0001-01-01T00:00:00.0000000","LocalStart":"0001-01-01T00:00:00.0000000","LocalEnd":"0001-01-01T00:00:00.0000000","WaitSec":0,"ServeSec":0,"Outcome":"String","Fee":0}],"TotalRows":0,"Page":0,"PageSize":0,"OutcomeCounts":{"String":0},"Services":[{"LineId":"00000000000000000000000000000000","Name":"String","N":0}],"CanSeeStaff":false,"CanSeeFinancial":false}}