Trendsic Platform Service

<back to all web services

BranchCalendarRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/queue/calendar/{LocationId}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class BranchCalendarRequest
    {
        public UUID LocationId = null;
        public Date From = null;
        public Date To = null;
        public Boolean IncludeCancelled = null;
        
        public UUID getLocationId() { return LocationId; }
        public BranchCalendarRequest setLocationId(UUID value) { this.LocationId = value; return this; }
        public Date getFrom() { return From; }
        public BranchCalendarRequest setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public BranchCalendarRequest setTo(Date value) { this.To = value; return this; }
        public Boolean isIncludeCancelled() { return IncludeCancelled; }
        public BranchCalendarRequest setIncludeCancelled(Boolean value) { this.IncludeCancelled = value; return this; }
    }

    public static class BranchCalendarResponse
    {
        public ResponseStatus ResponseStatus = null;
        public BranchCalendarBranch Branch = null;
        public ArrayList<BranchCalendarLine> Lines = new ArrayList<BranchCalendarLine>();
        public ArrayList<BranchCalendarEvent> Events = new ArrayList<BranchCalendarEvent>();
        public ArrayList<BranchCalendarStaffHour> Staffing = new ArrayList<BranchCalendarStaffHour>();
        public BranchCalendarHistory History = null;
        public Boolean ColorByService = null;
        public Date ServerNowLocal = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public BranchCalendarResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public BranchCalendarBranch getBranch() { return Branch; }
        public BranchCalendarResponse setBranch(BranchCalendarBranch value) { this.Branch = value; return this; }
        public ArrayList<BranchCalendarLine> getLines() { return Lines; }
        public BranchCalendarResponse setLines(ArrayList<BranchCalendarLine> value) { this.Lines = value; return this; }
        public ArrayList<BranchCalendarEvent> getEvents() { return Events; }
        public BranchCalendarResponse setEvents(ArrayList<BranchCalendarEvent> value) { this.Events = value; return this; }
        public ArrayList<BranchCalendarStaffHour> getStaffing() { return Staffing; }
        public BranchCalendarResponse setStaffing(ArrayList<BranchCalendarStaffHour> value) { this.Staffing = value; return this; }
        public BranchCalendarHistory getHistory() { return History; }
        public BranchCalendarResponse setHistory(BranchCalendarHistory value) { this.History = value; return this; }
        public Boolean isColorByService() { return ColorByService; }
        public BranchCalendarResponse setColorByService(Boolean value) { this.ColorByService = value; return this; }
        public Date getServerNowLocal() { return ServerNowLocal; }
        public BranchCalendarResponse setServerNowLocal(Date value) { this.ServerNowLocal = value; return this; }
    }

    public static class BranchCalendarBranch
    {
        public UUID Id = null;
        public String Name = null;
        public String Street = null;
        public String TimeZone = null;
        public Integer Windows = null;
        public ArrayList<BranchCalendarHours> Hours = new ArrayList<BranchCalendarHours>();
        
        public UUID getId() { return Id; }
        public BranchCalendarBranch setId(UUID value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public BranchCalendarBranch setName(String value) { this.Name = value; return this; }
        public String getStreet() { return Street; }
        public BranchCalendarBranch setStreet(String value) { this.Street = value; return this; }
        public String getTimeZone() { return TimeZone; }
        public BranchCalendarBranch setTimeZone(String value) { this.TimeZone = value; return this; }
        public Integer getWindows() { return Windows; }
        public BranchCalendarBranch setWindows(Integer value) { this.Windows = value; return this; }
        public ArrayList<BranchCalendarHours> getHours() { return Hours; }
        public BranchCalendarBranch setHours(ArrayList<BranchCalendarHours> value) { this.Hours = value; return this; }
    }

    public static class BranchCalendarHours
    {
        public String Date = null;
        public String Opens = null;
        public String Closes = null;
        public Boolean Closed = null;
        
        public String getDate() { return Date; }
        public BranchCalendarHours setDate(String value) { this.Date = value; return this; }
        public String getOpens() { return Opens; }
        public BranchCalendarHours setOpens(String value) { this.Opens = value; return this; }
        public String getCloses() { return Closes; }
        public BranchCalendarHours setCloses(String value) { this.Closes = value; return this; }
        public Boolean isClosed() { return Closed; }
        public BranchCalendarHours setClosed(Boolean value) { this.Closed = value; return this; }
    }

    public static class BranchCalendarLine
    {
        public UUID Id = null;
        public String Name = null;
        public Integer Minutes = null;
        public String Color = null;
        
        public UUID getId() { return Id; }
        public BranchCalendarLine setId(UUID value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public BranchCalendarLine setName(String value) { this.Name = value; return this; }
        public Integer getMinutes() { return Minutes; }
        public BranchCalendarLine setMinutes(Integer value) { this.Minutes = value; return this; }
        public String getColor() { return Color; }
        public BranchCalendarLine setColor(String value) { this.Color = value; return this; }
    }

    public static class BranchCalendarEvent
    {
        public Integer CalendarEventId = null;
        public String Kind = null;
        public String Title = null;
        public Date StartLocal = null;
        public Date EndLocal = null;
        public Boolean AllDay = null;
        public String Description = null;
        public BranchCalendarCustomer Customer = null;
        public ArrayList<BranchCalendarServiceItem> Services = new ArrayList<BranchCalendarServiceItem>();
        public BranchCalendarStatus Status = null;
        public UUID CheckInId = null;
        public BranchCalendarPaperwork Paperwork = null;
        
        public Integer getCalendarEventId() { return CalendarEventId; }
        public BranchCalendarEvent setCalendarEventId(Integer value) { this.CalendarEventId = value; return this; }
        public String getKind() { return Kind; }
        public BranchCalendarEvent setKind(String value) { this.Kind = value; return this; }
        public String getTitle() { return Title; }
        public BranchCalendarEvent setTitle(String value) { this.Title = value; return this; }
        public Date getStartLocal() { return StartLocal; }
        public BranchCalendarEvent setStartLocal(Date value) { this.StartLocal = value; return this; }
        public Date getEndLocal() { return EndLocal; }
        public BranchCalendarEvent setEndLocal(Date value) { this.EndLocal = value; return this; }
        public Boolean isAllDay() { return AllDay; }
        public BranchCalendarEvent setAllDay(Boolean value) { this.AllDay = value; return this; }
        public String getDescription() { return Description; }
        public BranchCalendarEvent setDescription(String value) { this.Description = value; return this; }
        public BranchCalendarCustomer getCustomer() { return Customer; }
        public BranchCalendarEvent setCustomer(BranchCalendarCustomer value) { this.Customer = value; return this; }
        public ArrayList<BranchCalendarServiceItem> getServices() { return Services; }
        public BranchCalendarEvent setServices(ArrayList<BranchCalendarServiceItem> value) { this.Services = value; return this; }
        public BranchCalendarStatus getStatus() { return Status; }
        public BranchCalendarEvent setStatus(BranchCalendarStatus value) { this.Status = value; return this; }
        public UUID getCheckInId() { return CheckInId; }
        public BranchCalendarEvent setCheckInId(UUID value) { this.CheckInId = value; return this; }
        public BranchCalendarPaperwork getPaperwork() { return Paperwork; }
        public BranchCalendarEvent setPaperwork(BranchCalendarPaperwork value) { this.Paperwork = value; return this; }
    }

    public static class BranchCalendarCustomer
    {
        public Integer ContactId = null;
        public UUID ContactGuid = null;
        public String Name = null;
        public String Phone = null;
        public String Email = null;
        
        public Integer getContactId() { return ContactId; }
        public BranchCalendarCustomer setContactId(Integer value) { this.ContactId = value; return this; }
        public UUID getContactGuid() { return ContactGuid; }
        public BranchCalendarCustomer setContactGuid(UUID value) { this.ContactGuid = value; return this; }
        public String getName() { return Name; }
        public BranchCalendarCustomer setName(String value) { this.Name = value; return this; }
        public String getPhone() { return Phone; }
        public BranchCalendarCustomer setPhone(String value) { this.Phone = value; return this; }
        public String getEmail() { return Email; }
        public BranchCalendarCustomer setEmail(String value) { this.Email = value; return this; }
    }

    public static class BranchCalendarServiceItem
    {
        public UUID LineId = null;
        public String Name = null;
        public Integer Minutes = null;
        
        public UUID getLineId() { return LineId; }
        public BranchCalendarServiceItem setLineId(UUID value) { this.LineId = value; return this; }
        public String getName() { return Name; }
        public BranchCalendarServiceItem setName(String value) { this.Name = value; return this; }
        public Integer getMinutes() { return Minutes; }
        public BranchCalendarServiceItem setMinutes(Integer value) { this.Minutes = value; return this; }
    }

    public static class BranchCalendarStatus
    {
        public String State = null;
        public String TicketLabel = null;
        public String Window = null;
        public Date ArrivedAt = null;
        public Date CalledAt = null;
        public Date ServedAt = null;
        public Date NoShowAt = null;
        public Date CancelledAt = null;
        public String CancelledBy = null;
        public String Source = null;
        public Boolean CanCheckIn = null;
        public Boolean CanNoShow = null;
        public Boolean CanReopen = null;
        public Boolean CanChange = null;
        public Boolean CanCancel = null;
        
        public String getState() { return State; }
        public BranchCalendarStatus setState(String value) { this.State = value; return this; }
        public String getTicketLabel() { return TicketLabel; }
        public BranchCalendarStatus setTicketLabel(String value) { this.TicketLabel = value; return this; }
        public String getWindow() { return Window; }
        public BranchCalendarStatus setWindow(String value) { this.Window = value; return this; }
        public Date getArrivedAt() { return ArrivedAt; }
        public BranchCalendarStatus setArrivedAt(Date value) { this.ArrivedAt = value; return this; }
        public Date getCalledAt() { return CalledAt; }
        public BranchCalendarStatus setCalledAt(Date value) { this.CalledAt = value; return this; }
        public Date getServedAt() { return ServedAt; }
        public BranchCalendarStatus setServedAt(Date value) { this.ServedAt = value; return this; }
        public Date getNoShowAt() { return NoShowAt; }
        public BranchCalendarStatus setNoShowAt(Date value) { this.NoShowAt = value; return this; }
        public Date getCancelledAt() { return CancelledAt; }
        public BranchCalendarStatus setCancelledAt(Date value) { this.CancelledAt = value; return this; }
        public String getCancelledBy() { return CancelledBy; }
        public BranchCalendarStatus setCancelledBy(String value) { this.CancelledBy = value; return this; }
        public String getSource() { return Source; }
        public BranchCalendarStatus setSource(String value) { this.Source = value; return this; }
        public Boolean isCanCheckIn() { return CanCheckIn; }
        public BranchCalendarStatus setCanCheckIn(Boolean value) { this.CanCheckIn = value; return this; }
        public Boolean isCanNoShow() { return CanNoShow; }
        public BranchCalendarStatus setCanNoShow(Boolean value) { this.CanNoShow = value; return this; }
        public Boolean isCanReopen() { return CanReopen; }
        public BranchCalendarStatus setCanReopen(Boolean value) { this.CanReopen = value; return this; }
        public Boolean isCanChange() { return CanChange; }
        public BranchCalendarStatus setCanChange(Boolean value) { this.CanChange = value; return this; }
        public Boolean isCanCancel() { return CanCancel; }
        public BranchCalendarStatus setCanCancel(Boolean value) { this.CanCancel = value; return this; }
    }

    public static class BranchCalendarPaperwork
    {
        public Boolean AsksQuestionnaire = null;
        public Boolean AsksUpload = null;
        public Boolean Submitted = null;
        
        public Boolean isAsksQuestionnaire() { return AsksQuestionnaire; }
        public BranchCalendarPaperwork setAsksQuestionnaire(Boolean value) { this.AsksQuestionnaire = value; return this; }
        public Boolean isAsksUpload() { return AsksUpload; }
        public BranchCalendarPaperwork setAsksUpload(Boolean value) { this.AsksUpload = value; return this; }
        public Boolean isSubmitted() { return Submitted; }
        public BranchCalendarPaperwork setSubmitted(Boolean value) { this.Submitted = value; return this; }
    }

    public static class BranchCalendarStaffHour
    {
        public String Date = null;
        public Integer Hour = null;
        public BigDecimal Windows = null;
        public String Source = null;
        
        public String getDate() { return Date; }
        public BranchCalendarStaffHour setDate(String value) { this.Date = value; return this; }
        public Integer getHour() { return Hour; }
        public BranchCalendarStaffHour setHour(Integer value) { this.Hour = value; return this; }
        public BigDecimal getWindows() { return Windows; }
        public BranchCalendarStaffHour setWindows(BigDecimal value) { this.Windows = value; return this; }
        public String getSource() { return Source; }
        public BranchCalendarStaffHour setSource(String value) { this.Source = value; return this; }
    }

    public static class BranchCalendarHistory
    {
        public ArrayList<BranchCalendarWeekdayHour> ByWeekdayHour = new ArrayList<BranchCalendarWeekdayHour>();
        public ArrayList<BranchCalendarHourMean> ByHour = new ArrayList<BranchCalendarHourMean>();
        
        public ArrayList<BranchCalendarWeekdayHour> getByWeekdayHour() { return ByWeekdayHour; }
        public BranchCalendarHistory setByWeekdayHour(ArrayList<BranchCalendarWeekdayHour> value) { this.ByWeekdayHour = value; return this; }
        public ArrayList<BranchCalendarHourMean> getByHour() { return ByHour; }
        public BranchCalendarHistory setByHour(ArrayList<BranchCalendarHourMean> value) { this.ByHour = value; return this; }
    }

    public static class BranchCalendarWeekdayHour
    {
        public Integer Weekday = null;
        public Integer Hour = null;
        public BigDecimal Windows = null;
        public Integer Days = null;
        
        public Integer getWeekday() { return Weekday; }
        public BranchCalendarWeekdayHour setWeekday(Integer value) { this.Weekday = value; return this; }
        public Integer getHour() { return Hour; }
        public BranchCalendarWeekdayHour setHour(Integer value) { this.Hour = value; return this; }
        public BigDecimal getWindows() { return Windows; }
        public BranchCalendarWeekdayHour setWindows(BigDecimal value) { this.Windows = value; return this; }
        public Integer getDays() { return Days; }
        public BranchCalendarWeekdayHour setDays(Integer value) { this.Days = value; return this; }
    }

    public static class BranchCalendarHourMean
    {
        public Integer Hour = null;
        public BigDecimal Windows = null;
        public Integer Days = null;
        
        public Integer getHour() { return Hour; }
        public BranchCalendarHourMean setHour(Integer value) { this.Hour = value; return this; }
        public BigDecimal getWindows() { return Windows; }
        public BranchCalendarHourMean setWindows(BigDecimal value) { this.Windows = value; return this; }
        public Integer getDays() { return Days; }
        public BranchCalendarHourMean setDays(Integer value) { this.Days = value; return this; }
    }

}

Java BranchCalendarRequest DTOs

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

HTTP + OTHER

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

GET /v1/queue/calendar/{LocationId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Branch":{"Id":"00000000000000000000000000000000","Name":"String","Street":"String","TimeZone":"String","Windows":0,"Hours":[{"Date":"String","Opens":"String","Closes":"String","Closed":false}]},"Lines":[{"Id":"00000000000000000000000000000000","Name":"String","Minutes":0,"Color":"String"}],"Events":[{"CalendarEventId":0,"Kind":"String","Title":"String","StartLocal":"0001-01-01T00:00:00.0000000","EndLocal":"0001-01-01T00:00:00.0000000","AllDay":false,"Description":"String","Customer":{"ContactId":0,"ContactGuid":"00000000000000000000000000000000","Name":"String","Phone":"String","Email":"String"},"Services":[{"LineId":"00000000000000000000000000000000","Name":"String","Minutes":0}],"Status":{"State":"String","TicketLabel":"String","Window":"String","ArrivedAt":"0001-01-01T00:00:00.0000000","CalledAt":"0001-01-01T00:00:00.0000000","ServedAt":"0001-01-01T00:00:00.0000000","NoShowAt":"0001-01-01T00:00:00.0000000","CancelledAt":"0001-01-01T00:00:00.0000000","CancelledBy":"String","Source":"String","CanCheckIn":false,"CanNoShow":false,"CanReopen":false,"CanChange":false,"CanCancel":false},"CheckInId":"00000000000000000000000000000000","Paperwork":{"AsksQuestionnaire":false,"AsksUpload":false,"Submitted":false}}],"Staffing":[{"Date":"String","Hour":0,"Windows":0,"Source":"String"}],"History":{"ByWeekdayHour":[{"Weekday":0,"Hour":0,"Windows":0,"Days":0}],"ByHour":[{"Hour":0,"Windows":0,"Days":0}]},"ColorByService":false,"ServerNowLocal":"0001-01-01T00:00:00.0000000"}