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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BranchCalendarResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Branch>
    <Hours>
      <BranchCalendarHours>
        <Closed>false</Closed>
        <Closes>String</Closes>
        <Date>String</Date>
        <Opens>String</Opens>
      </BranchCalendarHours>
    </Hours>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Name>String</Name>
    <Street>String</Street>
    <TimeZone>String</TimeZone>
    <Windows>0</Windows>
  </Branch>
  <ColorByService>false</ColorByService>
  <Events>
    <BranchCalendarEvent>
      <AllDay>false</AllDay>
      <CalendarEventId>0</CalendarEventId>
      <CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
      <Customer>
        <ContactGuid>00000000-0000-0000-0000-000000000000</ContactGuid>
        <ContactId>0</ContactId>
        <Email>String</Email>
        <Name>String</Name>
        <Phone>String</Phone>
      </Customer>
      <Description>String</Description>
      <EndLocal>0001-01-01T00:00:00</EndLocal>
      <Kind>String</Kind>
      <Paperwork>
        <AsksQuestionnaire>false</AsksQuestionnaire>
        <AsksUpload>false</AsksUpload>
        <Submitted>false</Submitted>
      </Paperwork>
      <Services>
        <BranchCalendarServiceItem>
          <LineId>00000000-0000-0000-0000-000000000000</LineId>
          <Minutes>0</Minutes>
          <Name>String</Name>
        </BranchCalendarServiceItem>
      </Services>
      <StartLocal>0001-01-01T00:00:00</StartLocal>
      <Status>
        <ArrivedAt>0001-01-01T00:00:00</ArrivedAt>
        <CalledAt>0001-01-01T00:00:00</CalledAt>
        <CanCancel>false</CanCancel>
        <CanChange>false</CanChange>
        <CanCheckIn>false</CanCheckIn>
        <CanNoShow>false</CanNoShow>
        <CanReopen>false</CanReopen>
        <CancelledAt>0001-01-01T00:00:00</CancelledAt>
        <CancelledBy>String</CancelledBy>
        <NoShowAt>0001-01-01T00:00:00</NoShowAt>
        <ServedAt>0001-01-01T00:00:00</ServedAt>
        <Source>String</Source>
        <State>String</State>
        <TicketLabel>String</TicketLabel>
        <Window>String</Window>
      </Status>
      <Title>String</Title>
    </BranchCalendarEvent>
  </Events>
  <History>
    <ByHour>
      <BranchCalendarHourMean>
        <Days>0</Days>
        <Hour>0</Hour>
        <Windows>0</Windows>
      </BranchCalendarHourMean>
    </ByHour>
    <ByWeekdayHour>
      <BranchCalendarWeekdayHour>
        <Days>0</Days>
        <Hour>0</Hour>
        <Weekday>0</Weekday>
        <Windows>0</Windows>
      </BranchCalendarWeekdayHour>
    </ByWeekdayHour>
  </History>
  <Lines>
    <BranchCalendarLine>
      <Color>String</Color>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Minutes>0</Minutes>
      <Name>String</Name>
    </BranchCalendarLine>
  </Lines>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ServerNowLocal>0001-01-01T00:00:00</ServerNowLocal>
  <Staffing>
    <BranchCalendarStaffHour>
      <Date>String</Date>
      <Hour>0</Hour>
      <Source>String</Source>
      <Windows>0</Windows>
    </BranchCalendarStaffHour>
  </Staffing>
</BranchCalendarResponse>