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}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class BranchCalendarRequest
{
    open var LocationId:UUID? = null
    open var From:Date? = null
    open var To:Date? = null
    open var IncludeCancelled:Boolean? = null
}

open class BranchCalendarResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Branch:BranchCalendarBranch? = null
    open var Lines:ArrayList<BranchCalendarLine> = ArrayList<BranchCalendarLine>()
    open var Events:ArrayList<BranchCalendarEvent> = ArrayList<BranchCalendarEvent>()
    open var Staffing:ArrayList<BranchCalendarStaffHour> = ArrayList<BranchCalendarStaffHour>()
    open var History:BranchCalendarHistory? = null
    open var ColorByService:Boolean? = null
    open var ServerNowLocal:Date? = null
}

open class BranchCalendarBranch
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var Street:String? = null
    open var TimeZone:String? = null
    open var Windows:Int? = null
    open var Hours:ArrayList<BranchCalendarHours> = ArrayList<BranchCalendarHours>()
}

open class BranchCalendarHours
{
    open var Date:String? = null
    open var Opens:String? = null
    open var Closes:String? = null
    open var Closed:Boolean? = null
}

open class BranchCalendarLine
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var Minutes:Int? = null
    open var Color:String? = null
}

open class BranchCalendarEvent
{
    open var CalendarEventId:Int? = null
    open var Kind:String? = null
    open var Title:String? = null
    open var StartLocal:Date? = null
    open var EndLocal:Date? = null
    open var AllDay:Boolean? = null
    open var Description:String? = null
    open var Customer:BranchCalendarCustomer? = null
    open var Services:ArrayList<BranchCalendarServiceItem> = ArrayList<BranchCalendarServiceItem>()
    open var Status:BranchCalendarStatus? = null
    open var CheckInId:UUID? = null
    open var Paperwork:BranchCalendarPaperwork? = null
}

open class BranchCalendarCustomer
{
    open var ContactId:Int? = null
    open var ContactGuid:UUID? = null
    open var Name:String? = null
    open var Phone:String? = null
    open var Email:String? = null
}

open class BranchCalendarServiceItem
{
    open var LineId:UUID? = null
    open var Name:String? = null
    open var Minutes:Int? = null
}

open class BranchCalendarStatus
{
    open var State:String? = null
    open var TicketLabel:String? = null
    open var Window:String? = null
    open var ArrivedAt:Date? = null
    open var CalledAt:Date? = null
    open var ServedAt:Date? = null
    open var NoShowAt:Date? = null
    open var CancelledAt:Date? = null
    open var CancelledBy:String? = null
    open var Source:String? = null
    open var CanCheckIn:Boolean? = null
    open var CanNoShow:Boolean? = null
    open var CanReopen:Boolean? = null
    open var CanChange:Boolean? = null
    open var CanCancel:Boolean? = null
}

open class BranchCalendarPaperwork
{
    open var AsksQuestionnaire:Boolean? = null
    open var AsksUpload:Boolean? = null
    open var Submitted:Boolean? = null
}

open class BranchCalendarStaffHour
{
    open var Date:String? = null
    open var Hour:Int? = null
    open var Windows:BigDecimal? = null
    open var Source:String? = null
}

open class BranchCalendarHistory
{
    open var ByWeekdayHour:ArrayList<BranchCalendarWeekdayHour> = ArrayList<BranchCalendarWeekdayHour>()
    open var ByHour:ArrayList<BranchCalendarHourMean> = ArrayList<BranchCalendarHourMean>()
}

open class BranchCalendarWeekdayHour
{
    open var Weekday:Int? = null
    open var Hour:Int? = null
    open var Windows:BigDecimal? = null
    open var Days:Int? = null
}

open class BranchCalendarHourMean
{
    open var Hour:Int? = null
    open var Windows:BigDecimal? = null
    open var Days:Int? = null
}

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