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}

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

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class BranchCalendarBranch
    {
        public virtual Guid Id { get; set; }
        public virtual string Name { get; set; }
        public virtual string Street { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual int Windows { get; set; }
        public virtual List<BranchCalendarHours> Hours { get; set; } = [];
    }

    public partial class BranchCalendarCustomer
    {
        public virtual int ContactId { get; set; }
        public virtual Guid? ContactGuid { get; set; }
        public virtual string Name { get; set; }
        public virtual string Phone { get; set; }
        public virtual string Email { get; set; }
    }

    public partial class BranchCalendarEvent
    {
        public virtual int CalendarEventId { get; set; }
        public virtual string Kind { get; set; }
        public virtual string Title { get; set; }
        public virtual DateTime StartLocal { get; set; }
        public virtual DateTime? EndLocal { get; set; }
        public virtual bool AllDay { get; set; }
        public virtual string Description { get; set; }
        public virtual BranchCalendarCustomer Customer { get; set; }
        public virtual List<BranchCalendarServiceItem> Services { get; set; } = [];
        public virtual BranchCalendarStatus Status { get; set; }
        public virtual Guid? CheckInId { get; set; }
        public virtual BranchCalendarPaperwork Paperwork { get; set; }
    }

    public partial class BranchCalendarHistory
    {
        public virtual List<BranchCalendarWeekdayHour> ByWeekdayHour { get; set; } = [];
        public virtual List<BranchCalendarHourMean> ByHour { get; set; } = [];
    }

    public partial class BranchCalendarHourMean
    {
        public virtual int Hour { get; set; }
        public virtual decimal Windows { get; set; }
        public virtual int Days { get; set; }
    }

    public partial class BranchCalendarHours
    {
        public virtual string Date { get; set; }
        public virtual string Opens { get; set; }
        public virtual string Closes { get; set; }
        public virtual bool Closed { get; set; }
    }

    public partial class BranchCalendarLine
    {
        public virtual Guid Id { get; set; }
        public virtual string Name { get; set; }
        public virtual int Minutes { get; set; }
        public virtual string Color { get; set; }
    }

    public partial class BranchCalendarPaperwork
    {
        public virtual bool AsksQuestionnaire { get; set; }
        public virtual bool AsksUpload { get; set; }
        public virtual bool Submitted { get; set; }
    }

    public partial class BranchCalendarRequest
    {
        public virtual Guid LocationId { get; set; }
        public virtual DateTime? From { get; set; }
        public virtual DateTime? To { get; set; }
        public virtual bool IncludeCancelled { get; set; }
    }

    public partial class BranchCalendarResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual BranchCalendarBranch Branch { get; set; }
        public virtual List<BranchCalendarLine> Lines { get; set; } = [];
        public virtual List<BranchCalendarEvent> Events { get; set; } = [];
        public virtual List<BranchCalendarStaffHour> Staffing { get; set; } = [];
        public virtual BranchCalendarHistory History { get; set; }
        public virtual bool ColorByService { get; set; }
        public virtual DateTime ServerNowLocal { get; set; }
    }

    public partial class BranchCalendarServiceItem
    {
        public virtual Guid? LineId { get; set; }
        public virtual string Name { get; set; }
        public virtual int Minutes { get; set; }
    }

    public partial class BranchCalendarStaffHour
    {
        public virtual string Date { get; set; }
        public virtual int Hour { get; set; }
        public virtual decimal Windows { get; set; }
        public virtual string Source { get; set; }
    }

    public partial class BranchCalendarStatus
    {
        public virtual string State { get; set; }
        public virtual string TicketLabel { get; set; }
        public virtual string Window { get; set; }
        public virtual DateTime? ArrivedAt { get; set; }
        public virtual DateTime? CalledAt { get; set; }
        public virtual DateTime? ServedAt { get; set; }
        public virtual DateTime? NoShowAt { get; set; }
        public virtual DateTime? CancelledAt { get; set; }
        public virtual string CancelledBy { get; set; }
        public virtual string Source { get; set; }
        public virtual bool CanCheckIn { get; set; }
        public virtual bool CanNoShow { get; set; }
        public virtual bool CanReopen { get; set; }
        public virtual bool CanChange { get; set; }
        public virtual bool CanCancel { get; set; }
    }

    public partial class BranchCalendarWeekdayHour
    {
        public virtual int Weekday { get; set; }
        public virtual int Hour { get; set; }
        public virtual decimal Windows { get; set; }
        public virtual int Days { get; set; }
    }

}

C# 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
}