Trendsic Platform Service

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}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class SchedulerRequest
{
    open var SchedulerUrl:String? = null
    open var StartDate:Date? = null
    open var Session:ArrayList<String> = ArrayList<String>()
    open var ServiceIdsList:String? = null
}

open class SchedulerResponse
{
    open var Location:Location? = null
    open var Agent:Agent? = null
    open var ResponseStatus:ResponseStatus? = null
    open var Week:SchedulerWeek? = null
    open var Services:ArrayList<Line> = ArrayList<Line>()
}

open class Location
{
    open var Id:UUID? = null
    open var ClientId:UUID? = null
    open var Name:String? = null
    open var Address1:String? = null
    open var Address2:String? = null
    open var City:String? = null
    open var State:String? = null
    open var Zip:String? = null
    open var Phone:String? = null
    open var Fax:String? = null
    open var URL:String? = null
    open var Email:String? = null
    open var TimeZone:String? = null
    open var Active:Boolean? = null
    open var EntDate:Date? = null
    open var ModDate:Date? = null
    open var LocationImage:String? = null
}

open class Agent
{
    open var AgentId:Int? = null
    open var Company:String? = null
    open var AgentName:String? = null
    open var FirstName:String? = null
    open var LastName:String? = null
    open var MiddleInitial:String? = null
    open var Address1:String? = null
    open var Address2:String? = null
    open var City:String? = null
    open var State:String? = null
    open var Zip:String? = null
    open var Country:String? = null
    open var Email:String? = null
    open var EmailSignature:String? = null
    open var HomePhone:String? = null
    open var CellPhone:String? = null
    open var WorkPhone:String? = null
    open var InsLicensed:Boolean? = null
    open var AgreeToDisclosures:Boolean? = null
    open var AgreeToDate:Date? = null
    open var PaidDate:Date? = null
    open var AgentNumber:String? = null
    open var ReferringAgent:String? = null
    open var PlacementAgent:String? = null
    open var CreatedDate:Date? = null
    open var UserId:UUID? = null
    open var IsAgent:Boolean? = null
    open var Package:String? = null
    open var StoreName:String? = null
    open var Notes:String? = null
    open var Upline1:Int? = null
    open var Upline2:Int? = null
    open var Upline3:Int? = null
    open var Upline4:Int? = null
    open var MVPID:Int? = null
    open var AVPID:Int? = null
    open var RVPID:Int? = null
    open var AgentLevel:BigDecimal? = null
    open var IsMVP:Boolean? = null
    open var IsRVP:Boolean? = null
    open var IsAVP:Boolean? = null
    open var IsAdmin:Boolean? = null
    open var IsBusinessCardAdmin:Boolean? = null
    open var TeamName:String? = null
    open var LocationId:UUID? = null
    open var CalendarId:UUID? = null
    open var Rank:String? = null
    open var NBC:Boolean? = null
    open var Upline1Percent:BigDecimal? = null
    open var Upline2Percent:BigDecimal? = null
    open var Upline3Percent:BigDecimal? = null
    open var Upline4Percent:BigDecimal? = null
    open var AgentStatus:String? = null
    open var Office:String? = null
    open var DOB:Date? = null
    open var SSN:String? = null
    open var Fax:String? = null
    open var BusinessEmail:String? = null
    open var ModifiedDate:Date? = null
    open var ModifiedBy:String? = null
    open var TimeZone:String? = null
    open var LeaderLocked:Boolean? = null
    open var LastSubmittedBusinessDate:Date? = null
    open var GracePeriodDate:Date? = null
    open var Vested:Boolean? = null
    open var DirectPay:Date? = null
    open var DirectPayApprBy:String? = null
    open var FactFinderBilling:BigDecimal? = null
    open var FullName:String? = null
    open var ByLastName:String? = null
    open var IsSecurityLicensed:Boolean? = null
    open var IsEncompassAdmin:Boolean? = null
    open var ApiKey:UUID? = null
    open var LastSessionId:String? = null
    open var LastLogin:Date? = null
    open var MfaActive:Boolean? = null
    open var RequireMFA:Boolean? = null
    open var SMSPhoneNumber:String? = null
    open var VerifiedEmailStatus:Boolean? = null
    open var VerifiedCellPhoneStatus:Boolean? = null
    open var SchedulerUrl:String? = null
    open var QueueDefaults:QueueDefault? = null
    open var Roles:ArrayList<String> = ArrayList<String>()
    open var PasswordUpdated:Boolean? = null
    open var RestrictToSingleSession:Boolean? = null
    open var AgentImage:String? = null
}

open class QueueDefault
{
    open var LocationId:UUID? = null
    open var Services:ArrayList<UUID> = ArrayList<UUID>()
}

open class SchedulerWeek
{
    open var Settings:SchedulerConfiguration? = null
    open var Days:ArrayList<SchedulerDay> = ArrayList<SchedulerDay>()
}

