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 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 string FileName { get; set; }
        public virtual string ImageTitle { get; set; }
        public virtual DateTime UploadDate { 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 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

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