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}

**SchedulerRequest** Parameters:
Name	Parameter	Data Type	Required
SchedulerUrl	path	string	No
StartDate	path	DateTime	No
Session	query	List<string>	No
ServiceIdsList	path	string	No

**SchedulerResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Week	form	SchedulerWeek	No
Services	form	List<Line>	No

**SchedulerWeek** Parameters:
Name	Parameter	Data Type	Required	Description
Settings	form	SchedulerConfiguration	No
Days	form	List<SchedulerDay>	No

**SchedulerConfiguration** Parameters:
Name	Parameter	Data Type	Required
ConfigId	form	int	No
SchedulerUrl	form	string	No
SchedulerName	form	string	No
DefaultLocation	form	string	No
DefaultSummary	form	string	No
DefaultDescription	form	string	No
DayStart	form	TimeSpan	No
DayStartFriendly	form	string	No
DayEnd	form	TimeSpan	No
DayEndFriendly	form	string	No
TimeslotDuration	form	int	No
NumberOfSlots	form	int?	No
LocationId	form	Guid	No
CalendarId	form	Guid	No
AgentId	form	int	No
TimeZone	form	string	No
AvailableDateTimes	form	List<ScheduleConfigDay>	No
AvailableServices	form	List<Guid>	No
AllServices	form	List<Line>	No

**ScheduleConfigDay** Parameters:
Name	Parameter	Data Type	Required
DayName	form	string	No
DayNumber	form	int?	No
DayEnabled	form	bool?	No
TimeBlocks	form	List<ScheduleConfigTimeBlock>	No

**ScheduleConfigTimeBlock** Parameters:
Name	Parameter	Data Type	Required
StartTime	form	TimeSpan	No
DayStartFriendly	form	string	No
EndTime	form	TimeSpan	No
DayEndFriendly	form	string	No

**Line** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
LocationId	form	Guid	No
LocationName	form	string	No
Name	form	string	No
Description	form	string	No
ServiceDurationMinutes	form	int	No
WaitTime	form	int	No
Cost	form	decimal	No
UpperThreshold	form	int?	No
LowerThreshold	form	int?	No
Active	form	bool	No
EntDate	form	DateTime?	No
ModDate	form	DateTime?	No
SendQuestionnaire	form	bool	No
RequireUpload	form	bool	No
UploadMessage	form	string	No
LineImages	form	List<LineImage>	No

**LineImage** Parameters:
Name	Parameter	Data Type	Required
ImageId	form	Guid?	No
FileName	form	string	No
ImageTitle	form	string	No
UploadDate	form	DateTime	No

**SchedulerDay** Parameters:
Name	Parameter	Data Type	Required
Day	form	DateTime	No
MonthNumber	form	int	No
DayNumber	form	int	No
DayOfWeek	form	string	No
Timeslots	form	List<SchedulerTimeslot>	No

**SchedulerTimeslot** Parameters:
Name	Parameter	Data Type	Required
Day	form	DateTime	No
Time	form	TimeSpan	No
Duration	form	int	No
StartDateTime	form	DateTime	No
EndDateTime	form	DateTime	No
TimeFriendly	form	string	No
Contact	form	Contact	No
ServiceIds	form	List<Guid>	No
LocationId	form	Guid	No
Unavailable	form	bool	No
BookedIds	form	List<int>	No
CalendarId	form	Guid	No
SchedulerUrl	form	string	No

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

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