Evo Voice

TestSchedule

Test the customer's schedule

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
POST	/customers/{customerId}/test-schedule
POST	/endpoints/{endpointId}/test-schedule

**TestSchedule** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	path	string	No	The ID of the customer whose schedule you want to test
EndpointId	path	string	No	The ID of the endpoint whose schedule you want to test.
Schedule	body	Schedule	No	The schedule to use (leave null to use the current saved schedule)
DateTime	body	string	No	The ISO string of the date and time you want to test

**Schedule** Parameters:
Name	Parameter	Data Type	Required
TimeZoneId	form	string	No
Inherit	form	bool	No
ForceClosed	form	bool	No
Rules	form	List<SchedulingRule>	No
DefaultState	form	string	No

**SchedulingRule** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Priority	form	int	No
State	form	string	No
Source	form	string	No
Condition	form	string	No
SimpleRuleType	form	SimpleSchedulingRuleTypes	No
CustomerState	form	string	No
FlowId	form	string	No
FlowParams	form	Struct	No
IsAllDay	form	bool	No
StartDate	form	string	No
StartTime	form	string	No
EndTime	form	string	No
BySetPosition	form	List<int>	No
ByMonth	form	List<int>	No
ByWeekNo	form	List<int>	No
ByYearDay	form	List<int>	No
ByMonthDay	form	List<int>	No
ByDay	form	List<ScheduleDay>	No
ByHour	form	List<int>	No
ByMinute	form	List<int>	No
Interval	form	int	No
Count	form	int	No
UntilDate	form	string	No
Frequency	form	SchedulingRuleFrequency	No

**SimpleSchedulingRuleTypes** Enum:
Always
CustomerState
Time

**Value** Parameters:
Name	Parameter	Data Type	Required
BoolValue	form	bool?	No
StringValue	form	string	No
NumberValue	form	double?	No
ListValue	form	List<Struct>	No
StructValue	form	Struct	No

**ScheduleDay** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	form	int	No
DayOfWeek	form	DayOfWeek	No

**SchedulingRuleFrequency** Enum:
None
Secondly
Minutely
Hourly
Daily
Weekly
Monthly
Yearly

**TestScheduleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
StateName	form	string	No
TimeZoneId	form	string	No

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.

POST /customers/{customerId}/test-schedule HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TestScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
  <StateName>String</StateName>
  <TimeZoneId>String</TimeZoneId>
</TestScheduleResponse>