Trendsic Platform Service

<back to all web services

CoverageSelfAvailPutRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/coverage/self/availability
CoverageSelfAvailPutRequest Parameters:
NameParameterData TypeRequiredDescription
DaysbodyList<CoverageSelfAvailDay>No
PrefsbodyWorkerSchedulingPrefsNo
CoverageSelfAvailDay Parameters:
NameParameterData TypeRequiredDescription
DayformstringNo
OpenformboolNo
WindowsformList<CoverageSelfAvailWindow>No
CoverageSelfAvailWindow Parameters:
NameParameterData TypeRequiredDescription
StartformstringNo
EndformstringNo
PreferredformboolNo
WorkerSchedulingPrefs Parameters:
NameParameterData TypeRequiredDescription
ContactIDformintNo
PreferredWeeklyHoursformint?No
PreferredMonthlyHoursformint?No
MinShiftMinutesformint?No
MaxConsecutiveDaysformint?No
CoverageSelfAvailResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
DaysformList<CoverageSelfAvailDay>No
PrefsformWorkerSchedulingPrefsNo
RulesSummaryformstringNo
TimeOffNoticeDaysformintNo

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.

PUT /v1/coverage/self/availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Days: 
	[
		{
			Day: String,
			Open: False,
			Windows: 
			[
				{
					Start: String,
					End: String,
					Preferred: False
				}
			]
		}
	],
	Prefs: 
	{
		ContactID: 0,
		PreferredWeeklyHours: 0,
		PreferredMonthlyHours: 0,
		MinShiftMinutes: 0,
		MaxConsecutiveDays: 0
	}
}
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
		}
	},
	Days: 
	[
		{
			Day: String,
			Open: False,
			Windows: 
			[
				{
					Start: String,
					End: String,
					Preferred: False
				}
			]
		}
	],
	Prefs: 
	{
		ContactID: 0,
		PreferredWeeklyHours: 0,
		PreferredMonthlyHours: 0,
		MinShiftMinutes: 0,
		MaxConsecutiveDays: 0
	},
	RulesSummary: String,
	TimeOffNoticeDays: 0
}