Trendsic Platform Service

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.*


open class BranchCalendarRequest
{
    open var LocationId:UUID? = null
    open var From:Date? = null
    open var To:Date? = null
    open var IncludeCancelled:Boolean? = null
}

open class BranchCalendarResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Branch:BranchCalendarBranch? = null
    open var Lines:ArrayList<BranchCalendarLine> = ArrayList<BranchCalendarLine>()
    open var Events:ArrayList<BranchCalendarEvent> = ArrayList<BranchCalendarEvent>()
    open var Staffing:ArrayList<BranchCalendarStaffHour> = ArrayList<BranchCalendarStaffHour>()
    open var History:BranchCalendarHistory? = null
    open var ColorByService:Boolean? = null
    open var ServerNowLocal:Date? = null
}

open class BranchCalendarBranch
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var Street:String? = null
    open var TimeZone:String? = null
    open var Windows:Int? = null
    open var Hours:ArrayList<BranchCalendarHours> = ArrayList<BranchCalendarHours>()
}

open class BranchCalendarHours
{
    open var Date:String? = null
    open var Opens:String? = null
    open var Closes:String? = null
    open var Closed:Boolean? = null
}

open class BranchCalendarLine
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var Minutes:Int? = null
    open var Color:String? = null
}

open class BranchCalendarEvent
{
    open var CalendarEventId:Int? = null
    open var Kind:String? = null
    open var Title:String? = null
    open var StartLocal:Date? = null
    open var EndLocal:Date? = null
    open var AllDay:Boolean? = null
    open var Description:String? = null
    open var Customer:BranchCalendarCustomer? = null
    open var Services:ArrayList<BranchCalendarServiceItem> = ArrayList<BranchCalendarServiceItem>()
    open var Status:BranchCalendarStatus? = null
    open var CheckInId:UUID? = null
    open var Paperwork:BranchCalendarPaperwork? = null
}

open class BranchCalendarCustomer
{
    open var ContactId:Int? = null
    open var ContactGuid:UUID? = null
    open var Name:String? = null
    open var Phone:String? = null
    open var Email:String? = null
}

open class BranchCalendarServiceItem
{
    open var LineId:UUID? = null
    open var Name:String? = null
    open var Minutes:Int? = null
}

open class BranchCalendarStatus
{
    open var State:String? = null
    open var TicketLabel:String? = null
    open var Window:String? = null
    open var ArrivedAt:Date? = null
    open var CalledAt:Date? = null
    open var ServedAt:Date? = null
    open var NoShowAt:Date? = null
    open var CancelledAt:Date? = null
    open var CancelledBy:String? = null
    open var Source:String? = null
    open var CanCheckIn:Boolean? = null
    open var CanNoShow:Boolean? = null
    open var CanReopen:Boolean? = null
    open var CanChange:Boolean? = null
    open var CanCancel:Boolean? = null
}

open class BranchCalendarPaperwork
{
    open var AsksQuestionnaire:Boolean? = null
    open var AsksUpload:Boolean? = null
    open var Submitted:Boolean? = null
}

open class BranchCalendarStaffHour
{
    open var Date:String? = null
    open var Hour:Int? = null
    open var Windows:BigDecimal? = null
    open var Source:String? = null
}

open class BranchCalendarHistory
{
    open var ByWeekdayHour:ArrayList<BranchCalendarWeekdayHour> = ArrayList<BranchCalendarWeekdayHour>()
    open var ByHour:ArrayList<BranchCalendarHourMean> = ArrayList<BranchCalendarHourMean>()
}

open class BranchCalendarWeekdayHour
{
    open var Weekday:Int? = null
    open var Hour:Int? = null
    open var Windows:BigDecimal? = null
    open var Days:Int? = null
}

open class BranchCalendarHourMean
{
    open var Hour:Int? = null
    open var Windows:BigDecimal? = null
    open var Days:Int? = null
}

Kotlin BranchCalendarRequest 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.

GET /v1/queue/calendar/{LocationId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

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"}},"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"}