Trendsic Platform Service

<back to all web services

SchedulerConfigurationSaveRequest

Requires Authentication
Required roles:Administrator, Administrator
The following routes are available for this service:
POST,PUT,OPTIONS/v1/Scheduler/Settings
import Foundation
import ServiceStack

public class SchedulerConfigurationSaveRequest : Codable
{
    public var settings:SchedulerConfiguration

    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(){}
}

public class SchedulerConfigurationSaveResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var settings:SchedulerConfiguration

    required public init(){}
}


Swift SchedulerConfigurationSaveRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/Scheduler/Settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Settings: 
	{
		ConfigId: 0,
		SchedulerUrl: String,
		SchedulerName: String,
		DefaultLocation: String,
		DefaultSummary: String,
		DefaultDescription: String,
		DayStart: PT0S,
		DayStartFriendly: "00:00",
		DayEnd: PT0S,
		DayEndFriendly: "00:00",
		TimeslotDuration: 0,
		NumberOfSlots: 0,
		LocationId: 00000000000000000000000000000000,
		CalendarId: 00000000000000000000000000000000,
		AgentId: 0,
		TimeZone: String,
		AvailableDateTimes: 
		[
			{
				DayName: String,
				DayNumber: 0,
				DayEnabled: False,
				TimeBlocks: 
				[
					{
						StartTime: PT0S,
						DayStartFriendly: "00:00",
						EndTime: PT0S,
						DayEndFriendly: "00:00"
					}
				]
			}
		],
		AvailableServices: 
		[
			00000000000000000000000000000000
		],
		AllServices: 
		[
			{
				Id: 00000000000000000000000000000000,
				LocationId: 00000000000000000000000000000000,
				LocationName: String,
				Name: String,
				Description: String,
				ServiceDurationMinutes: 0,
				WaitTime: 0,
				Cost: 0,
				UpperThreshold: 0,
				LowerThreshold: 0,
				Active: False,
				EntDate: 0001-01-01,
				ModDate: 0001-01-01,
				SendQuestionnaire: False,
				RequireUpload: False,
				UploadMessage: String,
				LineImages: 
				[
					{
						ImageId: 00000000000000000000000000000000,
						FileName: String,
						ImageTitle: String,
						UploadDate: 0001-01-01
					}
				]
			}
		]
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Settings: 
	{
		ConfigId: 0,
		SchedulerUrl: String,
		SchedulerName: String,
		DefaultLocation: String,
		DefaultSummary: String,
		DefaultDescription: String,
		DayStart: PT0S,
		DayStartFriendly: "00:00",
		DayEnd: PT0S,
		DayEndFriendly: "00:00",
		TimeslotDuration: 0,
		NumberOfSlots: 0,
		LocationId: 00000000000000000000000000000000,
		CalendarId: 00000000000000000000000000000000,
		AgentId: 0,
		TimeZone: String,
		AvailableDateTimes: 
		[
			{
				DayName: String,
				DayNumber: 0,
				DayEnabled: False,
				TimeBlocks: 
				[
					{
						StartTime: PT0S,
						DayStartFriendly: "00:00",
						EndTime: PT0S,
						DayEndFriendly: "00:00"
					}
				]
			}
		],
		AvailableServices: 
		[
			00000000000000000000000000000000
		],
		AllServices: 
		[
			{
				Id: 00000000000000000000000000000000,
				LocationId: 00000000000000000000000000000000,
				LocationName: String,
				Name: String,
				Description: String,
				ServiceDurationMinutes: 0,
				WaitTime: 0,
				Cost: 0,
				UpperThreshold: 0,
				LowerThreshold: 0,
				Active: False,
				EntDate: 0001-01-01,
				ModDate: 0001-01-01,
				SendQuestionnaire: False,
				RequireUpload: False,
				UploadMessage: String,
				LineImages: 
				[
					{
						ImageId: 00000000000000000000000000000000,
						FileName: String,
						ImageTitle: String,
						UploadDate: 0001-01-01
					}
				]
			}
		]
	}
}