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}

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class BranchCalendarBranch
            Public Overridable Property Id As Guid
            Public Overridable Property Name As String
            Public Overridable Property Street As String
            Public Overridable Property TimeZone As String
            Public Overridable Property Windows As Integer
            Public Overridable Property Hours As List(Of BranchCalendarHours) = New List(Of BranchCalendarHours)
        End Class

        Public Partial Class BranchCalendarCustomer
            Public Overridable Property ContactId As Integer
            Public Overridable Property ContactGuid As Guid?
            Public Overridable Property Name As String
            Public Overridable Property Phone As String
            Public Overridable Property Email As String
        End Class

        Public Partial Class BranchCalendarEvent
            Public Overridable Property CalendarEventId As Integer
            Public Overridable Property Kind As String
            Public Overridable Property Title As String
            Public Overridable Property StartLocal As Date
            Public Overridable Property EndLocal As Date?
            Public Overridable Property AllDay As Boolean
            Public Overridable Property Description As String
            Public Overridable Property Customer As BranchCalendarCustomer
            Public Overridable Property Services As List(Of BranchCalendarServiceItem) = New List(Of BranchCalendarServiceItem)
            Public Overridable Property Status As BranchCalendarStatus
            Public Overridable Property CheckInId As Guid?
            Public Overridable Property Paperwork As BranchCalendarPaperwork
        End Class

        Public Partial Class BranchCalendarHistory
            Public Overridable Property ByWeekdayHour As List(Of BranchCalendarWeekdayHour) = New List(Of BranchCalendarWeekdayHour)
            Public Overridable Property ByHour As List(Of BranchCalendarHourMean) = New List(Of BranchCalendarHourMean)
        End Class

        Public Partial Class BranchCalendarHourMean
            Public Overridable Property Hour As Integer
            Public Overridable Property Windows As Decimal
            Public Overridable Property Days As Integer
        End Class

        Public Partial Class BranchCalendarHours
            Public Overridable Property [Date] As String
            Public Overridable Property Opens As String
            Public Overridable Property Closes As String
            Public Overridable Property Closed As Boolean
        End Class

        Public Partial Class BranchCalendarLine
            Public Overridable Property Id As Guid
            Public Overridable Property Name As String
            Public Overridable Property Minutes As Integer
            Public Overridable Property Color As String
        End Class

        Public Partial Class BranchCalendarPaperwork
            Public Overridable Property AsksQuestionnaire As Boolean
            Public Overridable Property AsksUpload As Boolean
            Public Overridable Property Submitted As Boolean
        End Class

        Public Partial Class BranchCalendarRequest
            Public Overridable Property LocationId As Guid
            Public Overridable Property From As Date?
            Public Overridable Property [To] As Date?
            Public Overridable Property IncludeCancelled As Boolean
        End Class

        Public Partial Class BranchCalendarResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Branch As BranchCalendarBranch
            Public Overridable Property Lines As List(Of BranchCalendarLine) = New List(Of BranchCalendarLine)
            Public Overridable Property Events As List(Of BranchCalendarEvent) = New List(Of BranchCalendarEvent)
            Public Overridable Property Staffing As List(Of BranchCalendarStaffHour) = New List(Of BranchCalendarStaffHour)
            Public Overridable Property History As BranchCalendarHistory
            Public Overridable Property ColorByService As Boolean
            Public Overridable Property ServerNowLocal As Date
        End Class

        Public Partial Class BranchCalendarServiceItem
            Public Overridable Property LineId As Guid?
            Public Overridable Property Name As String
            Public Overridable Property Minutes As Integer
        End Class

        Public Partial Class BranchCalendarStaffHour
            Public Overridable Property [Date] As String
            Public Overridable Property Hour As Integer
            Public Overridable Property Windows As Decimal
            Public Overridable Property Source As String
        End Class

        Public Partial Class BranchCalendarStatus
            Public Overridable Property State As String
            Public Overridable Property TicketLabel As String
            Public Overridable Property Window As String
            Public Overridable Property ArrivedAt As Date?
            Public Overridable Property CalledAt As Date?
            Public Overridable Property ServedAt As Date?
            Public Overridable Property NoShowAt As Date?
            Public Overridable Property CancelledAt As Date?
            Public Overridable Property CancelledBy As String
            Public Overridable Property Source As String
            Public Overridable Property CanCheckIn As Boolean
            Public Overridable Property CanNoShow As Boolean
            Public Overridable Property CanReopen As Boolean
            Public Overridable Property CanChange As Boolean
            Public Overridable Property CanCancel As Boolean
        End Class

        Public Partial Class BranchCalendarWeekdayHour
            Public Overridable Property Weekday As Integer
            Public Overridable Property Hour As Integer
            Public Overridable Property Windows As Decimal
            Public Overridable Property Days As Integer
        End Class
    End Namespace
End Namespace

VB.NET BranchCalendarRequest DTOs

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

HTTP + JSV

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

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			EndLocal: 0001-01-01,
			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-01,
				CalledAt: 0001-01-01,
				ServedAt: 0001-01-01,
				NoShowAt: 0001-01-01,
				CancelledAt: 0001-01-01,
				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-01
}