Evo Voice

<back to all web services

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


export class NodeParameterMap
{
    [key:string] : NodeParameter;

    public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}


export enum SimpleSchedulingRuleTypes
{
    Always = 'Always',
    CustomerState = 'CustomerState',
    Time = 'Time',
}

export class Value
{
    public boolValue?: boolean;
    public stringValue?: string;
    public numberValue?: number;
    public listValue?: Struct[];
    public structValue?: Struct;

    public constructor(init?: Partial<Value>) { (Object as any).assign(this, init); }
}

export class Struct
{

    public constructor(init?: Partial<Struct>) { (Object as any).assign(this, init); }
}

export class ScheduleDay
{
    public offset?: number;
    public dayOfWeek?: DayOfWeek;

    public constructor(init?: Partial<ScheduleDay>) { (Object as any).assign(this, init); }
}

export enum SchedulingRuleFrequency
{
    None = 'None',
    Secondly = 'Secondly',
    Minutely = 'Minutely',
    Hourly = 'Hourly',
    Daily = 'Daily',
    Weekly = 'Weekly',
    Monthly = 'Monthly',
    Yearly = 'Yearly',
}

export class SchedulingRule
{
    public id?: string;
    public name?: string;
    public priority?: number;
    public state?: string;
    public source?: string;
    public condition?: string;
    public simpleRuleType?: SimpleSchedulingRuleTypes;
    public customerState?: string;
    public flowId?: string;
    public flowParams?: Struct;
    public isAllDay?: boolean;
    public startDate?: string;
    public startTime?: string;
    public endTime?: string;
    public bySetPosition?: number[];
    public byMonth?: number[];
    public byWeekNo?: number[];
    public byYearDay?: number[];
    public byMonthDay?: number[];
    public byDay?: ScheduleDay[];
    public byHour?: number[];
    public byMinute?: number[];
    public interval?: number;
    public count?: number;
    public untilDate?: string;
    public frequency?: SchedulingRuleFrequency;

    public constructor(init?: Partial<SchedulingRule>) { (Object as any).assign(this, init); }
}

export class Schedule
{
    public timeZoneId?: string;
    public inherit?: boolean;
    public forceClosed?: boolean;
    public rules?: SchedulingRule[];
    public defaultState?: string;

    public constructor(init?: Partial<Schedule>) { (Object as any).assign(this, init); }
}

/**
* Test the customer's schedule
*/
// @Api(Description="Test the customer's schedule")
export class TestSchedule
{
    /**
    * 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 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 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 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 dateTime?: string;

    public constructor(init?: Partial<TestSchedule>) { (Object as any).assign(this, init); }
}

export class TestScheduleResponse
{
    public stateName?: string;
    public timeZoneId?: string;

    public constructor(init?: Partial<TestScheduleResponse>) { (Object as any).assign(this, init); }
}

TypeScript TestSchedule DTOs

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: 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>