Requires any of the roles: | SystemAdministrator, Manager, Customer |
POST | /customers/{customerId}/test-schedule | ||
---|---|---|---|
POST | /endpoints/{endpointId}/test-schedule |
import Foundation
import ServiceStack
/**
* Test the customer's schedule
*/
// @Api(Description="Test the customer's schedule")
public class TestSchedule : Codable
{
/**
* The ID of the customer whose schedule you want to test
*/
// @ApiMember(Description="The ID of the customer whose schedule you want to test")
public var customerId:String?
/**
* The ID of the endpoint whose schedule you want to test.
*/
// @ApiMember(Description="The ID of the endpoint whose schedule you want to test.")
public var endpointId:String?
/**
* The schedule to use (leave null to use the current saved schedule)
*/
// @ApiMember(Description="The schedule to use (leave null to use the current saved schedule)")
public var schedule:Schedule?
/**
* The ISO string of the date and time you want to test
*/
// @ApiMember(Description="The ISO string of the date and time you want to test")
public var dateTime:String?
required public init(){}
}
public class Schedule : Codable
{
public var timeZoneId:String?
public var inherit:Bool?
public var forceClosed:Bool?
public var rules:[SchedulingRule] = []
public var defaultState:String?
required public init(){}
}
public class SchedulingRule : Codable
{
public var id:String?
public var name:String?
public var priority:Int?
public var state:String?
public var source:String?
public var condition:String?
public var simpleRuleType:SimpleSchedulingRuleTypes?
public var customerState:String?
public var flowId:String?
public var flowParams:Struct?
public var isAllDay:Bool?
public var startDate:String?
public var startTime:String?
public var endTime:String?
public var bySetPosition:[Int] = []
public var byMonth:[Int] = []
public var byWeekNo:[Int] = []
public var byYearDay:[Int] = []
public var byMonthDay:[Int] = []
public var byDay:[ScheduleDay] = []
public var byHour:[Int] = []
public var byMinute:[Int] = []
public var interval:Int?
public var count:Int?
public var untilDate:String?
public var frequency:SchedulingRuleFrequency?
required public init(){}
}
public enum SimpleSchedulingRuleTypes : String, Codable
{
case Always
case CustomerState
case Time
}
public class Struct : List<String:Value>
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
public class Value : Codable
{
public var boolValue:Bool?
public var stringValue:String?
public var numberValue:Double?
public var listValue:[Struct] = []
public var structValue:Struct?
required public init(){}
}
public class ScheduleDay : Codable
{
public var offset:Int?
public var dayOfWeek:DayOfWeek?
required public init(){}
}
public enum SchedulingRuleFrequency : String, Codable
{
case None
case Secondly
case Minutely
case Hourly
case Daily
case Weekly
case Monthly
case Yearly
}
public class TestScheduleResponse : Codable
{
public var stateName:String?
public var timeZoneId:String?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: 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">
<d5p1:KeyValueOfstringValue8Ahp2kgT>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value xmlns:d7p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
<d7p1:BoolValue>false</d7p1:BoolValue>
<d7p1:ListValue>
<d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT>
<d5p1:KeyValueOfstringValue8Ahp2kgT>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>
<d7p1:BoolValue>false</d7p1:BoolValue>
<d7p1:ListValue>
<d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT>
<d5p1:KeyValueOfstringValue8Ahp2kgT>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>
<d7p1:BoolValue>false</d7p1:BoolValue>
<d7p1:ListValue>
<d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
</d7p1:ListValue>
<d7p1:NumberValue>0</d7p1:NumberValue>
<d7p1:StringValue>String</d7p1:StringValue>
<d7p1:StructValue i:nil="true" />
</d5p1:Value>
</d5p1:KeyValueOfstringValue8Ahp2kgT>
</d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT>
</d7p1:ListValue>
<d7p1:NumberValue>0</d7p1:NumberValue>
<d7p1:StringValue>String</d7p1:StringValue>
<d7p1:StructValue>
<d5p1:KeyValueOfstringValue8Ahp2kgT>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>
<d7p1:BoolValue>false</d7p1:BoolValue>
<d7p1:ListValue>
<d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
</d7p1:ListValue>
<d7p1:NumberValue>0</d7p1:NumberValue>
<d7p1:StringValue>String</d7p1:StringValue>
<d7p1:StructValue i:nil="true" />
</d5p1:Value>
</d5p1:KeyValueOfstringValue8Ahp2kgT>
</d7p1:StructValue>
</d5p1:Value>
</d5p1:KeyValueOfstringValue8Ahp2kgT>
</d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT>
</d7p1:ListValue>
<d7p1:NumberValue>0</d7p1:NumberValue>
<d7p1:StringValue>String</d7p1:StringValue>
<d7p1:StructValue>
<d5p1:KeyValueOfstringValue8Ahp2kgT>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>
<d7p1:BoolValue>false</d7p1:BoolValue>
<d7p1:ListValue>
<d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT>
<d5p1:KeyValueOfstringValue8Ahp2kgT>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>
<d7p1:BoolValue>false</d7p1:BoolValue>
<d7p1:ListValue>
<d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
</d7p1:ListValue>
<d7p1:NumberValue>0</d7p1:NumberValue>
<d7p1:StringValue>String</d7p1:StringValue>
<d7p1:StructValue i:nil="true" />
</d5p1:Value>
</d5p1:KeyValueOfstringValue8Ahp2kgT>
</d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT>
</d7p1:ListValue>
<d7p1:NumberValue>0</d7p1:NumberValue>
<d7p1:StringValue>String</d7p1:StringValue>
<d7p1:StructValue>
<d5p1:KeyValueOfstringValue8Ahp2kgT>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>
<d7p1:BoolValue>false</d7p1:BoolValue>
<d7p1:ListValue>
<d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
</d7p1:ListValue>
<d7p1:NumberValue>0</d7p1:NumberValue>
<d7p1:StringValue>String</d7p1:StringValue>
<d7p1:StructValue i:nil="true" />
</d5p1:Value>
</d5p1:KeyValueOfstringValue8Ahp2kgT>
</d7p1:StructValue>
</d5p1:Value>
</d5p1:KeyValueOfstringValue8Ahp2kgT>
</d7p1:StructValue>
</d5p1:Value>
</d5p1:KeyValueOfstringValue8Ahp2kgT>
</d2p1:FlowParams>
<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>