Trendsic Platform Service

<back to all web services

BranchCalendarRequest

export class BranchCalendarHours
{
    public Date: string;
    public Opens: string;
    public Closes: string;
    public Closed: boolean;

    public constructor(init?: Partial<BranchCalendarHours>) { (Object as any).assign(this, init); }
}

export class BranchCalendarBranch
{
    public Id: string;
    public Name: string;
    public Street: string;
    public TimeZone: string;
    public Windows: number;
    public Hours: BranchCalendarHours[] = [];

    public constructor(init?: Partial<BranchCalendarBranch>) { (Object as any).assign(this, init); }
}

export class BranchCalendarLine
{
    public Id: string;
    public Name: string;
    public Minutes: number;
    public Color: string;

    public constructor(init?: Partial<BranchCalendarLine>) { (Object as any).assign(this, init); }
}

export class BranchCalendarCustomer
{
    public ContactId: number;
    public ContactGuid?: string;
    public Name: string;
    public Phone: string;
    public Email: string;

    public constructor(init?: Partial<BranchCalendarCustomer>) { (Object as any).assign(this, init); }
}

export class BranchCalendarServiceItem
{
    public LineId?: string;
    public Name: string;
    public Minutes: number;

    public constructor(init?: Partial<BranchCalendarServiceItem>) { (Object as any).assign(this, init); }
}

export class BranchCalendarStatus
{
    public State: string;
    public TicketLabel: string;
    public Window: string;
    public ArrivedAt?: string;
    public CalledAt?: string;
    public ServedAt?: string;
    public NoShowAt?: string;
    public CancelledAt?: string;
    public CancelledBy: string;
    public Source: string;
    public CanCheckIn: boolean;
    public CanNoShow: boolean;
    public CanReopen: boolean;
    public CanChange: boolean;
    public CanCancel: boolean;

    public constructor(init?: Partial<BranchCalendarStatus>) { (Object as any).assign(this, init); }
}

export class BranchCalendarPaperwork
{
    public AsksQuestionnaire: boolean;
    public AsksUpload: boolean;
    public Submitted: boolean;

    public constructor(init?: Partial<BranchCalendarPaperwork>) { (Object as any).assign(this, init); }
}

export class BranchCalendarEvent
{
    public CalendarEventId: number;
    public Kind: string;
    public Title: string;
    public StartLocal: string;
    public EndLocal?: string;
    public AllDay: boolean;
    public Description: string;
    public Customer: BranchCalendarCustomer;
    public Services: BranchCalendarServiceItem[] = [];
    public Status: BranchCalendarStatus;
    public CheckInId?: string;
    public Paperwork: BranchCalendarPaperwork;

    public constructor(init?: Partial<BranchCalendarEvent>) { (Object as any).assign(this, init); }
}

export class BranchCalendarStaffHour
{
    public Date: string;
    public Hour: number;
    public Windows: number;
    public Source: string;

    public constructor(init?: Partial<BranchCalendarStaffHour>) { (Object as any).assign(this, init); }
}

export class BranchCalendarWeekdayHour
{
    public Weekday: number;
    public Hour: number;
    public Windows: number;
    public Days: number;

    public constructor(init?: Partial<BranchCalendarWeekdayHour>) { (Object as any).assign(this, init); }
}

export class BranchCalendarHourMean
{
    public Hour: number;
    public Windows: number;
    public Days: number;

    public constructor(init?: Partial<BranchCalendarHourMean>) { (Object as any).assign(this, init); }
}

export class BranchCalendarHistory
{
    public ByWeekdayHour: BranchCalendarWeekdayHour[] = [];
    public ByHour: BranchCalendarHourMean[] = [];

    public constructor(init?: Partial<BranchCalendarHistory>) { (Object as any).assign(this, init); }
}

export class BranchCalendarResponse
{
    public ResponseStatus: ResponseStatus;
    public Branch: BranchCalendarBranch;
    public Lines: BranchCalendarLine[] = [];
    public Events: BranchCalendarEvent[] = [];
    public Staffing: BranchCalendarStaffHour[] = [];
    public History: BranchCalendarHistory;
    public ColorByService: boolean;
    public ServerNowLocal: string;

    public constructor(init?: Partial<BranchCalendarResponse>) { (Object as any).assign(this, init); }
}

export class BranchCalendarRequest
{
    public LocationId: string;
    public From?: string;
    public To?: string;
    public IncludeCancelled: boolean;

    public constructor(init?: Partial<BranchCalendarRequest>) { (Object as any).assign(this, init); }
}

TypeScript BranchCalendarRequest DTOs

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
}