open class SchedulerConfiguration
{
    open var ConfigId:Int? = null
    open var SchedulerUrl:String? = null
    open var SchedulerName:String? = null
    open var DefaultLocation:String? = null
    open var DefaultSummary:String? = null
    open var DefaultDescription:String? = null
    open var DayStart:TimeSpan? = null
    open var DayStartFriendly:String? = null
    open var DayEnd:TimeSpan? = null
    open var DayEndFriendly:String? = null
    open var TimeslotDuration:Int? = null
    open var NumberOfSlots:Int? = null
    open var LocationId:UUID? = null
    open var CalendarId:UUID? = null
    open var AgentId:Int? = null
    open var TimeZone:String? = null
    open var AvailableDateTimes:ArrayList<ScheduleConfigDay> = ArrayList<ScheduleConfigDay>()
    open var AvailableServices:ArrayList<UUID> = ArrayList<UUID>()
    open var AllServices:ArrayList<Line> = ArrayList<Line>()
}

open class ScheduleConfigDay
{
    open var DayName:String? = null
    open var DayNumber:Int? = null
    open var DayEnabled:Boolean? = null
    open var TimeBlocks:ArrayList<ScheduleConfigTimeBlock> = ArrayList<ScheduleConfigTimeBlock>()
}

open class ScheduleConfigTimeBlock
{
    open var StartTime:TimeSpan? = null
    open var DayStartFriendly:String? = null
    open var EndTime:TimeSpan? = null
    open var DayEndFriendly:String? = null
}

open class Line
{
    open var Id:UUID? = null
    open var LocationId:UUID? = null
    open var LocationName:String? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ServiceDurationMinutes:Int? = null
    open var WaitTime:Int? = null
    open var Cost:BigDecimal? = null
    open var UpperThreshold:Int? = null
    open var LowerThreshold:Int? = null
    open var Active:Boolean? = null
    open var EntDate:Date? = null
    open var ModDate:Date? = null
    open var SendQuestionnaire:Boolean? = null
    open var RequireUpload:Boolean? = null
    open var UploadMessage:String? = null
    open var LineImages:ArrayList<LineImage> = ArrayList<LineImage>()
}

open class LineImage
{
    open var ImageId:UUID? = null
    open var LineId:UUID? = null
    open var ImageTitle:String? = null
    open var UploadDate:Date? = null
    open var MimeType:String? = null
    open var FileName:String? = null
}

open class SchedulerDay
{
    open var Day:Date? = null
    open var MonthNumber:Int? = null
    open var DayNumber:Int? = null
    open var DayOfWeek:String? = null
    open var Timeslots:ArrayList<SchedulerTimeslot> = ArrayList<SchedulerTimeslot>()
}

open class SchedulerTimeslot
{
    open var Day:Date? = null
    open var Time:TimeSpan? = null
    open var Duration:Int? = null
    open var StartDateTime:Date? = null
    open var EndDateTime:Date? = null
    open var TimeFriendly:String? = null
    open var Contact:Contact? = null
    open var ServiceIds:ArrayList<UUID> = ArrayList<UUID>()
    open var LocationId:UUID? = null
    open var Unavailable:Boolean? = null
    open var BookedIds:ArrayList<Int> = ArrayList<Int>()
    open var CalendarId:UUID? = null
    open var SchedulerUrl:String? = null
}

open class Contact
{
    open var ContactId:Int? = null
    open var ContactType:Int? = null
    open var FirstName:String? = null
    open var LastName:String? = null
    open var Name:String? = null
    open var Role:String? = null
    open var Title:String? = null
    open var EmailWork:String? = null
    open var EmailPersonal:String? = null
    open var District:String? = null
    open var DistrictID:Int? = null
    open var School:String? = null
    open var SchoolID:Long? = null
    open var State:String? = null
    open var StateName:String? = null
    open var StateID:Long? = null
    open var CountyID:Long? = null
    open var County:String? = null
    open var Phone:String? = null
    open var Department:String? = null
    open var Flow:String? = null
    open var LastContact:Date? = null
    open var DoNotContact:Boolean? = null
    open var Active:Boolean? = null
    open var AgentId:Int? = null
    open var PhoneAlt:String? = null
    open var PeraContactId:Int? = null
    open var RoomNumber:String? = null
    open var SourceTypeId:Int? = null
    open var SourceTypeDesc:String? = null
    open var SourceNote:String? = null
    open var ContactStatusId:Int? = null
    open var ContactStatusDesc:String? = null
    open var SSN:String? = null
    open var DateOfBirth:Date? = null
    open var Deleted:Boolean? = null
    open var IsShared:Boolean? = null
    open var address_line1:String? = null
    open var address_city:String? = null
    open var address_state:String? = null
    open var address_zip:String? = null
    open var DeletedBy:String? = null
    open var DeletedDateTimeUtc:Date? = null
    open var HasNBC:Boolean? = null
    open var HasFactFinderSheet:Boolean? = null
    open var MiddleInitial:String? = null
    open var Tags:String? = null
    open var DateCreated:Date? = null
    open var PhoneLabel:String? = null
    open var AltPhoneLabel:String? = null
    open var Carriers:String? = null
    open var ContactImage:String? = null
    open var CompanyAffiliation:String? = null
    open var AdditionalInformation:String? = null
    open var HasGiftCard:Boolean? = null
    open var ContactCategory:Int? = null
    open var WritingAgentId:Int? = null
    open var WritingAgentName:String? = null
    open var MaritalStatus:String? = null
    open var TotalDebtAmount:BigDecimal? = null
    open var NumberOfDebtAccounts:Int? = null
    open var FactFinderCodeId:Int? = null
    open var BusinessName:String? = null
    open var DBA:String? = null
    open var ContactGUID:UUID? = null
    open var ProjectEndDate:Date? = null
    open var Rate:Int? = null
    open var JobID:Int? = null
    open var JobName:String? = null
    open var JobCount:Int? = null
    open var Locked:Boolean? = null
    open var LockedByAgentId:Int? = null
    open var LockedTimestamp:Date? = null
    open var Initials:String? = null
    open var ContactCategoryName:String? = null
    open var SMSOptIn:Boolean? = null
}

