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}

**BranchCalendarRequest** Parameters:
Name	Parameter	Data Type	Required
LocationId	path	Guid	No
From	query	DateTime?	No
To	query	DateTime?	No
IncludeCancelled	query	bool	No

**BranchCalendarResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Branch	form	BranchCalendarBranch	No
Lines	form	List<BranchCalendarLine>	No
Events	form	List<BranchCalendarEvent>	No
Staffing	form	List<BranchCalendarStaffHour>	No
History	form	BranchCalendarHistory	No
ColorByService	form	bool	No
ServerNowLocal	form	DateTime	No

**BranchCalendarBranch** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Street	form	string	No
TimeZone	form	string	No
Windows	form	int	No
Hours	form	List<BranchCalendarHours>	No

**BranchCalendarHours** Parameters:
Name	Parameter	Data Type	Required
Date	form	string	No
Opens	form	string	No
Closes	form	string	No
Closed	form	bool	No

**BranchCalendarLine** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Minutes	form	int	No
Color	form	string	No

**BranchCalendarEvent** Parameters:
Name	Parameter	Data Type	Required
CalendarEventId	form	int	No
Kind	form	string	No
Title	form	string	No
StartLocal	form	DateTime	No
EndLocal	form	DateTime?	No
AllDay	form	bool	No
Description	form	string	No
Customer	form	BranchCalendarCustomer	No
Services	form	List<BranchCalendarServiceItem>	No
Status	form	BranchCalendarStatus	No
CheckInId	form	Guid?	No
Paperwork	form	BranchCalendarPaperwork	No

**BranchCalendarCustomer** Parameters:
Name	Parameter	Data Type	Required
ContactId	form	int	No
ContactGuid	form	Guid?	No
Name	form	string	No
Phone	form	string	No
Email	form	string	No

**BranchCalendarServiceItem** Parameters:
Name	Parameter	Data Type	Required
LineId	form	Guid?	No
Name	form	string	No
Minutes	form	int	No

**BranchCalendarStatus** Parameters:
Name	Parameter	Data Type	Required
State	form	string	No
TicketLabel	form	string	No
Window	form	string	No
ArrivedAt	form	DateTime?	No
CalledAt	form	DateTime?	No
ServedAt	form	DateTime?	No
NoShowAt	form	DateTime?	No
CancelledAt	form	DateTime?	No
CancelledBy	form	string	No
Source	form	string	No
CanCheckIn	form	bool	No
CanNoShow	form	bool	No
CanReopen	form	bool	No
CanChange	form	bool	No
CanCancel	form	bool	No

**BranchCalendarPaperwork** Parameters:
Name	Parameter	Data Type	Required
AsksQuestionnaire	form	bool	No
AsksUpload	form	bool	No
Submitted	form	bool	No

**BranchCalendarStaffHour** Parameters:
Name	Parameter	Data Type	Required
Date	form	string	No
Hour	form	int	No
Windows	form	decimal	No
Source	form	string	No

**BranchCalendarHistory** Parameters:
Name	Parameter	Data Type	Required	Description
ByWeekdayHour	form	List<BranchCalendarWeekdayHour>	No
ByHour	form	List<BranchCalendarHourMean>	No

**BranchCalendarWeekdayHour** Parameters:
Name	Parameter	Data Type	Required
Weekday	form	int	No
Hour	form	int	No
Windows	form	decimal	No
Days	form	int	No

**BranchCalendarHourMean** Parameters:
Name	Parameter	Data Type	Required
Hour	form	int	No
Windows	form	decimal	No
Days	form	int	No

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>