Evo Voice

<back to all web services

GetInheritedSchedule

Get the inherited schedule for this customer

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
GET/customers/{customerId}/inherited-schedule
GET/endpoints/{endpointId}/inherited-schedule
GetInheritedSchedule Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathstringNoThe customer ID whose inherited schedule you want to retrieve
EndpointIdpathstringNoThe endpoint ID whose inherited schedule you want to retrieve (use this OR customer id
Schedule Parameters:
NameParameterData TypeRequiredDescription
TimeZoneIdformstringNo
InheritformboolNo
ForceClosedformboolNo
RulesformList<SchedulingRule>No
DefaultStateformstringNo
SchedulingRule Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
PriorityformintNo
StateformstringNo
SourceformstringNo
ConditionformstringNo
SimpleRuleTypeformSimpleSchedulingRuleTypesNo
CustomerStateformstringNo
FlowIdformstringNo
FlowParamsformStructNo
IsAllDayformboolNo
StartDateformstringNo
StartTimeformstringNo
EndTimeformstringNo
BySetPositionformList<int>No
ByMonthformList<int>No
ByWeekNoformList<int>No
ByYearDayformList<int>No
ByMonthDayformList<int>No
ByDayformList<ScheduleDay>No
ByHourformList<int>No
ByMinuteformList<int>No
IntervalformintNo
CountformintNo
UntilDateformstringNo
FrequencyformSchedulingRuleFrequencyNo
SimpleSchedulingRuleTypes Enum:
Always
CustomerState
Time
Value Parameters:
NameParameterData TypeRequiredDescription
BoolValueformbool?No
StringValueformstringNo
NumberValueformdouble?No
ListValueformList<Struct>No
StructValueformStructNo
ScheduleDay Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
DayOfWeekformDayOfWeekNo
SchedulingRuleFrequency Enum:
None
Secondly
Minutely
Hourly
Daily
Weekly
Monthly
Yearly

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 /customers/{customerId}/inherited-schedule HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	timeZoneId: String,
	inherit: False,
	forceClosed: False,
	rules: 
	[
		{
			id: String,
			name: String,
			priority: 0,
			state: String,
			source: String,
			condition: String,
			simpleRuleType: Always,
			customerState: String,
			flowId: String,
			isAllDay: False,
			startDate: String,
			startTime: String,
			endTime: String,
			bySetPosition: 
			[
				0
			],
			byMonth: 
			[
				0
			],
			byWeekNo: 
			[
				0
			],
			byYearDay: 
			[
				0
			],
			byMonthDay: 
			[
				0
			],
			byDay: 
			[
				{
					offset: 0,
					dayOfWeek: Sunday
				}
			],
			byHour: 
			[
				0
			],
			byMinute: 
			[
				0
			],
			interval: 0,
			count: 0,
			untilDate: String,
			frequency: None
		}
	],
	defaultState: String
}