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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class Agent
    {
        public virtual int AgentId { get; set; }
        public virtual string Company { get; set; }
        public virtual string AgentName { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string MiddleInitial { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string Zip { get; set; }
        public virtual string Country { get; set; }
        public virtual string Email { get; set; }
        public virtual string EmailSignature { get; set; }
        public virtual string HomePhone { get; set; }
        public virtual string CellPhone { get; set; }
        public virtual string WorkPhone { get; set; }
        public virtual bool InsLicensed { get; set; }
        public virtual bool AgreeToDisclosures { get; set; }
        public virtual DateTime? AgreeToDate { get; set; }
        public virtual DateTime? PaidDate { get; set; }
        public virtual string AgentNumber { get; set; }
        public virtual string ReferringAgent { get; set; }
        public virtual string PlacementAgent { get; set; }
        public virtual DateTime? CreatedDate { get; set; }
        public virtual Guid UserId { get; set; }
        public virtual bool IsAgent { get; set; }
        public virtual string Package { get; set; }
        public virtual string StoreName { get; set; }
        public virtual string Notes { get; set; }
        public virtual int? Upline1 { get; set; }
        public virtual int? Upline2 { get; set; }
        public virtual int? Upline3 { get; set; }
        public virtual int? Upline4 { get; set; }
        public virtual int? MVPID { get; set; }
        public virtual int? AVPID { get; set; }
        public virtual int? RVPID { get; set; }
        public virtual decimal? AgentLevel { get; set; }
        public virtual bool IsMVP { get; set; }
        public virtual bool IsRVP { get; set; }
        public virtual bool IsAVP { get; set; }
        public virtual bool IsAdmin { get; set; }
        public virtual bool IsBusinessCardAdmin { get; set; }
        public virtual string TeamName { get; set; }
        public virtual Guid LocationId { get; set; }
        public virtual Guid CalendarId { get; set; }
        public virtual string Rank { get; set; }
        public virtual bool NBC { get; set; }
        public virtual decimal? Upline1Percent { get; set; }
        public virtual decimal? Upline2Percent { get; set; }
        public virtual decimal? Upline3Percent { get; set; }
        public virtual decimal? Upline4Percent { get; set; }
        public virtual string AgentStatus { get; set; }
        public virtual string Office { get; set; }
        public virtual DateTime? DOB { get; set; }
        public virtual string SSN { get; set; }
        public virtual string Fax { get; set; }
        public virtual string BusinessEmail { get; set; }
        public virtual DateTime? ModifiedDate { get; set; }
        public virtual string ModifiedBy { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual bool LeaderLocked { get; set; }
        public virtual DateTime LastSubmittedBusinessDate { get; set; }
        public virtual DateTime GracePeriodDate { get; set; }
        public virtual bool Vested { get; set; }
        public virtual DateTime DirectPay { get; set; }
        public virtual string DirectPayApprBy { get; set; }
        public virtual decimal? FactFinderBilling { get; set; }
        public virtual string FullName { get; set; }
        public virtual string ByLastName { get; set; }
        public virtual bool IsSecurityLicensed { get; set; }
        public virtual bool IsEncompassAdmin { get; set; }
        public virtual Guid ApiKey { get; set; }
        public virtual string LastSessionId { get; set; }
        public virtual DateTime? LastLogin { get; set; }
        public virtual bool MfaActive { get; set; }
        public virtual bool RequireMFA { get; set; }
        public virtual string SMSPhoneNumber { get; set; }
        public virtual bool VerifiedEmailStatus { get; set; }
        public virtual bool VerifiedCellPhoneStatus { get; set; }
        public virtual string SchedulerUrl { get; set; }
        public virtual QueueDefault QueueDefaults { get; set; }
        public virtual List<string> Roles { get; set; } = [];
        public virtual bool PasswordUpdated { get; set; }
        public virtual bool RestrictToSingleSession { get; set; }
        public virtual string AgentImage { get; set; }
    }

    public partial class Contact
    {
        public virtual int ContactId { get; set; }
        public virtual int ContactType { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string Name { get; set; }
        public virtual string Role { get; set; }
        public virtual string Title { get; set; }
        public virtual string EmailWork { get; set; }
        public virtual string EmailPersonal { get; set; }
        public virtual string District { get; set; }
        public virtual int DistrictID { get; set; }
        public virtual string School { get; set; }
        public virtual long SchoolID { get; set; }
        public virtual string State { get; set; }
        public virtual string StateName { get; set; }
        public virtual long StateID { get; set; }
        public virtual long CountyID { get; set; }
        public virtual string County { get; set; }
        public virtual string Phone { get; set; }
        public virtual string Department { get; set; }
        public virtual string Flow { get; set; }
        public virtual DateTime LastContact { get; set; }
        public virtual bool DoNotContact { get; set; }
        public virtual bool Active { get; set; }
        public virtual int AgentId { get; set; }
        public virtual string PhoneAlt { get; set; }
        public virtual int PeraContactId { get; set; }
        public virtual string RoomNumber { get; set; }
        public virtual int SourceTypeId { get; set; }
        public virtual string SourceTypeDesc { get; set; }
        public virtual string SourceNote { get; set; }
        public virtual int ContactStatusId { get; set; }
        public virtual string ContactStatusDesc { get; set; }
        public virtual string SSN { get; set; }
        public virtual DateTime DateOfBirth { get; set; }
        public virtual bool Deleted { get; set; }
        public virtual bool IsShared { get; set; }
        public virtual string address_line1 { get; set; }
        public virtual string address_city { get; set; }
        public virtual string address_state { get; set; }
        public virtual string address_zip { get; set; }
        public virtual string DeletedBy { get; set; }
        public virtual DateTime? DeletedDateTimeUtc { get; set; }
        public virtual bool HasNBC { get; set; }
        public virtual bool HasFactFinderSheet { get; set; }
        public virtual string MiddleInitial { get; set; }
        public virtual string Tags { get; set; }
        public virtual DateTime DateCreated { get; set; }
        public virtual string PhoneLabel { get; set; }
        public virtual string AltPhoneLabel { get; set; }
        public virtual string Carriers { get; set; }
        public virtual string ContactImage { get; set; }
        public virtual string CompanyAffiliation { get; set; }
        public virtual string AdditionalInformation { get; set; }
        public virtual bool HasGiftCard { get; set; }
        public virtual int ContactCategory { get; set; }
        public virtual int WritingAgentId { get; set; }
        public virtual string WritingAgentName { get; set; }
        public virtual string MaritalStatus { get; set; }
        public virtual decimal TotalDebtAmount { get; set; }
        public virtual int NumberOfDebtAccounts { get; set; }
        public virtual int FactFinderCodeId { get; set; }
        public virtual string BusinessName { get; set; }
        public virtual string DBA { get; set; }
        public virtual Guid ContactGUID { get; set; }
        public virtual DateTime ProjectEndDate { get; set; }
        public virtual int Rate { get; set; }
        public virtual int JobID { get; set; }
        public virtual string JobName { get; set; }
        public virtual int JobCount { get; set; }
        public virtual bool Locked { get; set; }
        public virtual int LockedByAgentId { get; set; }
        public virtual DateTime LockedTimestamp { get; set; }
        public virtual string Initials { get; set; }
        public virtual string ContactCategoryName { get; set; }
        public virtual bool SMSOptIn { get; set; }
    }

    public partial class Line
    {
        public virtual Guid Id { get; set; }
        public virtual Guid LocationId { get; set; }
        public virtual string LocationName { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual int ServiceDurationMinutes { get; set; }
        public virtual int WaitTime { get; set; }
        public virtual decimal Cost { get; set; }
        public virtual int? UpperThreshold { get; set; }
        public virtual int? LowerThreshold { get; set; }
        public virtual bool Active { get; set; }
        public virtual DateTime? EntDate { get; set; }
        public virtual DateTime? ModDate { get; set; }
        public virtual bool SendQuestionnaire { get; set; }
        public virtual bool RequireUpload { get; set; }
        public virtual string UploadMessage { get; set; }
        public virtual List<LineImage> LineImages { get; set; } = [];
    }

    public partial class LineImage
    {
        public virtual Guid? ImageId { get; set; }
        public virtual Guid? LineId { get; set; }
        public virtual string ImageTitle { get; set; }
        public virtual DateTime UploadDate { get; set; }
        public virtual string MimeType { get; set; }
        public virtual string FileName { get; set; }
    }

    public partial class Location
    {
        public virtual Guid Id { get; set; }
        public virtual Guid ClientId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string Zip { get; set; }
        public virtual string Phone { get; set; }
        public virtual string Fax { get; set; }
        public virtual string URL { get; set; }
        public virtual string Email { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual bool Active { get; set; }
        public virtual DateTime EntDate { get; set; }
        public virtual DateTime ModDate { get; set; }
        public virtual string LocationImage { get; set; }
    }

    public partial class QueueDefault
    {
        public virtual Guid LocationId { get; set; }
        public virtual List<Guid> Services { get; set; } = [];
    }

    public partial class ScheduleConfigDay
    {
        public virtual string DayName { get; set; }
        public virtual int? DayNumber { get; set; }
        public virtual bool? DayEnabled { get; set; }
        public virtual List<ScheduleConfigTimeBlock> TimeBlocks { get; set; } = [];
    }

    public partial class ScheduleConfigTimeBlock
    {
        public virtual TimeSpan StartTime { get; set; }
        public virtual string DayStartFriendly { get; set; }
        public virtual TimeSpan EndTime { get; set; }
        public virtual string DayEndFriendly { get; set; }
    }

    public partial class SchedulerConfiguration
    {
        public virtual int ConfigId { get; set; }
        public virtual string SchedulerUrl { get; set; }
        public virtual string SchedulerName { get; set; }
        public virtual string DefaultLocation { get; set; }
        public virtual string DefaultSummary { get; set; }
        public virtual string DefaultDescription { get; set; }
        public virtual TimeSpan DayStart { get; set; }
        public virtual string DayStartFriendly { get; set; }
        public virtual TimeSpan DayEnd { get; set; }
        public virtual string DayEndFriendly { get; set; }
        public virtual int TimeslotDuration { get; set; }
        public virtual int? NumberOfSlots { get; set; }
        public virtual Guid LocationId { get; set; }
        public virtual Guid CalendarId { get; set; }
        public virtual int AgentId { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual List<ScheduleConfigDay> AvailableDateTimes { get; set; } = [];
        public virtual List<Guid> AvailableServices { get; set; } = [];
        public virtual List<Line> AllServices { get; set; } = [];
    }

    public partial class SchedulerDay
    {
        public virtual DateTime Day { get; set; }
        public virtual int MonthNumber { get; set; }
        public virtual int DayNumber { get; set; }
        public virtual string DayOfWeek { get; set; }
        public virtual List<SchedulerTimeslot> Timeslots { get; set; } = [];
    }

    public partial class SchedulerRequest
    {
        public virtual string SchedulerUrl { get; set; }
        public virtual DateTime StartDate { get; set; }
        public virtual List<string> Session { get; set; } = [];
        public virtual string ServiceIdsList { get; set; }
    }

    public partial class SchedulerResponse
    {
        public virtual Location Location { get; set; }
        public virtual Agent Agent { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual SchedulerWeek Week { get; set; }
        public virtual List<Line> Services { get; set; } = [];
    }

    public partial class SchedulerTimeslot
    {
        public virtual DateTime Day { get; set; }
        public virtual TimeSpan Time { get; set; }
        public virtual int Duration { get; set; }
        public virtual DateTime StartDateTime { get; set; }
        public virtual DateTime EndDateTime { get; set; }
        public virtual string TimeFriendly { get; set; }
        public virtual Contact Contact { get; set; }
        public virtual List<Guid> ServiceIds { get; set; } = [];
        public virtual Guid LocationId { get; set; }
        public virtual bool Unavailable { get; set; }
        public virtual List<int> BookedIds { get; set; } = [];
        public virtual Guid CalendarId { get; set; }
        public virtual string SchedulerUrl { get; set; }
    }

    public partial class SchedulerWeek
    {
        public virtual SchedulerConfiguration Settings { get; set; }
        public virtual List<SchedulerDay> Days { get; set; } = [];
    }

}

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