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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Customers
Imports Voice.Api.Scheduling
Imports Voice.Api.Flows.Data

Namespace Global

    Namespace Voice.Api.Customers

        '''<Summary>
        '''Get the inherited schedule for this customer
        '''</Summary>
        <Api(Description:="Get the inherited schedule for this customer")>
        Public Partial Class GetInheritedSchedule
            '''<Summary>
            '''The customer ID whose inherited schedule you want to retrieve
            '''</Summary>
            <ApiMember(Description:="The customer ID whose inherited schedule you want to retrieve")>
            Public Overridable Property CustomerId As String

            '''<Summary>
            '''The endpoint ID whose inherited schedule you want to retrieve (use this OR customer id
            '''</Summary>
            <ApiMember(Description:="The endpoint ID whose inherited schedule you want to retrieve (use this OR customer id")>
            Public Overridable Property EndpointId As String
        End Class
    End Namespace

    Namespace Voice.Api.Flows.Data

        Public Partial Class Struct
            Inherits Dictionary(Of String, Value)
        End Class

        Public Partial Class Value
            Public Overridable Property BoolValue As Boolean?
            Public Overridable Property StringValue As String
            Public Overridable Property NumberValue As Double?
            Public Overridable Property ListValue As List(Of Struct)
            Public Overridable Property StructValue As Struct
        End Class
    End Namespace

    Namespace Voice.Api.Scheduling

        Public Partial Class Schedule
            Public Overridable Property TimeZoneId As String
            Public Overridable Property Inherit As Boolean
            Public Overridable Property ForceClosed As Boolean
            Public Overridable Property Rules As List(Of SchedulingRule)
            Public Overridable Property DefaultState As String
        End Class

        Public Partial Class ScheduleDay
            Public Overridable Property Offset As Integer
            Public Overridable Property DayOfWeek As DayOfWeek
        End Class

        Public Partial Class SchedulingRule
            Public Overridable Property Id As String
            Public Overridable Property Name As String
            Public Overridable Property Priority As Integer
            Public Overridable Property State As String
            Public Overridable Property Source As String
            Public Overridable Property Condition As String
            Public Overridable Property SimpleRuleType As SimpleSchedulingRuleTypes
            Public Overridable Property CustomerState As String
            Public Overridable Property FlowId As String
            Public Overridable Property FlowParams As Struct
            Public Overridable Property IsAllDay As Boolean
            Public Overridable Property StartDate As String
            Public Overridable Property StartTime As String
            Public Overridable Property EndTime As String
            Public Overridable Property BySetPosition As List(Of Integer)
            Public Overridable Property ByMonth As List(Of Integer)
            Public Overridable Property ByWeekNo As List(Of Integer)
            Public Overridable Property ByYearDay As List(Of Integer)
            Public Overridable Property ByMonthDay As List(Of Integer)
            Public Overridable Property ByDay As List(Of ScheduleDay)
            Public Overridable Property ByHour As List(Of Integer)
            Public Overridable Property ByMinute As List(Of Integer)
            Public Overridable Property Interval As Integer
            Public Overridable Property Count As Integer
            Public Overridable Property UntilDate As String
            Public Overridable Property Frequency As SchedulingRuleFrequency
        End Class

        Public Enum SchedulingRuleFrequency
            None
            Secondly
            Minutely
            Hourly
            Daily
            Weekly
            Monthly
            Yearly
        End Enum

        Public Enum SimpleSchedulingRuleTypes
            Always
            CustomerState
            Time
        End Enum
    End Namespace
End Namespace

VB.NET GetInheritedSchedule DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}