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}

"use strict";
export class BranchCalendarHours {
    /** @param {{Date?:string,Opens?:string,Closes?:string,Closed?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Date;
    /** @type {string} */
    Opens;
    /** @type {string} */
    Closes;
    /** @type {boolean} */
    Closed;
}
export class BranchCalendarBranch {
    /** @param {{Id?:string,Name?:string,Street?:string,TimeZone?:string,Windows?:number,Hours?:BranchCalendarHours[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Street;
    /** @type {string} */
    TimeZone;
    /** @type {number} */
    Windows;
    /** @type {BranchCalendarHours[]} */
    Hours = [];
}
export class BranchCalendarLine {
    /** @param {{Id?:string,Name?:string,Minutes?:number,Color?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {number} */
    Minutes;
    /** @type {string} */
    Color;
}
export class BranchCalendarCustomer {
    /** @param {{ContactId?:number,ContactGuid?:string,Name?:string,Phone?:string,Email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactId;
    /** @type {?string} */
    ContactGuid;
    /** @type {string} */
    Name;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
}
export class BranchCalendarServiceItem {
    /** @param {{LineId?:string,Name?:string,Minutes?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    LineId;
    /** @type {string} */
    Name;
    /** @type {number} */
    Minutes;
}
export class BranchCalendarStatus {
    /** @param {{State?:string,TicketLabel?:string,Window?:string,ArrivedAt?:string,CalledAt?:string,ServedAt?:string,NoShowAt?:string,CancelledAt?:string,CancelledBy?:string,Source?:string,CanCheckIn?:boolean,CanNoShow?:boolean,CanReopen?:boolean,CanChange?:boolean,CanCancel?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    State;
    /** @type {string} */
    TicketLabel;
    /** @type {string} */
    Window;
    /** @type {?string} */
    ArrivedAt;
    /** @type {?string} */
    CalledAt;
    /** @type {?string} */
    ServedAt;
    /** @type {?string} */
    NoShowAt;
    /** @type {?string} */
    CancelledAt;
    /** @type {string} */
    CancelledBy;
    /** @type {string} */
    Source;
    /** @type {boolean} */
    CanCheckIn;
    /** @type {boolean} */
    CanNoShow;
    /** @type {boolean} */
    CanReopen;
    /** @type {boolean} */
    CanChange;
    /** @type {boolean} */
    CanCancel;
}
export class BranchCalendarPaperwork {
    /** @param {{AsksQuestionnaire?:boolean,AsksUpload?:boolean,Submitted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    AsksQuestionnaire;
    /** @type {boolean} */
    AsksUpload;
    /** @type {boolean} */
    Submitted;
}
export class BranchCalendarEvent {
    /** @param {{CalendarEventId?:number,Kind?:string,Title?:string,StartLocal?:string,EndLocal?:string,AllDay?:boolean,Description?:string,Customer?:BranchCalendarCustomer,Services?:BranchCalendarServiceItem[],Status?:BranchCalendarStatus,CheckInId?:string,Paperwork?:BranchCalendarPaperwork}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CalendarEventId;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Title;
    /** @type {string} */
    StartLocal;
    /** @type {?string} */
    EndLocal;
    /** @type {boolean} */
    AllDay;
    /** @type {string} */
    Description;
    /** @type {BranchCalendarCustomer} */
    Customer;
    /** @type {BranchCalendarServiceItem[]} */
    Services = [];
    /** @type {BranchCalendarStatus} */
    Status;
    /** @type {?string} */
    CheckInId;
    /** @type {BranchCalendarPaperwork} */
    Paperwork;
}
export class BranchCalendarStaffHour {
    /** @param {{Date?:string,Hour?:number,Windows?:number,Source?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Date;
    /** @type {number} */
    Hour;
    /** @type {number} */
    Windows;
    /** @type {string} */
    Source;
}
export class BranchCalendarWeekdayHour {
    /** @param {{Weekday?:number,Hour?:number,Windows?:number,Days?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Weekday;
    /** @type {number} */
    Hour;
    /** @type {number} */
    Windows;
    /** @type {number} */
    Days;
}
export class BranchCalendarHourMean {
    /** @param {{Hour?:number,Windows?:number,Days?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Hour;
    /** @type {number} */
    Windows;
    /** @type {number} */
    Days;
}
export class BranchCalendarHistory {
    /** @param {{ByWeekdayHour?:BranchCalendarWeekdayHour[],ByHour?:BranchCalendarHourMean[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BranchCalendarWeekdayHour[]} */
    ByWeekdayHour = [];
    /** @type {BranchCalendarHourMean[]} */
    ByHour = [];
}
export class BranchCalendarResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Branch?:BranchCalendarBranch,Lines?:BranchCalendarLine[],Events?:BranchCalendarEvent[],Staffing?:BranchCalendarStaffHour[],History?:BranchCalendarHistory,ColorByService?:boolean,ServerNowLocal?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {BranchCalendarBranch} */
    Branch;
    /** @type {BranchCalendarLine[]} */
    Lines = [];
    /** @type {BranchCalendarEvent[]} */
    Events = [];
    /** @type {BranchCalendarStaffHour[]} */
    Staffing = [];
    /** @type {BranchCalendarHistory} */
    History;
    /** @type {boolean} */
    ColorByService;
    /** @type {string} */
    ServerNowLocal;
}
export class BranchCalendarRequest {
    /** @param {{LocationId?:string,From?:string,To?:string,IncludeCancelled?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {?string} */
    From;
    /** @type {?string} */
    To;
    /** @type {boolean} */
    IncludeCancelled;
}

JavaScript 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>