Trendsic Platform Service

<back to all web services

SchedulerConfigurationRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Scheduler/Settings/{LocationId}/{AgentId}/{Mode}
import Foundation
import ServiceStack

public class SchedulerConfigurationRequest : Codable
{
    public var locationId:String
    public var agentId:Int
    public var mode:String

    required public init(){}
}

public class SchedulerConfiguration : Codable
{
    public var configId:Int
    public var schedulerUrl:String
    public var schedulerName:String
    public var defaultLocation:String
    public var defaultSummary:String
    public var defaultDescription:String
    @TimeSpan public var dayStart:TimeInterval
    public var dayStartFriendly:String
    @TimeSpan public var dayEnd:TimeInterval
    public var dayEndFriendly:String
    public var timeslotDuration:Int
    public var numberOfSlots:Int?
    public var locationId:String
    public var calendarId:String
    public var agentId:Int
    public var timeZone:String
    public var availableDateTimes:[ScheduleConfigDay] = []
    public var availableServices:[String] = []
    public var allServices:[Line] = []

    required public init(){}
}

public class ScheduleConfigDay : Codable
{
    public var dayName:String
    public var dayNumber:Int?
    public var dayEnabled:Bool?
    public var timeBlocks:[ScheduleConfigTimeBlock] = []

    required public init(){}
}

public class ScheduleConfigTimeBlock : Codable
{
    @TimeSpan public var startTime:TimeInterval
    public var dayStartFriendly:String
    @TimeSpan public var endTime:TimeInterval
    public var dayEndFriendly:String

    required public init(){}
}

public class Line : Codable
{
    public var id:String
    public var locationId:String
    public var locationName:String
    public var name:String
    public var Description:String
    public var serviceDurationMinutes:Int
    public var waitTime:Int
    public var cost:Double
    public var upperThreshold:Int?
    public var lowerThreshold:Int?
    public var active:Bool
    public var entDate:Date?
    public var modDate:Date?
    public var sendQuestionnaire:Bool
    public var requireUpload:Bool
    public var uploadMessage:String
    public var lineImages:[LineImage] = []

    required public init(){}
}

public class LineImage : Codable
{
    public var imageId:String?
    public var fileName:String
    public var imageTitle:String
    public var uploadDate:Date

    required public init(){}
}


Swift SchedulerConfigurationRequest 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/Scheduler/Settings/{LocationId}/{AgentId}/{Mode} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SchedulerConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentId>0</AgentId>
  <AllServices>
    <Line>
      <Active>false</Active>
      <Cost>0</Cost>
      <Description>String</Description>
      <EntDate>0001-01-01T00:00:00</EntDate>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <LineImages>
        <LineImage>
          <FileName>String</FileName>
          <ImageId>00000000-0000-0000-0000-000000000000</ImageId>
          <ImageTitle>String</ImageTitle>
          <UploadDate>0001-01-01T00:00:00</UploadDate>
        </LineImage>
      </LineImages>
      <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
      <LocationName>String</LocationName>
      <LowerThreshold>0</LowerThreshold>
      <ModDate>0001-01-01T00:00:00</ModDate>
      <Name>String</Name>
      <RequireUpload>false</RequireUpload>
      <SendQuestionnaire>false</SendQuestionnaire>
      <ServiceDurationMinutes>0</ServiceDurationMinutes>
      <UploadMessage>String</UploadMessage>
      <UpperThreshold>0</UpperThreshold>
      <WaitTime>0</WaitTime>
    </Line>
  </AllServices>
  <AvailableDateTimes>
    <ScheduleConfigDay>
      <DayEnabled>false</DayEnabled>
      <DayName>String</DayName>
      <DayNumber>0</DayNumber>
      <TimeBlocks>
        <ScheduleConfigTimeBlock>
          <EndTime>PT0S</EndTime>
          <StartTime>PT0S</StartTime>
        </ScheduleConfigTimeBlock>
      </TimeBlocks>
    </ScheduleConfigDay>
  </AvailableDateTimes>
  <AvailableServices xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </AvailableServices>
  <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
  <ConfigId>0</ConfigId>
  <DayEnd>PT0S</DayEnd>
  <DayStart>PT0S</DayStart>
  <DefaultDescription>String</DefaultDescription>
  <DefaultLocation>String</DefaultLocation>
  <DefaultSummary>String</DefaultSummary>
  <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
  <NumberOfSlots>0</NumberOfSlots>
  <SchedulerName>String</SchedulerName>
  <SchedulerUrl>String</SchedulerUrl>
  <TimeZone>String</TimeZone>
  <TimeslotDuration>0</TimeslotDuration>
</SchedulerConfiguration>