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}


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

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>