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
SchedulerConfigurationSaveRequest Parameters:
NameParameterData TypeRequiredDescription
SettingsbodySchedulerConfigurationNo
SchedulerConfiguration Parameters:
NameParameterData TypeRequiredDescription
ConfigIdformintNo
SchedulerUrlformstringNo
SchedulerNameformstringNo
DefaultLocationformstringNo
DefaultSummaryformstringNo
DefaultDescriptionformstringNo
DayStartformTimeSpanNo
DayStartFriendlyformstringNo
DayEndformTimeSpanNo
DayEndFriendlyformstringNo
TimeslotDurationformintNo
NumberOfSlotsformint?No
LocationIdformGuidNo
CalendarIdformGuidNo
AgentIdformintNo
TimeZoneformstringNo
AvailableDateTimesformList<ScheduleConfigDay>No
AvailableServicesformList<Guid>No
AllServicesformList<Line>No
ScheduleConfigDay Parameters:
NameParameterData TypeRequiredDescription
DayNameformstringNo
DayNumberformint?No
DayEnabledformbool?No
TimeBlocksformList<ScheduleConfigTimeBlock>No
ScheduleConfigTimeBlock Parameters:
NameParameterData TypeRequiredDescription
StartTimeformTimeSpanNo
DayStartFriendlyformstringNo
EndTimeformTimeSpanNo
DayEndFriendlyformstringNo
Line Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
LocationIdformGuidNo
LocationNameformstringNo
NameformstringNo
DescriptionformstringNo
ServiceDurationMinutesformintNo
WaitTimeformintNo
CostformdecimalNo
UpperThresholdformint?No
LowerThresholdformint?No
ActiveformboolNo
EntDateformDateTime?No
ModDateformDateTime?No
SendQuestionnaireformboolNo
RequireUploadformboolNo
UploadMessageformstringNo
LineImagesformList<LineImage>No
LineImage Parameters:
NameParameterData TypeRequiredDescription
ImageIdformGuid?No
FileNameformstringNo
ImageTitleformstringNo
UploadDateformDateTimeNo
SchedulerConfigurationSaveResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SettingsformSchedulerConfigurationNo

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