Kotlin 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

{
	Location: 
	{
		Id: 00000000000000000000000000000000,
		ClientId: 00000000000000000000000000000000,
		Name: String,
		Address1: String,
		Address2: String,
		City: String,
		State: String,
		Zip: String,
		Phone: String,
		Fax: String,
		URL: String,
		Email: String,
		TimeZone: String,
		Active: False,
		EntDate: 0001-01-01,
		ModDate: 0001-01-01,
		LocationImage: String
	},
	Agent: 
	{
		AgentId: 0,
		Company: String,
		AgentName: String,
		FirstName: String,
		LastName: String,
		MiddleInitial: String,
		Address1: String,
		Address2: String,
		City: String,
		State: String,
		Zip: String,
		Country: String,
		Email: String,
		EmailSignature: String,
		HomePhone: String,
		CellPhone: String,
		WorkPhone: String,
		InsLicensed: False,
		AgreeToDisclosures: False,
		AgreeToDate: 0001-01-01,
		PaidDate: 0001-01-01,
		AgentNumber: String,
		ReferringAgent: String,
		PlacementAgent: String,
		CreatedDate: 0001-01-01,
		UserId: 00000000000000000000000000000000,
		IsAgent: False,
		Package: String,
		StoreName: String,
		Notes: String,
		Upline1: 0,
		Upline2: 0,
		Upline3: 0,
		Upline4: 0,
		MVPID: 0,
		AVPID: 0,
		RVPID: 0,
		AgentLevel: 0,
		IsMVP: False,
		IsRVP: False,
		IsAVP: False,
		IsAdmin: False,
		IsBusinessCardAdmin: False,
		TeamName: String,
		LocationId: 00000000000000000000000000000000,
		CalendarId: 00000000000000000000000000000000,
		Rank: String,
		NBC: False,
		Upline1Percent: 0,
		Upline2Percent: 0,
		Upline3Percent: 0,
		Upline4Percent: 0,
		AgentStatus: String,
		Office: String,
		DOB: 0001-01-01,
		SSN: String,
		Fax: String,
		BusinessEmail: String,
		ModifiedDate: 0001-01-01,
		ModifiedBy: String,
		TimeZone: String,
		LeaderLocked: False,
		LastSubmittedBusinessDate: 0001-01-01,
		GracePeriodDate: 0001-01-01,
		Vested: False,
		DirectPay: 0001-01-01,
		DirectPayApprBy: String,
		FactFinderBilling: 0,
		FullName: String,
		ByLastName: String,
		IsSecurityLicensed: False,
		IsEncompassAdmin: False,
		ApiKey: 00000000000000000000000000000000,
		LastSessionId: String,
		LastLogin: 0001-01-01,
		MfaActive: False,
		RequireMFA: False,
		SMSPhoneNumber: String,
		VerifiedEmailStatus: False,
		VerifiedCellPhoneStatus: False,
		SchedulerUrl: String,
		QueueDefaults: 
		{
			LocationId: 00000000000000000000000000000000,
			Services: 
			[
				00000000000000000000000000000000
			]
		},
		Roles: 
		[
			String
		],
		PasswordUpdated: False,
		RestrictToSingleSession: False,
		AgentImage: String
	},
	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,
							LineId: 00000000000000000000000000000000,
							ImageTitle: String,
							UploadDate: 0001-01-01,
							MimeType: String,
							FileName: String
						}
					]
				}
			]
		},
		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,
					LineId: 00000000000000000000000000000000,
					ImageTitle: String,
					UploadDate: 0001-01-01,
					MimeType: String,
					FileName: String
				}
			]
		}
	]
}