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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Schedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Scheduling">
  <DefaultState>String</DefaultState>
  <ForceClosed>false</ForceClosed>
  <Inherit>false</Inherit>
  <Rules>
    <SchedulingRule>
      <ByDay>
        <ScheduleDay>
          <DayOfWeek>Sunday</DayOfWeek>
          <Offset>0</Offset>
        </ScheduleDay>
      </ByDay>
      <ByHour xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </ByHour>
      <ByMinute xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </ByMinute>
      <ByMonth xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </ByMonth>
      <ByMonthDay xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </ByMonthDay>
      <BySetPosition xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </BySetPosition>
      <ByWeekNo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </ByWeekNo>
      <ByYearDay xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </ByYearDay>
      <Condition>String</Condition>
      <Count>0</Count>
      <CustomerState>String</CustomerState>
      <EndTime>String</EndTime>
      <FlowId>String</FlowId>
      <FlowParams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <Frequency>None</Frequency>
      <Id>String</Id>
      <Interval>0</Interval>
      <IsAllDay>false</IsAllDay>
      <Name>String</Name>
      <Priority>0</Priority>
      <SimpleRuleType>Always</SimpleRuleType>
      <Source>String</Source>
      <StartDate>String</StartDate>
      <StartTime>String</StartTime>
      <State>String</State>
      <UntilDate>String</UntilDate>
    </SchedulingRule>
  </Rules>
  <TimeZoneId>String</TimeZoneId>
</Schedule>