Trendsic Platform Service

<back to all web services

SchedulerRequest

The following routes are available for this service:
GET,OPTIONS/v1/Scheduler/{SchedulerUrl}
GET,OPTIONS/v1/Scheduler/{SchedulerUrl}/{StartDate}
GET,OPTIONS/v1/Scheduler/{SchedulerUrl}/{StartDate}/{LocalDate}
GET,OPTIONS/v1/SchedulerServices/{SchedulerUrl}/{StartDate}/{ServiceIdsList}
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 SchedulerRequest() = 
        member val SchedulerUrl:String = null with get,set
        member val StartDate:DateTime = new DateTime() with get,set
        member val Session:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ServiceIdsList:String = null with get,set

    [<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 Contact() = 
        member val ContactId:Int32 = new Int32() with get,set
        member val ContactType:Int32 = new Int32() with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val Name:String = null with get,set
        member val Role:String = null with get,set
        member val Title:String = null with get,set
        member val EmailWork:String = null with get,set
        member val EmailPersonal:String = null with get,set
        member val District:String = null with get,set
        member val DistrictID:Int32 = new Int32() with get,set
        member val School:String = null with get,set
        member val SchoolID:Int64 = new Int64() with get,set
        member val State:String = null with get,set
        member val StateName:String = null with get,set
        member val StateID:Int64 = new Int64() with get,set
        member val CountyID:Int64 = new Int64() with get,set
        member val County:String = null with get,set
        member val Phone:String = null with get,set
        member val Department:String = null with get,set
        member val Flow:String = null with get,set
        member val LastContact:DateTime = new DateTime() with get,set
        member val DoNotContact:Boolean = new Boolean() with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val PhoneAlt:String = null with get,set
        member val PeraContactId:Int32 = new Int32() with get,set
        member val RoomNumber:String = null with get,set
        member val SourceTypeId:Int32 = new Int32() with get,set
        member val SourceTypeDesc:String = null with get,set
        member val SourceNote:String = null with get,set
        member val ContactStatusId:Int32 = new Int32() with get,set
        member val ContactStatusDesc:String = null with get,set
        member val SSN:String = null with get,set
        member val DateOfBirth:DateTime = new DateTime() with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val IsShared:Boolean = new Boolean() with get,set
        member val address_line1:String = null with get,set
        member val address_city:String = null with get,set
        member val address_state:String = null with get,set
        member val address_zip:String = null with get,set
        member val DeletedBy:String = null with get,set
        member val DeletedDateTimeUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val HasNBC:Boolean = new Boolean() with get,set
        member val HasFactFinderSheet:Boolean = new Boolean() with get,set
        member val MiddleInitial:String = null with get,set
        member val Tags:String = null with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val PhoneLabel:String = null with get,set
        member val AltPhoneLabel:String = null with get,set
        member val Carriers:String = null with get,set
        member val ContactImage:String = null with get,set
        member val CompanyAffiliation:String = null with get,set
        member val AdditionalInformation:String = null with get,set
        member val HasGiftCard:Boolean = new Boolean() with get,set
        member val ContactCategory:Int32 = new Int32() with get,set
        member val WritingAgentId:Int32 = new Int32() with get,set
        member val WritingAgentName:String = null with get,set
        member val MaritalStatus:String = null with get,set
        member val TotalDebtAmount:Decimal = new Decimal() with get,set
        member val NumberOfDebtAccounts:Int32 = new Int32() with get,set
        member val FactFinderCodeId:Int32 = new Int32() with get,set
        member val BusinessName:String = null with get,set
        member val DBA:String = null with get,set
        member val ContactGUID:Guid = new Guid() with get,set
        member val ProjectEndDate:DateTime = new DateTime() with get,set
        member val Rate:Int32 = new Int32() with get,set
        member val JobID:Int32 = new Int32() with get,set
        member val JobName:String = null with get,set
        member val JobCount:Int32 = new Int32() with get,set
        member val Locked:Boolean = new Boolean() with get,set
        member val LockedByAgentId:Int32 = new Int32() with get,set
        member val LockedTimestamp:DateTime = new DateTime() with get,set
        member val Initials:String = null with get,set
        member val ContactCategoryName:String = null with get,set
        member val SMSOptIn:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SchedulerTimeslot() = 
        member val Day:DateTime = new DateTime() with get,set
        member val Time:TimeSpan = new TimeSpan() with get,set
        member val Duration:Int32 = new Int32() with get,set
        member val StartDateTime:DateTime = new DateTime() with get,set
        member val EndDateTime:DateTime = new DateTime() with get,set
        member val TimeFriendly:String = null with get,set
        member val Contact:Contact = null with get,set
        member val ServiceIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val Unavailable:Boolean = new Boolean() with get,set
        member val BookedIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val CalendarId:Guid = new Guid() with get,set
        member val SchedulerUrl:String = null with get,set

    [<AllowNullLiteral>]
    type SchedulerDay() = 
        member val Day:DateTime = new DateTime() with get,set
        member val MonthNumber:Int32 = new Int32() with get,set
        member val DayNumber:Int32 = new Int32() with get,set
        member val DayOfWeek:String = null with get,set
        member val Timeslots:ResizeArray<SchedulerTimeslot> = new ResizeArray<SchedulerTimeslot>() with get,set

    [<AllowNullLiteral>]
    type SchedulerWeek() = 
        member val Settings:SchedulerConfiguration = null with get,set
        member val Days:ResizeArray<SchedulerDay> = new ResizeArray<SchedulerDay>() with get,set

    [<AllowNullLiteral>]
    type SchedulerResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Week:SchedulerWeek = null with get,set
        member val Services:ResizeArray<Line> = new ResizeArray<Line>() with get,set

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

GET /v1/Scheduler/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Week: 
	{
		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
						}
					]
				}
			]
		},
		Days: 
		[
			{
				
			}
		]
	},
	Services: 
	[
		{
			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
				}
			]
		}
	]
}