Net3 API Interface for Customer Portal

Schedule

Create and update Schedules for Cloud Valet (TM)

The following routes are available for this service:
POST	/schedule
POST	/schedule/{userId}
GET	/schedule/hosts/{scheduleId}

**Schedule** Parameters:
Name	Parameter	Data Type	Required	Description
scheduleId	path	Guid	Yes	The Id of the Schedule
name	body	string	No
description	body	string	No
utcOffset	body	int	No
runDays	body	string	No
startTime	body	TimeSpan	No
stopTime	body	TimeSpan	No
enabled	body	bool	No
snoozed	body	bool	No
runFor	body	int?	No
runUntil	body	DateTime?	No
resume	body	DateTime?	No
snoozeMode	body	string	No

**ScheduleBase** Parameters:
Name	Parameter	Data Type	Required	Description
companyId	form	Guid	No
userId	form	Guid	No

**DTOBase** Parameters:
Name	Parameter	Data Type	Required	Description
sessionId	form	string	No

**ScheduleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	TypeSchedule	No
ResponseStatus	form	ResponseStatus	No

**TypeSchedule** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
CompanyId	form	Guid	No
Name	form	string	No
Description	form	string	No
UTCOffset	form	int	No
RunDays	form	string	No
StartTime	form	TimeSpan	No
StopTime	form	TimeSpan	No
Enabled	form	bool	No
Snoozed	form	bool	No
RunFor	form	int?	No
RunUntil	form	DateTime?	No
Resume	form	DateTime?	No
SnoozeMode	form	string	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.

POST /schedule HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	scheduleId: 00000000000000000000000000000000,
	name: String,
	description: String,
	utcOffset: 0,
	runDays: String,
	startTime: PT0S,
	stopTime: PT0S,
	enabled: False,
	snoozed: False,
	runFor: 0,
	runUntil: 0001-01-01,
	resume: 0001-01-01,
	snoozeMode: String,
	companyId: 00000000000000000000000000000000,
	userId: 00000000000000000000000000000000,
	sessionId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		id: 00000000000000000000000000000000,
		companyId: 00000000000000000000000000000000,
		name: String,
		description: String,
		utcOffset: 0,
		runDays: String,
		startTime: PT0S,
		stopTime: PT0S,
		enabled: False,
		snoozed: False,
		runFor: 0,
		runUntil: 0001-01-01,
		resume: 0001-01-01,
		snoozeMode: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}