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}

namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BranchCalendarHours() = 
        member val Date:String = null with get,set
        member val Opens:String = null with get,set
        member val Closes:String = null with get,set
        member val Closed:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type BranchCalendarBranch() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Street:String = null with get,set
        member val TimeZone:String = null with get,set
        member val Windows:Int32 = new Int32() with get,set
        member val Hours:ResizeArray<BranchCalendarHours> = new ResizeArray<BranchCalendarHours>() with get,set

    [<AllowNullLiteral>]
    type BranchCalendarLine() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Minutes:Int32 = new Int32() with get,set
        member val Color:String = null with get,set

    [<AllowNullLiteral>]
    type BranchCalendarCustomer() = 
        member val ContactId:Int32 = new Int32() with get,set
        member val ContactGuid:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Name:String = null with get,set
        member val Phone:String = null with get,set
        member val Email:String = null with get,set

    [<AllowNullLiteral>]
    type BranchCalendarServiceItem() = 
        member val LineId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Name:String = null with get,set
        member val Minutes:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BranchCalendarStatus() = 
        member val State:String = null with get,set
        member val TicketLabel:String = null with get,set
        member val Window:String = null with get,set
        member val ArrivedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CalledAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ServedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val NoShowAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CancelledAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CancelledBy:String = null with get,set
        member val Source:String = null with get,set
        member val CanCheckIn:Boolean = new Boolean() with get,set
        member val CanNoShow:Boolean = new Boolean() with get,set
        member val CanReopen:Boolean = new Boolean() with get,set
        member val CanChange:Boolean = new Boolean() with get,set
        member val CanCancel:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type BranchCalendarPaperwork() = 
        member val AsksQuestionnaire:Boolean = new Boolean() with get,set
        member val AsksUpload:Boolean = new Boolean() with get,set
        member val Submitted:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type BranchCalendarEvent() = 
        member val CalendarEventId:Int32 = new Int32() with get,set
        member val Kind:String = null with get,set
        member val Title:String = null with get,set
        member val StartLocal:DateTime = new DateTime() with get,set
        member val EndLocal:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AllDay:Boolean = new Boolean() with get,set
        member val Description:String = null with get,set
        member val Customer:BranchCalendarCustomer = null with get,set
        member val Services:ResizeArray<BranchCalendarServiceItem> = new ResizeArray<BranchCalendarServiceItem>() with get,set
        member val Status:BranchCalendarStatus = null with get,set
        member val CheckInId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Paperwork:BranchCalendarPaperwork = null with get,set

    [<AllowNullLiteral>]
    type BranchCalendarStaffHour() = 
        member val Date:String = null with get,set
        member val Hour:Int32 = new Int32() with get,set
        member val Windows:Decimal = new Decimal() with get,set
        member val Source:String = null with get,set

    [<AllowNullLiteral>]
    type BranchCalendarWeekdayHour() = 
        member val Weekday:Int32 = new Int32() with get,set
        member val Hour:Int32 = new Int32() with get,set
        member val Windows:Decimal = new Decimal() with get,set
        member val Days:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BranchCalendarHourMean() = 
        member val Hour:Int32 = new Int32() with get,set
        member val Windows:Decimal = new Decimal() with get,set
        member val Days:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BranchCalendarHistory() = 
        member val ByWeekdayHour:ResizeArray<BranchCalendarWeekdayHour> = new ResizeArray<BranchCalendarWeekdayHour>() with get,set
        member val ByHour:ResizeArray<BranchCalendarHourMean> = new ResizeArray<BranchCalendarHourMean>() with get,set

    [<AllowNullLiteral>]
    type BranchCalendarResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Branch:BranchCalendarBranch = null with get,set
        member val Lines:ResizeArray<BranchCalendarLine> = new ResizeArray<BranchCalendarLine>() with get,set
        member val Events:ResizeArray<BranchCalendarEvent> = new ResizeArray<BranchCalendarEvent>() with get,set
        member val Staffing:ResizeArray<BranchCalendarStaffHour> = new ResizeArray<BranchCalendarStaffHour>() with get,set
        member val History:BranchCalendarHistory = null with get,set
        member val ColorByService:Boolean = new Boolean() with get,set
        member val ServerNowLocal:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type BranchCalendarRequest() = 
        member val LocationId:Guid = new Guid() with get,set
        member val From:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val To:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IncludeCancelled:Boolean = new Boolean() with get,set

F# 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>