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
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 ScheduleConfigTimeBlock() = 
        member val StartTime:TimeSpan = new TimeSpan() with get,set
        member val DayStartFriendly:String = null with get,set
        member val EndTime:TimeSpan = new TimeSpan() with get,set
        member val DayEndFriendly:String = null with get,set

    [<AllowNullLiteral>]
    type ScheduleConfigDay() = 
        member val DayName:String = null with get,set
        member val DayNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DayEnabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val TimeBlocks:ResizeArray<ScheduleConfigTimeBlock> = new ResizeArray<ScheduleConfigTimeBlock>() with get,set

    [<AllowNullLiteral>]
    type LineImage() = 
        member val ImageId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val FileName:String = null with get,set
        member val ImageTitle:String = null with get,set
        member val UploadDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type Line() = 
        member val Id:Guid = new Guid() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val LocationName:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val ServiceDurationMinutes:Int32 = new Int32() with get,set
        member val WaitTime:Int32 = new Int32() with get,set
        member val Cost:Decimal = new Decimal() with get,set
        member val UpperThreshold:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LowerThreshold:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val EntDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ModDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SendQuestionnaire:Boolean = new Boolean() with get,set
        member val RequireUpload:Boolean = new Boolean() with get,set
        member val UploadMessage:String = null with get,set
        member val LineImages:ResizeArray<LineImage> = new ResizeArray<LineImage>() with get,set

    [<AllowNullLiteral>]
    type SchedulerConfiguration() = 
        member val ConfigId:Int32 = new Int32() with get,set
        member val SchedulerUrl:String = null with get,set
        member val SchedulerName:String = null with get,set
        member val DefaultLocation:String = null with get,set
        member val DefaultSummary:String = null with get,set
        member val DefaultDescription:String = null with get,set
        member val DayStart:TimeSpan = new TimeSpan() with get,set
        member val DayStartFriendly:String = null with get,set
        member val DayEnd:TimeSpan = new TimeSpan() with get,set
        member val DayEndFriendly:String = null with get,set
        member val TimeslotDuration:Int32 = new Int32() with get,set
        member val NumberOfSlots:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val CalendarId:Guid = new Guid() with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val TimeZone:String = null with get,set
        member val AvailableDateTimes:ResizeArray<ScheduleConfigDay> = new ResizeArray<ScheduleConfigDay>() with get,set
        member val AvailableServices:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
        member val AllServices:ResizeArray<Line> = new ResizeArray<Line>() with get,set

    [<AllowNullLiteral>]
    type SchedulerConfigurationSaveRequest() = 
        member val Settings:SchedulerConfiguration = null with get,set

    [<AllowNullLiteral>]
    type SchedulerConfigurationSaveResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Settings:SchedulerConfiguration = null with get,set

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